chrome.browserAction

설명

브라우저 작업을 사용하여 기본 Chrome 툴바의 주소 표시줄 오른쪽에 아이콘을 추가합니다. 브라우저 작업에는 아이콘 외에도 도움말, 배지, 팝업이 있습니다.

지원 대상

≤ MV2

다음 그림에서 주소 표시줄 오른쪽에 있는 여러 색상의 정사각형은 브라우저 작업의 아이콘입니다. 아이콘 아래에 팝업이 표시됩니다.

항상 활성화되지는 않는 아이콘을 만들려면 브라우저 작업 대신 페이지 작업을 사용하세요.

매니페스트

다음과 같이 확장 프로그램 매니페스트에 브라우저 작업을 등록합니다.

{
  "name": "My extension",
  ...
  "browser_action": {
    "default_icon": {                // optional
      "16": "images/icon16.png",     // optional
      "24": "images/icon24.png",     // optional
      "32": "images/icon32.png"      // optional
    },
    "default_title": "Google Mail",  // optional, shown in tooltip
    "default_popup": "popup.html"    // optional
  },
  ...
}

Chrome에서 사용할 크기의 아이콘을 제공하면 Chrome에서 가장 가까운 아이콘을 선택하여 16 딥 공간을 채울 수 있는 적절한 크기로 조정합니다. 그러나 정확한 크기가 제공되지 않으면 이 배율로 인해 아이콘이 세부정보가 손실되거나 흐릿하게 보일 수 있습니다.

1.5x 또는 1.2x와 같이 덜 일반적인 배율을 사용하는 기기가 점점 더 보편화되고 있으므로 아이콘에 여러 크기를 제공하는 것이 좋습니다. 이렇게 하면 아이콘 표시 크기가 변경되는 경우 다른 아이콘을 제공하기 위해 더 이상 작업을 할 필요가 없습니다.

기본 아이콘을 등록하는 이전 구문은 계속 지원됩니다.

{
  "name": "My extension",
  ...
  "browser_action": {
    ...
    "default_icon": "images/icon32.png"  // optional
    // equivalent to "default_icon": { "32": "images/icon32.png" }
  },
  ...
}

UI 요소

브라우저 작업에는 아이콘, 도움말, 배지, 팝업이 포함될 수 있습니다.

icon

Chrome의 브라우저 작업 아이콘은 너비와 높이가 16퍼센트 (기기 독립형 픽셀)입니다. 큰 아이콘은 크기에 맞게 크기가 조절되지만 최적의 결과를 얻으려면 16 딥 정사각형 아이콘을 사용하세요.

정적 이미지를 사용하거나 HTML5 캔버스 요소를 사용하는 두 가지 방법으로 아이콘을 설정할 수 있습니다. 간단한 애플리케이션에서는 정적 이미지를 사용하는 것이 더 쉽지만 캔버스 요소를 사용하면 매끄러운 애니메이션과 같은 보다 동적인 UI를 만들 수 있습니다.

정적 이미지는 WebKit에서 표시할 수 있는 모든 형식(BMP, GIF, ICO, JPEG, PNG 등)을 사용할 수 있습니다. 압축해제된 확장 프로그램의 경우 이미지는 PNG 형식이어야 합니다.

아이콘을 설정하려면 매니페스트에서 default_icon의 default_icon 필드를 사용하거나 browserAction.setIcon 메서드를 호출합니다.

화면 픽셀 밀도 (비율 size_in_pixel / size_in_dip)가 1과 다를 때 아이콘을 제대로 표시하기 위해 아이콘을 다양한 크기의 이미지 집합으로 정의할 수 있습니다. 표시할 실제 이미지는 픽셀 크기 16dip에 가장 적합하게 세트에서 선택됩니다. 아이콘 집합에는 모든 크기의 아이콘 사양이 포함될 수 있으며 Chrome은 가장 적절한 아이콘 사양을 선택합니다.

도움말

도움말을 설정하려면 매니페스트에서 default_title의 default_title 필드를 사용하거나 browserAction.setTitle 메서드를 호출합니다. default_title 필드에 언어별 문자열을 지정할 수 있습니다. 자세한 내용은 국제화를 참고하세요.

배지

브라우저 작업에서는 배지(배지)를 표시할 수 있습니다. 배지는 아이콘 위에 겹쳐 표시되는 짧은 텍스트입니다. 배지를 사용하면 브라우저 작업을 쉽게 업데이트하여 확장 프로그램 상태에 관한 약간의 정보를 표시할 수 있습니다.

배지는 공간이 제한되어 있으므로 4자(영문 기준) 이하여야 합니다.

browserAction.setBadgeText 및 browserAction.setBadgeBackgroundColor를 각각 사용하여 배지의 텍스트와 색상을 설정합니다.

브라우저 작업에 팝업이 표시되는 경우 사용자가 확장 프로그램의 아이콘을 클릭하면 팝업이 표시됩니다. 팝업에는 원하는 HTML 콘텐츠가 포함될 수 있으며 콘텐츠에 맞게 크기가 자동으로 조정됩니다. 팝업의 크기는 25x25 이상이어야 하며 800x600보다 클 수 없습니다.

브라우저 작업에 팝업을 추가하려면 팝업 콘텐츠로 HTML 파일을 만듭니다. 매니페스트에 있는 default_popup의 default_popup 필드에 HTML 파일을 지정하거나 browserAction.setPopup 메서드를 호출합니다.

팁

최상의 시각적 효과를 얻으려면 다음 가이드라인을 따르세요.

  • 대부분의 페이지에서 필요한 기능에 브라우저 작업을 사용하세요.
  • 일부 페이지에만 필요한 기능에 브라우저 작업을 사용하지 마세요. 대신 페이지 작업을 사용하세요.
  • 권장: 16x16 크기의 하락 구간을 최대한 활용할 수 있도록 크고 다채로운 아이콘을 사용하세요. 브라우저 작업 아이콘은 페이지 작업 아이콘보다 약간 더 크고 무겁게 보일 것입니다.
  • Chrome의 흑백 메뉴 아이콘을 모방하려고 하지 마세요. 테마에서는 잘 작동하지 않으며 어쨌든 확장 프로그램이 좀 눈에 띄어야 합니다.
  • 알파 투명도를 사용하여 아이콘에 부드러운 가장자리를 추가하세요. 많은 사람이 테마를 사용하므로 아이콘은 다양한 배경 색상에 잘 어울려야 합니다.
  • 아이콘에 지속적으로 애니메이션을 적용하지 마세요. 그건 짜증 나.

예

examples/api/browserAction 디렉터리에서 브라우저 작업 사용의 간단한 예를 확인할 수 있습니다. 다른 예와 소스 코드 보기에 대한 도움말은 샘플을 참조하세요.

유형

ColorArray

유형

[숫자,숫자,숫자,숫자]

ImageDataType

이미지의 픽셀 데이터입니다. ImageData 객체여야 합니다(예: canvas 요소).

유형

ImageData

TabDetails

Chrome 88 이상

속성

  • tabId

    number 선택사항

    상태를 쿼리할 탭의 ID입니다. 탭을 지정하지 않으면 탭이 지정되지 않은 상태가 반환됩니다.

방법

disable()

프로미스 
chrome.browserAction.disable(
  tabId?: number,
  callback?: function,
)

탭에 대한 브라우저 작업을 사용 중지합니다.

매개변수

  • tabId

    number 선택사항

    브라우저 작업을 수정할 탭의 ID입니다.

  • 콜백

    함수 선택사항

    Chrome 67 이상

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

    ()=>void

반환 값

  • Promise<void>

    Chrome 88 이상

    프로미스는 Manifest V3 이상에서만 지원되며 다른 플랫폼에서는 콜백을 사용해야 합니다.

enable()

프로미스 
chrome.browserAction.enable(
  tabId?: number,
  callback?: function,
)

탭에 대해 브라우저 작업을 사용하도록 설정합니다. 기본값은 사용 설정입니다.

매개변수

  • tabId

    number 선택사항

    브라우저 작업을 수정할 탭의 ID입니다.

  • 콜백

    함수 선택사항

    Chrome 67 이상

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

    ()=>void

반환 값

  • Promise<void>

    Chrome 88 이상

    프로미스는 Manifest V3 이상에서만 지원되며 다른 플랫폼에서는 콜백을 사용해야 합니다.

getBadgeBackgroundColor()

프로미스 
chrome.browserAction.getBadgeBackgroundColor(
  details: TabDetails,
  callback?: function,
)

브라우저 작업의 배경 색상을 가져옵니다.

매개변수

반환 값

  • Promise<ColorArray>

    Chrome 88 이상

    프로미스는 Manifest V3 이상에서만 지원되며 다른 플랫폼에서는 콜백을 사용해야 합니다.

getBadgeText()

프로미스 
chrome.browserAction.getBadgeText(
  details: TabDetails,
  callback?: function,
)

브라우저 작업의 배지 텍스트를 가져옵니다. 탭을 지정하지 않으면 탭이 지정되지 않은 배지 텍스트가 반환됩니다.

매개변수

  • 세부정보

    TabDetails

  • 콜백

    함수 선택사항

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

    (result: string)=>void

    • 결과

      string

반환 값

  • 프로미스<string>

    Chrome 88 이상

    프로미스는 Manifest V3 이상에서만 지원되며 다른 플랫폼에서는 콜백을 사용해야 합니다.

getPopup()

프로미스 
chrome.browserAction.getPopup(
  details: TabDetails,
  callback?: function,
)

이 브라우저 작업의 팝업으로 설정된 HTML 문서를 가져옵니다.

매개변수

  • 세부정보

    TabDetails

  • 콜백

    함수 선택사항

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

    (result: string)=>void

    • 결과

      string

반환 값

  • 프로미스<string>

    Chrome 88 이상

    프로미스는 Manifest V3 이상에서만 지원되며 다른 플랫폼에서는 콜백을 사용해야 합니다.

getTitle()

프로미스 
chrome.browserAction.getTitle(
  details: TabDetails,
  callback?: function,
)

브라우저 작업의 제목을 가져옵니다.

매개변수

  • 세부정보

    TabDetails

  • 콜백

    함수 선택사항

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

    (result: string)=>void

    • 결과

      string

반환 값

  • 프로미스<string>

    Chrome 88 이상

    프로미스는 Manifest V3 이상에서만 지원되며 다른 플랫폼에서는 콜백을 사용해야 합니다.

setBadgeBackgroundColor()

프로미스 
chrome.browserAction.setBadgeBackgroundColor(
  details: object,
  callback?: function,
)

배지의 배경 색상을 설정합니다.

매개변수

  • 세부정보

    객체

    • 색상

      문자열|ColorArray

      배지의 RGBA 색상을 구성하는 0~255 범위의 정수 4개로 구성된 배열입니다. CSS 16진수 색상 값이 있는 문자열일 수도 있습니다(예: #FF0000 또는 #F00(빨간색)). 색상을 최대 불투명도로 렌더링합니다.

    • tabId

      number 선택사항

      특정 탭을 선택한 경우로 변경을 제한합니다. 탭을 닫으면 자동으로 재설정됩니다.

  • 콜백

    함수 선택사항

    Chrome 67 이상

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

    ()=>void

반환 값

  • Promise<void>

    Chrome 88 이상

    프로미스는 Manifest V3 이상에서만 지원되며 다른 플랫폼에서는 콜백을 사용해야 합니다.

setBadgeText()

프로미스 
chrome.browserAction.setBadgeText(
  details: object,
  callback?: function,
)

브라우저 작업의 배지 텍스트를 설정합니다. 배지는 아이콘 위에 표시됩니다.

매개변수

  • 세부정보

    객체

    • tabId

      number 선택사항

      특정 탭을 선택한 경우로 변경을 제한합니다. 탭을 닫으면 자동으로 재설정됩니다.

    • text

      문자열 선택사항

      전달할 수 있는 문자의 수에는 제한이 없지만 공백에 들어갈 수 있는 문자는 약 4개입니다. 빈 문자열 ('')이 전달되면 배지 텍스트가 지워집니다. tabId가 지정되고 text이 null이면 지정된 탭의 텍스트가 지워지고 기본적으로 글로벌 배지 텍스트가 설정됩니다.

  • 콜백

    함수 선택사항

    Chrome 67 이상

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

    ()=>void

반환 값

  • Promise<void>

    Chrome 88 이상

    프로미스는 Manifest V3 이상에서만 지원되며 다른 플랫폼에서는 콜백을 사용해야 합니다.

setIcon()

프로미스 
chrome.browserAction.setIcon(
  details: object,
  callback?: function,
)

브라우저 작업의 아이콘을 설정합니다. 아이콘은 이미지 파일의 경로, 캔버스 요소의 픽셀 데이터 또는 이 중 하나의 사전으로 지정할 수 있습니다. path 또는 imageData 속성을 지정해야 합니다.

매개변수

  • 세부정보

    객체

    • imageData

      ImageData|object 선택사항

      설정할 아이콘을 나타내는 ImageData 객체 또는 사전 {size -> ImageData}입니다. 아이콘이 사전으로 지정된 경우 사용되는 이미지는 화면의 픽셀 밀도에 따라 선택됩니다. 하나의 화면 공간 단위에 들어가는 이미지 픽셀의 수가 scale와 같으면 크기가 scale * n인 이미지가 선택됩니다. 여기서 n은 UI에 있는 아이콘의 크기입니다. 이미지를 하나 이상 지정해야 합니다. 'details.imageData = foo'는 'details.imageData = {'16': foo}'와 동일합니다.

    • 경로

      문자열|객체 선택사항

      설정할 아이콘을 가리키는 상대 이미지 경로 또는 사전 {크기 -> 상대 이미지 경로}입니다. 아이콘이 사전으로 지정된 경우 사용되는 이미지는 화면의 픽셀 밀도에 따라 선택됩니다. 하나의 화면 공간 단위에 들어가는 이미지 픽셀의 수가 scale와 같으면 크기가 scale * n인 이미지가 선택됩니다. 여기서 n은 UI에 있는 아이콘의 크기입니다. 이미지를 하나 이상 지정해야 합니다. 'details.path = foo'는 'details.path = {'16': foo}'와 동일합니다.

    • tabId

      number 선택사항

      특정 탭을 선택한 경우로 변경을 제한합니다. 탭을 닫으면 자동으로 재설정됩니다.

  • 콜백

    함수 선택사항

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

    ()=>void

반환 값

  • Promise<void>

    Chrome 116 이상

    프로미스는 Manifest V3 이상에서만 지원되며 다른 플랫폼에서는 콜백을 사용해야 합니다.

setPopup()

프로미스 
chrome.browserAction.setPopup(
  details: object,
  callback?: function,
)

사용자가 브라우저 작업 아이콘을 클릭하면 HTML 문서가 팝업으로 열리도록 설정합니다.

매개변수

  • 세부정보

    객체

    • 팝업

      string

      팝업에 표시할 HTML 파일의 상대 경로입니다. 빈 문자열 ('')로 설정하면 팝업이 표시되지 않습니다.

    • tabId

      number 선택사항

      특정 탭을 선택한 경우로 변경을 제한합니다. 탭을 닫으면 자동으로 재설정됩니다.

  • 콜백

    함수 선택사항

    Chrome 67 이상

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

    ()=>void

반환 값

  • Promise<void>

    Chrome 88 이상

    프로미스는 Manifest V3 이상에서만 지원되며 다른 플랫폼에서는 콜백을 사용해야 합니다.

setTitle()

프로미스 
chrome.browserAction.setTitle(
  details: object,
  callback?: function,
)

브라우저 작업의 제목을 설정합니다. 이 제목은 도움말에 표시됩니다.

매개변수

  • 세부정보

    객체

    • tabId

      number 선택사항

      특정 탭을 선택한 경우로 변경을 제한합니다. 탭을 닫으면 자동으로 재설정됩니다.

    • title

      string

      마우스를 가져갔을 때 브라우저 동작이 표시해야 하는 문자열입니다.

  • 콜백

    함수 선택사항

    Chrome 67 이상

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

    ()=>void

반환 값

  • Promise<void>

    Chrome 88 이상

    프로미스는 Manifest V3 이상에서만 지원되며 다른 플랫폼에서는 콜백을 사용해야 합니다.

이벤트

onClicked

chrome.browserAction.onClicked.addListener(
  callback: function,
)

브라우저 작업 아이콘을 클릭하면 실행됩니다. 브라우저 작업에 팝업이 표시되는 경우 실행되지 않습니다.

매개변수

  • 콜백

    기능

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

    (tab: tabs.Tab)=>void