chrome.omnibox

설명

검색주소창 API를 사용하면 Chrome 주소 표시줄(검색주소창이라고도 함)에 키워드를 등록할 수 있습니다.

'Chromium 검색' 키워드와 관련된 추천을 보여주는 스크린샷

사용자가 확장 프로그램의 키워드를 입력하면 사용자는 확장자가 포함됩니다. 각 키 입력은 확장 프로그램으로 전송되며, 이에 대한 응답으로 추천 항목을 제공할 수 있습니다.

추천은 다양한 방식으로 다채로운 형식을 지정할 수 있습니다. 사용자가 추천을 수락하면 확장 프로그램에 알림이 전송되고 조치를 취할 수 있습니다.

매니페스트

이 API를 사용하려면 매니페스트에서 다음 키를 선언해야 합니다.

"omnibox"

검색주소창 API를 사용하려면 매니페스트에 "omnibox.keyword" 입력란을 포함해야 합니다. 나 은(는) 추천할 때 주소 표시줄에 표시되는 16x16픽셀 아이콘도 지정해야 합니다. 키워드 모드로 전환할 수 있습니다.

예를 들면 다음과 같습니다.

{
  "name": "Aaron's omnibox extension",
  "version": "1.0",
  "omnibox": { "keyword" : "aaron" },
  "icons": {
    "16": "16-full-color.png"
  },
  "background": {
    "persistent": false,
    "scripts": ["background.js"]
  }
}
드림

예

이 API를 사용하려면 chrome-extension-samples에서 omnibox API 예시를 설치하세요. 저장소

유형

DefaultSuggestResult

제안 결과입니다.

속성

  • 설명

    문자열

    URL 드롭다운에 표시되는 텍스트입니다. 스타일 지정을 위한 XML 스타일 마크업을 포함할 수 있습니다. 지원되는 태그는 'url'입니다. (리터럴 URL의 경우), 'match' (사용자 검색어와 일치하는 텍스트 강조 표시) '어둡게' (희미한 도우미 텍스트용) 스타일은 중첩될 수 있습니다. 예를 들어 일치하는 항목이 흐리게 표시됩니다.

DescriptionStyleType

Chrome 44 이상 를 통해 개인정보처리방침을 정의할 수 있습니다.

스타일 유형입니다.

열거형

"URL"

"match"

"어둡게"

OnInputEnteredDisposition

Chrome 44 이상 를 통해 개인정보처리방침을 정의할 수 있습니다.

검색주소창 쿼리의 창 배치입니다. 결과를 표시할 때 권장되는 컨텍스트입니다. 예를 들어 검색주소창 명령이 특정 URL로 이동하는 것이라면 'newForegroundTab'이 적용됩니다. 새로 선택된 탭에서 탐색이 이루어져야 함을 의미합니다.

열거형

'currentTab'

'newForegroundTab'

'newBackgroundTab'

SuggestResult

제안 결과입니다.

속성

  • 콘텐츠

    문자열

    URL 입력란에 입력되고 사용자가 이 항목을 선택하면 확장 프로그램으로 전송되는 텍스트입니다.

  • 삭제 가능

    불리언 선택사항

    Chrome 63 이상 를 통해 개인정보처리방침을 정의할 수 있습니다.

    사용자가 추천 결과를 삭제할 수 있는지 여부입니다.

  • 설명

    문자열

    URL 드롭다운에 표시되는 텍스트입니다. 스타일 지정을 위한 XML 스타일 마크업을 포함할 수 있습니다. 지원되는 태그는 'url'입니다. (리터럴 URL의 경우), 'match' (사용자 검색어와 일치하는 텍스트 강조 표시) '어둡게' (희미한 도우미 텍스트용) 스타일은 중첩될 수 있습니다. 예를 들어 일치하는 항목이 흐리게 표시됩니다. 텍스트로 표시하려면 사전 정의된 항목 5개를 이스케이프 처리해야 합니다(stackoverflow.com/a/1091953/89484).

메서드

setDefaultSuggestion()

<ph type="x-smartling-placeholder"></ph> 프로미스 를 통해 개인정보처리방침을 정의할 수 있습니다.
chrome.omnibox.setDefaultSuggestion(
  suggestion: DefaultSuggestResult,
  callback?: function,
)

기본 추천의 설명과 스타일을 설정합니다. 기본 추천 텍스트는 URL 입력란 아래의 첫 번째 추천 검색어 행에 표시되는 텍스트입니다.

매개변수

  • 'content'가 없는 부분 suggestResult 객체입니다. 매개변수 값으로 사용됩니다.

  • 콜백

    함수 선택사항

    Chrome 100 이상 를 통해 개인정보처리방침을 정의할 수 있습니다.

    callback 매개변수는 다음과 같습니다. 

    () => void

반환 값

  • 프로미스<void>

    Chrome 100 이상 를 통해 개인정보처리방침을 정의할 수 있습니다.

    프로미스는 Manifest V3 이상에서 지원되지만 이전 버전과의 호환성입니다. 같은 함수 호출에서 두 가지를 모두 사용할 수는 없습니다. 이 프로미스는 콜백에 전달된 것과 동일한 유형으로 확인됩니다.

이벤트

onDeleteSuggestion

Chrome 63 이상 를 통해 개인정보처리방침을 정의할 수 있습니다.
chrome.omnibox.onDeleteSuggestion.addListener(
  callback: function,
)

사용자가 추천 결과를 삭제했습니다.

매개변수

  • 콜백

    함수

    callback 매개변수는 다음과 같습니다. 

    (text: string) => void

    • 텍스트

      문자열

onInputCancelled

chrome.omnibox.onInputCancelled.addListener(
  callback: function,
)

사용자가 입력을 수락하지 않고 키워드 입력 세션을 종료했습니다.

매개변수

  • 콜백

    함수

    callback 매개변수는 다음과 같습니다. 

    () => void

onInputChanged

chrome.omnibox.onInputChanged.addListener(
  callback: function,
)

사용자가 검색창에 입력한 내용을 변경했습니다.

매개변수

  • 콜백

    함수

    callback 매개변수는 다음과 같습니다. 

    (text: string, suggest: function) => void

    • 텍스트

      문자열

    • suggest

      함수

      suggest 매개변수는 다음과 같습니다. 

      (suggestResults: SuggestResult[]) => void

onInputEntered

chrome.omnibox.onInputEntered.addListener(
  callback: function,
)

사용자가 검색창에 입력한 내용을 수락했습니다.

매개변수

onInputStarted

chrome.omnibox.onInputStarted.addListener(
  callback: function,
)

사용자가 확장 프로그램의 키워드를 입력하여 키워드 입력 세션을 시작했습니다. 이는 입력 세션당 정확히 한 번, 그리고 모든 onInputChanged 이벤트 전에 전송됩니다.

매개변수

  • 콜백

    함수

    callback 매개변수는 다음과 같습니다. 

    () => void