설명
검색주소창 API를 사용하면 검색주소창이라고도 하는 Google Chrome의 주소 표시줄에 키워드를 등록할 수 있습니다.
사용자가 확장 프로그램의 키워드를 입력하면 확장 프로그램과만 상호작용하기 시작합니다. 각 키 입력이 확장 프로그램으로 전송되며, 이에 대한 응답으로 추천을 제공할 수 있습니다.
추천은 다양한 방식으로 서식을 지정할 수 있습니다. 사용자가 추천을 수락하면 확장 프로그램에 알림이 전송되고 조치를 취할 수 있습니다.
매니페스트
omnibox API를 사용하려면 manifest에 "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' (사용자 검색어와 일치하는 텍스트 강조표시), 'dim' (흐리게 표시된 도우미 텍스트)입니다. 스타일은 중첩될 수 있습니다(예: 흐리게 표시된 일치).
DescriptionStyleType
스타일 유형입니다.
열거형
"url"
"match"
"dim"
OnInputEnteredDisposition
검색주소창 쿼리의 창 배치입니다. 결과를 표시하는 데 권장되는 컨텍스트입니다. 예를 들어 검색주소창 명령어가 특정 URL로 이동하는 경우 'newForegroundTab' 배치는 선택한 새 탭에서 탐색이 이루어져야 함을 의미합니다.
열거형
"currentTab"
"newForegroundTab"
"newBackgroundTab"
SuggestResult
추천 결과입니다.
속성
-
콘텐츠
문자열
사용자가 이 항목을 선택할 때 URL 표시줄에 입력되고 확장 프로그램으로 전송되는 텍스트입니다.
-
deletable
불리언 선택사항
Chrome 63 이상 브라우저.*(Chrome 148부터)사용자가 추천 검색 결과를 삭제할 수 있는지 여부입니다.
-
설명
문자열
URL 드롭다운에 표시되는 텍스트입니다. 스타일 지정을 위한 XML 스타일 마크업을 포함할 수 있습니다. 지원되는 태그는 'url' (리터럴 URL), 'match' (사용자 검색어와 일치하는 텍스트 강조표시), 'dim' (흐리게 표시된 도우미 텍스트)입니다. 스타일은 중첩될 수 있습니다(예: 흐리게 표시된 일치). 사전 정의된 5개의 항목을 텍스트로 표시하려면 이스케이프 처리해야 합니다(stackoverflow.com/a/1091953/89484).
메서드
setDefaultSuggestion()
browser.omnibox.setDefaultSuggestion(
suggestion: DefaultSuggestResult,
): Promise<void>
기본 추천의 설명과 스타일을 설정합니다. 기본 추천은 URL 표시줄 아래의 첫 번째 추천 행에 표시되는 텍스트입니다.
매개변수
-
'content' 매개변수가 없는 부분 SuggestResult 객체입니다.
반환 값
-
약속<void>
Chrome 100 이상 브라우저.*(Chrome 148부터)
이벤트
onDeleteSuggestion
browser.omnibox.onDeleteSuggestion.addListener(
callback: function,
)
사용자가 추천 검색 결과를 삭제했습니다.
매개변수
-
callback
함수
callback매개변수는 다음과 같습니다.(text: string) => void
-
텍스트
문자열
-
onInputCancelled
browser.omnibox.onInputCancelled.addListener(
callback: function,
)
사용자가 입력을 수락하지 않고 키워드 입력 세션을 종료했습니다.
매개변수
-
callback
함수
callback매개변수는 다음과 같습니다.() => void
onInputChanged
browser.omnibox.onInputChanged.addListener(
callback: function,
)
사용자가 검색주소창에 입력한 내용을 변경했습니다.
매개변수
-
callback
함수
callback매개변수는 다음과 같습니다.(text: string, suggest: function) => void
-
텍스트
문자열
-
suggest
함수
suggest매개변수는 다음과 같습니다.(suggestResults: SuggestResult[]) => void
-
suggestResults
추천 결과 배열
-
-
onInputEntered
browser.omnibox.onInputEntered.addListener(
callback: function,
)
사용자가 검색주소창에 입력된 내용을 수락했습니다.
매개변수
-
callback
함수
callback매개변수는 다음과 같습니다.(text: string, disposition: OnInputEnteredDisposition) => void
-
텍스트
문자열
-
disposition
-
onInputStarted
browser.omnibox.onInputStarted.addListener(
callback: function,
)
사용자가 확장 프로그램의 키워드를 입력하여 키워드 입력 세션을 시작했습니다. 이 이벤트는 입력 세션당 정확히 한 번, onInputChanged 이벤트 전에 전송됩니다.
매개변수
-
callback
함수
callback매개변수는 다음과 같습니다.() => void