chrome.action

คำอธิบาย

ใช้ chrome.action API เพื่อควบคุมไอคอนของส่วนขยายในแถบเครื่องมือ Google Chrome

ไอคอนการทำงานจะแสดงในแถบเครื่องมือของเบราว์เซอร์ถัดจากแถบอเนกประสงค์ หลังจากติดตั้งแล้ว ส่วนขยายเหล่านี้จะปรากฏในเมนูส่วนขยาย (ไอคอนชิ้นส่วนปริศนา) ผู้ใช้ปักหมุดไอคอนส่วนขยายไว้ที่แถบเครื่องมือได้

ความพร้อมใช้งาน

Chrome 88 ขึ้นไป MV3 ขึ้นไป

ไฟล์ Manifest

คุณต้องประกาศคีย์ต่อไปนี้ในไฟล์ Manifest เพื่อใช้ API นี้

"action"

หากต้องการใช้ chrome.action API ให้ระบุ "manifest_version" เป็น 3 และใส่คีย์ "action" ไว้ในไฟล์ Manifest

{
  "name": "Action Extension",
  ...
  "action": {
    "default_icon": {              // optional
      "16": "images/icon16.png",   // optional
      "24": "images/icon24.png",   // optional
      "32": "images/icon32.png"    // optional
    },
    "default_title": "Click Me",   // optional, shown in tooltip
    "default_popup": "popup.html"  // optional
  },
  ...
}

คุณระบุคีย์ "action" (พร้อมกับรายการย่อย) หรือไม่ก็ได้ เมื่อไม่ได้รวมไว้ ส่วนขยายของคุณจะยังคงแสดงในแถบเครื่องมือเพื่อให้สามารถเข้าถึงเมนูของส่วนขยาย ด้วยเหตุนี้ เราขอแนะนำให้คุณใส่คีย์ "action" และ "default_icon" เป็นอย่างน้อยเสมอ

แนวคิดและการใช้งาน

ส่วนต่างๆ ของ UI

Icon

ไอคอนนี้เป็นรูปภาพหลักในแถบเครื่องมือของส่วนขยาย และตั้งค่าโดยคีย์ "default_icon" ในคีย์ "action" ของไฟล์ Manifest ไอคอนต้องมีขนาดกว้างและสูง 16 พิกเซลที่ไม่ขึ้นอยู่กับอุปกรณ์ (DIP)

คีย์ "default_icon" คือพจนานุกรมของขนาดกับเส้นทางรูปภาพ Chrome ใช้ไอคอนเหล่านี้เพื่อเลือกขนาดรูปภาพที่จะใช้ หากไม่พบรายการที่ตรงกันทั้งหมด Chrome จะเลือกรายการที่ใกล้เคียงที่สุดที่มีให้และปรับขนาดให้พอดีกับรูปภาพ ซึ่งอาจส่งผลต่อคุณภาพของรูปภาพ

เนื่องจากอุปกรณ์ที่มีปัจจัยขนาดที่ไม่ค่อยเป็นที่นิยม เช่น 1.5 หรือ 1.2 เท่า เริ่มได้รับความนิยมมากขึ้น เราจึงขอแนะนำให้คุณเตรียมขนาดสำหรับไอคอนไว้หลายๆ ขนาด การทำเช่นนี้จะช่วยให้ส่วนขยายของคุณรับมือกับการเปลี่ยนแปลงขนาดการแสดงผลไอคอนที่อาจเกิดขึ้นได้ อย่างไรก็ตาม หากระบุเพียงขนาดเดียว คุณจะตั้งค่าคีย์ "default_icon" เป็นสตริงที่มีเส้นทางไปยังไอคอนเดียวแทนพจนานุกรมได้ด้วย

นอกจากนี้ คุณยังเรียก action.setIcon() เพื่อตั้งค่าไอคอนของส่วนขยายแบบเป็นโปรแกรมได้ โดยระบุเส้นทางรูปภาพอื่นหรือระบุไอคอนที่สร้างขึ้นแบบไดนามิกโดยใช้องค์ประกอบ Canvas ของ HTML หรือหากตั้งค่าจาก Service Worker ของส่วนขยาย ให้ใช้ Offscreen Canvas API

const canvas = new OffscreenCanvas(16, 16);
const context = canvas.getContext('2d');
context.clearRect(0, 0, 16, 16);
context.fillStyle = '#00FF00';  // Green
context.fillRect(0, 0, 16, 16);
const imageData = context.getImageData(0, 0, 16, 16);
chrome.action.setIcon({imageData: imageData}, () => { /* ... */ });

สำหรับส่วนขยายที่แพ็กไว้ (ติดตั้งจากไฟล์ .crx) รูปภาพอาจอยู่ในรูปแบบส่วนใหญ่ที่เครื่องมือแสดงผล Blink แสดงได้ ซึ่งรวมถึง PNG, JPEG, BMP, ICO และอื่นๆ ไม่รองรับ SVG ส่วนขยายที่แตกไฟล์แล้วต้องใช้รูปภาพ PNG

เคล็ดลับเครื่องมือ (ชื่อ)

เคล็ดลับเครื่องมือหรือชื่อจะปรากฏขึ้นเมื่อผู้ใช้วางเคอร์เซอร์เมาส์เหนือไอคอนของส่วนขยายในแถบเครื่องมือ นอกจากนี้ ข้อความดังกล่าวยังรวมอยู่ในข้อความที่เข้าถึงได้ซึ่งโปรแกรมอ่านหน้าจอจะอ่านออกเสียงเมื่อปุ่มได้รับโฟกัส

เคล็ดลับเครื่องมือเริ่มต้นได้รับการตั้งค่าโดยใช้ช่อง "default_title" ของคีย์ "action" ใน manifest.json คุณยังตั้งค่าแบบเป็นโปรแกรมได้โดยโทรหา action.setTitle()

ป้าย

การดำเนินการต่างๆ จะแสดง "ป้าย" ซึ่งเป็นข้อความวางซ้อนบนไอคอนหรือไม่ก็ได้ วิธีนี้ช่วยให้คุณสามารถอัปเดตการดำเนินการเพื่อแสดงข้อมูลเพียงเล็กน้อยเกี่ยวกับสถานะของส่วนขยาย เช่น ตัวนับ โดยป้ายจะมีคอมโพเนนต์ข้อความและสีพื้นหลัง เนื่องจากพื้นที่มีจำกัด เราขอแนะนำให้ใช้ข้อความป้ายไม่เกิน 4 อักขระ

หากต้องการสร้างป้าย ให้ตั้งค่าแบบเป็นโปรแกรมโดยเรียกใช้ action.setBadgeBackgroundColor() และ action.setBadgeText() ไม่มีการตั้งค่าป้ายเริ่มต้นในไฟล์ Manifest ค่าสีป้ายอาจเป็นอาร์เรย์ของจำนวนเต็ม 4 ตัวที่อยู่ระหว่าง 0 ถึง 255 ซึ่งประกอบกันเป็นสี RGBA ของป้าย หรือสตริงที่มีค่าสี CSS

chrome.action.setBadgeBackgroundColor(
  {color: [0, 255, 0, 0]},  // Green
  () => { /* ... */ },
);

chrome.action.setBadgeBackgroundColor(
  {color: '#00FF00'},  // Also green
  () => { /* ... */ },
);

chrome.action.setBadgeBackgroundColor(
  {color: 'green'},  // Also, also green
  () => { /* ... */ },
);

ป๊อปอัปของการดำเนินการจะแสดงเมื่อผู้ใช้คลิกปุ่มการดำเนินการของส่วนขยายในแถบเครื่องมือ ป๊อปอัปอาจมีเนื้อหา HTML ใดก็ได้ที่คุณต้องการ และระบบจะปรับขนาดให้พอดีกับเนื้อหาโดยอัตโนมัติ ป๊อปอัปต้องมีขนาดระหว่าง 25x25 ถึง 800x600 พิกเซล

ในตอนแรก พร็อพเพอร์ตี้ "default_popup" จะตั้งค่าป๊อปอัปไว้ในคีย์ "action" ในไฟล์ manifest.json หากมี พร็อพเพอร์ตี้นี้ควรชี้ไปยังเส้นทางแบบสัมพัทธ์ภายในไดเรกทอรีส่วนขยาย นอกจากนี้ คุณยังอัปเดตแบบไดนามิกเพื่อชี้ไปยังเส้นทางแบบสัมพัทธ์อื่นได้โดยใช้เมธอด action.setPopup()

กรณีการใช้งาน

สถานะต่อแท็บ

การทำงานของส่วนขยายอาจมีสถานะแตกต่างกันในแต่ละแท็บ หากต้องการตั้งค่าสำหรับแท็บแต่ละแท็บ ให้ใช้พร็อพเพอร์ตี้ tabId ในวิธีการตั้งค่าของ action API ตัวอย่างเช่น หากต้องการตั้งค่าข้อความป้ายสำหรับแท็บที่เฉพาะเจาะจง ให้ทำดังนี้

function getTabId() { /* ... */}
function getTabBadge() { /* ... */}

chrome.action.setBadgeText(
  {
    text: getTabBadge(tabId),
    tabId: getTabId(),
  },
  () => { ... }
);

ถ้าไม่มีการตั้งค่าพร็อพเพอร์ตี้ tabId การตั้งค่านี้จะถือว่าเป็นการตั้งค่าส่วนกลาง การตั้งค่าเฉพาะแท็บจะมีลำดับความสำคัญสูงกว่าการตั้งค่าส่วนกลาง

สถานะเปิดใช้

โดยค่าเริ่มต้น ระบบจะเปิดใช้การดำเนินการของแถบเครื่องมือ (คลิกได้) ในแท็บทุกแท็บ คุณควบคุมการดำเนินการนี้ได้โดยใช้เมธอด action.enable() และ action.disable() การดำเนินการนี้จะส่งผลต่อการส่งเหตุการณ์ป๊อปอัป (หากมี) หรือ action.onClicked ไปยังส่วนขยายเท่านั้น โดยจะไม่ส่งผลต่อการแสดงการดำเนินการในแถบเครื่องมือ

ตัวอย่าง

ตัวอย่างต่อไปนี้แสดงวิธีทั่วไปบางอย่างในการใช้การดำเนินการในชิ้นงาน หากต้องการลองใช้ API นี้ ให้ติดตั้งตัวอย่าง Action API จากที่เก็บchrome-extension-samples

แสดงป๊อปอัป

เป็นเรื่องปกติที่ส่วนขยายจะแสดงป๊อปอัปเมื่อผู้ใช้คลิกการดำเนินการของส่วนขยาย หากต้องการติดตั้งวิธีนี้ในส่วนขยายของคุณเอง ให้ประกาศป๊อปอัปใน manifest.json และระบุเนื้อหาที่ Chrome ควรแสดงในป๊อปอัป

// manifest.json
{
  "name": "Action popup demo",
  "version": "1.0",
  "manifest_version": 3,
  "action": {
    "default_title": "Click to view a popup",
    "default_popup": "popup.html"
  }
}

<!-- popup.html -->
<!DOCTYPE html>
<html>
<head>
  <style>
    html {
      min-height: 5em;
      min-width: 10em;
      background: salmon;
    }
  </style>
</head>
<body>
  <p>Hello, world!</p>
</body>
</html>

แทรกสคริปต์เนื้อหาเมื่อมีการคลิก

รูปแบบที่พบบ่อยสำหรับส่วนขยายคือการแสดงฟีเจอร์หลักโดยใช้การดำเนินการของส่วนขยาย ตัวอย่างต่อไปนี้แสดงรูปแบบดังกล่าว เมื่อผู้ใช้คลิกการทำงาน ส่วนขยายจะแทรกสคริปต์เนื้อหาลงในหน้าปัจจุบัน จากนั้นสคริปต์เนื้อหาจะแสดงการแจ้งเตือนเพื่อยืนยันว่าทุกอย่างทํางานตามที่คาดไว้

// manifest.json
{
  "name": "Action script injection demo",
  "version": "1.0",
  "manifest_version": 3,
  "action": {
    "default_title": "Click to show an alert"
  },
  "permissions": ["activeTab", "scripting"],
  "background": {
    "service_worker": "background.js"
  }
}

// background.js
chrome.action.onClicked.addListener((tab) => {
  chrome.scripting.executeScript({
    target: {tabId: tab.id},
    files: ['content.js']
  });
});

// content.js
alert('Hello, world!');

จำลองการดำเนินการด้วย declarativeContent

ตัวอย่างนี้แสดงวิธีที่ตรรกะเบื้องหลังของส่วนขยายสามารถ (ก) ปิดใช้การดําเนินการโดยค่าเริ่มต้น และ (ข) ใช้ declarativeContent เพื่อเปิดใช้การดําเนินการในบางเว็บไซต์

// service-worker.js

// Wrap in an onInstalled callback to avoid unnecessary work
// every time the service worker is run
chrome.runtime.onInstalled.addListener(() => {
  // Page actions are disabled by default and enabled on select tabs
  chrome.action.disable();

  // Clear all rules to ensure only our expected rules are set
  chrome.declarativeContent.onPageChanged.removeRules(undefined, () => {
    // Declare a rule to enable the action on example.com pages
    let exampleRule = {
      conditions: [
        new chrome.declarativeContent.PageStateMatcher({
          pageUrl: {hostSuffix: '.example.com'},
        })
      ],
      actions: [new chrome.declarativeContent.ShowAction()],
    };

    // Finally, apply our new array of rules
    let rules = [exampleRule];
    chrome.declarativeContent.onPageChanged.addRules(rules);
  });
});

ประเภท

OpenPopupOptions

Chrome 99 ขึ้นไป

พร็อพเพอร์ตี้

  • windowId

    หมายเลข ไม่บังคับ

    รหัสของหน้าต่างที่เปิดป๊อปอัปการดำเนินการ ค่าเริ่มต้นจะเป็นหน้าต่างที่ใช้งานอยู่ในปัจจุบัน หากไม่ได้ระบุ

TabDetails

พร็อพเพอร์ตี้

  • tabId

    ตัวเลข ไม่บังคับ

    รหัสของแท็บที่ต้องการค้นหาสถานะ หากไม่ได้ระบุแท็บ ระบบจะแสดงผลสถานะไม่เจาะจงแท็บ

UserSettings

Chrome 91 ขึ้นไป

ชุดการตั้งค่าที่ผู้ใช้ระบุซึ่งเกี่ยวข้องกับการทำงานของส่วนขยาย

พร็อพเพอร์ตี้

  • isOnToolbar

    บูลีน

    ไอคอนการทำงานของส่วนขยายแสดงอยู่ในแถบเครื่องมือระดับบนสุดของหน้าต่างเบราว์เซอร์หรือไม่ (กล่าวคือ ผู้ใช้ 'ปักหมุด' ส่วนขยายไว้หรือไม่)

UserSettingsChange

Chrome 130 ขึ้นไป

พร็อพเพอร์ตี้

  • isOnToolbar

    บูลีน ไม่บังคับ

    ไอคอนการดำเนินการของส่วนขยายจะปรากฏในแถบเครื่องมือระดับบนสุดของหน้าต่างเบราว์เซอร์หรือไม่ (กล่าวคือ ผู้ใช้ได้ "ปักหมุด" ส่วนขยายไว้หรือไม่)

เมธอด

disable()

สัญญา 
chrome.action.disable(
  tabId?: number,
  callback?: function,
)

ปิดใช้การดำเนินการของแท็บ

พารามิเตอร์

  • tabId

    ตัวเลข ไม่บังคับ

    รหัสของแท็บที่ต้องการแก้ไขการดําเนินการ

  • Callback

    ไม่บังคับ

    พารามิเตอร์ callback มีลักษณะดังนี้ 

    () => void

การคืนสินค้า

  • Promise<void>

    ไฟล์ Manifest เวอร์ชัน 3 ขึ้นไปรองรับ Promise แต่มี Callback ไว้เพื่อให้ใช้กับเวอร์ชันก่อนหน้าได้ คุณใช้ทั้ง 2 รูปแบบในการเรียกใช้ฟังก์ชันเดียวกันไม่ได้ พรอมต์จะได้รับการแก้ไขด้วยประเภทเดียวกันกับที่ส่งไปยังการเรียกกลับ

enable()

สัญญา 
chrome.action.enable(
  tabId?: number,
  callback?: function,
)

เปิดใช้การดำเนินการสำหรับแท็บ การดำเนินการจะเปิดไว้โดยค่าเริ่มต้น

พารามิเตอร์

  • tabId

    ตัวเลข ไม่บังคับ

    รหัสของแท็บที่ต้องการแก้ไขการดําเนินการ

  • Callback

    ไม่บังคับ

    พารามิเตอร์ callback มีลักษณะดังนี้ 

    () => void

การคืนสินค้า

  • Promise<void>

    ไฟล์ Manifest เวอร์ชัน 3 ขึ้นไปรองรับ Promise แต่มี Callback ไว้เพื่อให้ใช้กับเวอร์ชันก่อนหน้าได้ คุณใช้ทั้ง 2 รูปแบบในการเรียกใช้ฟังก์ชันเดียวกันไม่ได้ พรอมต์จะได้รับการแก้ไขด้วยประเภทเดียวกันกับที่ส่งไปยังการเรียกกลับ

getBadgeBackgroundColor()

สัญญา 
chrome.action.getBadgeBackgroundColor(
  details: TabDetails,
  callback?: function,
)

รับสีพื้นหลังของการดำเนินการ

พารามิเตอร์

  • รายละเอียด

    TabDetails

  • Callback

    ไม่บังคับ

    พารามิเตอร์ callback จะมีลักษณะดังนี้ 

    (result: ColorArray) => void

การคืนสินค้า

  • ไฟล์ Manifest เวอร์ชัน 3 ขึ้นไปรองรับ Promise แต่มี Callback ไว้เพื่อให้ใช้กับเวอร์ชันก่อนหน้าได้ คุณใช้ทั้ง 2 รูปแบบในการเรียกใช้ฟังก์ชันเดียวกันไม่ได้ พรอมต์จะได้รับการแก้ไขด้วยประเภทเดียวกันกับที่ส่งไปยังการเรียกกลับ

getBadgeText()

สัญญา 
chrome.action.getBadgeText(
  details: TabDetails,
  callback?: function,
)

รับข้อความป้ายของการดําเนินการ หากไม่ได้ระบุแท็บ ระบบจะแสดงผลข้อความป้ายที่ไม่เจาะจงแท็บ หากเปิดใช้ displayActionCountAsBadgeText ระบบจะแสดงผลข้อความตัวยึดตำแหน่งเว้นแต่จะมีสิทธิ์ declarativeNetRequestFeedback หรือมีข้อความป้ายเฉพาะแท็บ

พารามิเตอร์

  • รายละเอียด

    TabDetails

  • Callback

    ไม่บังคับ

    พารามิเตอร์ callback จะมีลักษณะดังนี้ 

    (result: string) => void

    • ผลลัพธ์

      สตริง

การคืนสินค้า

  • Promise&lt;string&gt;

    ไฟล์ Manifest เวอร์ชัน 3 ขึ้นไปรองรับ Promise แต่มี Callback ไว้เพื่อให้ใช้กับเวอร์ชันก่อนหน้าได้ คุณใช้ทั้ง 2 รูปแบบในการเรียกใช้ฟังก์ชันเดียวกันไม่ได้ พรอมต์จะได้รับการแก้ไขด้วยประเภทเดียวกันกับที่ส่งไปยังการเรียกกลับ

getBadgeTextColor()

Promise Chrome 110 ขึ้นไป 
chrome.action.getBadgeTextColor(
  details: TabDetails,
  callback?: function,
)

รับสีข้อความของการดำเนินการ

พารามิเตอร์

  • รายละเอียด

    TabDetails

  • Callback

    ไม่บังคับ

    พารามิเตอร์ callback จะมีลักษณะดังนี้ 

    (result: ColorArray) => void

การคืนสินค้า

  • Promise&lt;browserAction.ColorArray&gt;

    ไฟล์ Manifest เวอร์ชัน 3 ขึ้นไปรองรับ Promise แต่มี Callback ไว้เพื่อให้ใช้กับเวอร์ชันก่อนหน้าได้ คุณใช้ทั้ง 2 รูปแบบในการเรียกใช้ฟังก์ชันเดียวกันไม่ได้ พรอมต์จะได้รับการแก้ไขด้วยประเภทเดียวกันกับที่ส่งไปยังการเรียกกลับ

getPopup()

สัญญา 
chrome.action.getPopup(
  details: TabDetails,
  callback?: function,
)

รับเอกสาร HTML ที่ตั้งค่าเป็นป๊อปอัปสำหรับการดำเนินการนี้

พารามิเตอร์

  • รายละเอียด

    TabDetails

  • Callback

    ไม่บังคับ

    พารามิเตอร์ callback จะมีลักษณะดังนี้ 

    (result: string) => void

    • ผลลัพธ์

      สตริง

การคืนสินค้า

  • Promise&lt;string&gt;

    ไฟล์ Manifest เวอร์ชัน 3 ขึ้นไปรองรับ Promise แต่มี Callback ไว้เพื่อให้ใช้กับเวอร์ชันก่อนหน้าได้ คุณใช้ทั้ง 2 รูปแบบในการเรียกใช้ฟังก์ชันเดียวกันไม่ได้ พรอมต์จะได้รับการแก้ไขด้วยประเภทเดียวกันกับที่ส่งไปยังการเรียกกลับ

getTitle()

สัญญา 
chrome.action.getTitle(
  details: TabDetails,
  callback?: function,
)

รับชื่อการดำเนินการ

พารามิเตอร์

  • รายละเอียด

    TabDetails

  • Callback

    ไม่บังคับ

    พารามิเตอร์ callback จะมีลักษณะดังนี้ 

    (result: string) => void

    • ผลลัพธ์

      สตริง

การคืนสินค้า

  • Promise&lt;string&gt;

    ไฟล์ Manifest เวอร์ชัน 3 ขึ้นไปรองรับ Promise แต่มี Callback ไว้เพื่อให้ใช้กับเวอร์ชันก่อนหน้าได้ คุณใช้ทั้ง 2 รูปแบบในการเรียกใช้ฟังก์ชันเดียวกันไม่ได้ พรอมต์จะได้รับการแก้ไขด้วยประเภทเดียวกันกับที่ส่งไปยังการเรียกกลับ

getUserSettings()

Promise Chrome 91 ขึ้นไป 
chrome.action.getUserSettings(
  callback?: function,
)

แสดงการตั้งค่าที่ผู้ใช้ระบุซึ่งเกี่ยวข้องกับการดำเนินการของส่วนขยาย

พารามิเตอร์

  • Callback

    ไม่บังคับ

    พารามิเตอร์ callback มีลักษณะดังนี้ 

    (userSettings: UserSettings) => void

การคืนสินค้า

  • Promise&lt;UserSettings&gt;

    ไฟล์ Manifest เวอร์ชัน 3 ขึ้นไปรองรับ Promise แต่มี Callback ไว้เพื่อให้ใช้กับเวอร์ชันก่อนหน้าได้ คุณใช้ทั้ง 2 รูปแบบในการเรียกใช้ฟังก์ชันเดียวกันไม่ได้ พรอมต์จะได้รับการแก้ไขด้วยประเภทเดียวกันกับที่ส่งไปยังการเรียกกลับ

isEnabled()

สัญญา Chrome 110 ขึ้นไป 
chrome.action.isEnabled(
  tabId?: number,
  callback?: function,
)

ระบุว่ามีการเปิดใช้การดำเนินการของส่วนขยายสำหรับแท็บ (หรือทั่วโลกหากไม่ได้ระบุ tabId) การดำเนินการที่เปิดใช้โดยใช้เพียง declarativeContent จะแสดงค่า "เท็จ" เสมอ

พารามิเตอร์

  • tabId

    หมายเลข ไม่บังคับ

    รหัสของแท็บที่คุณต้องการตรวจสอบสถานะเปิดใช้

  • Callback

    ไม่บังคับ

    พารามิเตอร์ callback มีลักษณะดังนี้ 

    (isEnabled: boolean) => void

    • isEnabled

      บูลีน

      เป็นจริงหากเปิดใช้การดำเนินการของส่วนขยาย

การคืนสินค้า

  • Promise&lt;boolean&gt;

    ไฟล์ Manifest เวอร์ชัน 3 ขึ้นไปรองรับ Promise แต่มี Callback ไว้เพื่อให้ใช้กับเวอร์ชันก่อนหน้าได้ คุณใช้ทั้ง 2 รูปแบบในการเรียกใช้ฟังก์ชันเดียวกันไม่ได้ พรอมต์จะได้รับการแก้ไขด้วยประเภทเดียวกันกับที่ส่งไปยังการเรียกกลับ

openPopup()

Promise Chrome 127 ขึ้นไป 
chrome.action.openPopup(
  options?: OpenPopupOptions,
  callback?: function,
)

เปิดป๊อปอัปของส่วนขยาย ระหว่าง Chrome 118 ถึง Chrome 126 ตัวเลือกนี้จะใช้ได้กับส่วนขยายที่ติดตั้งตามนโยบายเท่านั้น

พารามิเตอร์

  • ตัวเลือก

    OpenPopupOptions ไม่บังคับ

    ระบุตัวเลือกสําหรับการเปิดป๊อปอัป

  • Callback

    ไม่บังคับ

    พารามิเตอร์ callback มีลักษณะดังนี้ 

    () => void

การคืนสินค้า

  • Promise<void>

    ไฟล์ Manifest เวอร์ชัน 3 ขึ้นไปรองรับ Promise แต่มี Callback ไว้เพื่อให้ใช้กับเวอร์ชันก่อนหน้าได้ คุณใช้ทั้ง 2 รูปแบบในการเรียกใช้ฟังก์ชันเดียวกันไม่ได้ พรอมต์จะได้รับการแก้ไขด้วยประเภทเดียวกันกับที่ส่งไปยังการเรียกกลับ

setBadgeBackgroundColor()

สัญญา 
chrome.action.setBadgeBackgroundColor(
  details: object,
  callback?: function,
)

กำหนดสีพื้นหลังให้กับป้าย

พารามิเตอร์

  • รายละเอียด

    ออบเจ็กต์

    • สี

      สตริง | ColorArray

      อาร์เรย์จำนวนเต็ม 4 รายการในช่วง [0,255] ที่ใช้ประกอบสี RGBA ของป้าย เช่น สีแดงทึบคือ [255, 0, 0, 255] และอาจเป็นสตริงที่มีค่า CSS ก็ได้ โดยสีแดงทึบแสงคือ #FF0000 หรือ #F00

    • tabId

      หมายเลข ไม่บังคับ

      จำกัดการเปลี่ยนแปลงไว้เฉพาะเมื่อเลือกแท็บหนึ่งๆ รีเซ็ตโดยอัตโนมัติเมื่อปิดแท็บ

  • Callback

    ไม่บังคับ

    พารามิเตอร์ callback มีลักษณะดังนี้ 

    () => void

การคืนสินค้า

  • Promise<void>

    ไฟล์ Manifest เวอร์ชัน 3 ขึ้นไปรองรับ Promise แต่มี Callback ไว้เพื่อให้ใช้กับเวอร์ชันก่อนหน้าได้ คุณใช้ทั้ง 2 รูปแบบในการเรียกใช้ฟังก์ชันเดียวกันไม่ได้ พรอมต์จะได้รับการแก้ไขด้วยประเภทเดียวกันกับที่ส่งไปยังการเรียกกลับ

setBadgeText()

สัญญา 
chrome.action.setBadgeText(
  details: object,
  callback?: function,
)

ตั้งค่าข้อความป้ายสำหรับการดำเนินการ ป้ายจะแสดงที่ด้านบนของไอคอน

พารามิเตอร์

  • รายละเอียด

    ออบเจ็กต์

    • tabId

      หมายเลข ไม่บังคับ

      จำกัดการเปลี่ยนแปลงไว้เฉพาะเมื่อเลือกแท็บหนึ่งๆ รีเซ็ตโดยอัตโนมัติเมื่อปิดแท็บ

    • ข้อความ

      string ไม่บังคับ

      คุณส่งอักขระกี่ตัวก็ได้ แต่พื้นที่ทำงานจะรองรับได้เพียงประมาณ 4 ตัว หากมีการส่งสตริงว่าง ('') ระบบจะล้างข้อความป้าย หากระบุ tabId และ text เป็นค่าว่าง ระบบจะล้างข้อความสำหรับแท็บที่ระบุและตั้งค่าเริ่มต้นเป็นข้อความป้ายทั่วโลก

  • Callback

    ไม่บังคับ

    พารามิเตอร์ callback มีลักษณะดังนี้ 

    () => void

การคืนสินค้า

  • Promise<void>

    ไฟล์ Manifest เวอร์ชัน 3 ขึ้นไปรองรับ Promise แต่มี Callback ไว้เพื่อให้ใช้กับเวอร์ชันก่อนหน้าได้ คุณใช้ทั้ง 2 รูปแบบในการเรียกใช้ฟังก์ชันเดียวกันไม่ได้ พรอมต์จะได้รับการแก้ไขด้วยประเภทเดียวกันกับที่ส่งไปยังการเรียกกลับ

setBadgeTextColor()

Promise Chrome 110 ขึ้นไป 
chrome.action.setBadgeTextColor(
  details: object,
  callback?: function,
)

กำหนดสีข้อความสำหรับป้าย

พารามิเตอร์

  • รายละเอียด

    ออบเจ็กต์

    • สี

      สตริง | ColorArray

      อาร์เรย์จำนวนเต็ม 4 รายการในช่วง [0,255] ที่ใช้ประกอบสี RGBA ของป้าย เช่น สีแดงทึบคือ [255, 0, 0, 255] หรืออาจเป็นสตริงที่มีค่า CSS โดยสีแดงทึบคือ #FF0000 หรือ #F00 การไม่ตั้งค่านี้จะทําให้ระบบเลือกสีโดยอัตโนมัติซึ่งจะตัดกับสีพื้นหลังของป้ายเพื่อให้มองเห็นข้อความได้ ระบบจะไม่ตั้งค่าสีที่มีค่าอัลฟาเท่ากับ 0 และจะแสดงข้อผิดพลาด

    • tabId

      หมายเลข ไม่บังคับ

      จำกัดการเปลี่ยนแปลงไว้เฉพาะเมื่อเลือกแท็บหนึ่งๆ รีเซ็ตโดยอัตโนมัติเมื่อปิดแท็บ

  • Callback

    ไม่บังคับ

    พารามิเตอร์ callback มีลักษณะดังนี้ 

    () => void

การคืนสินค้า

  • Promise<void>

    ไฟล์ Manifest เวอร์ชัน 3 ขึ้นไปรองรับ Promise แต่มี Callback ไว้เพื่อให้ใช้กับเวอร์ชันก่อนหน้าได้ คุณใช้ทั้ง 2 รูปแบบในการเรียกใช้ฟังก์ชันเดียวกันไม่ได้ พรอมต์จะได้รับการแก้ไขด้วยประเภทเดียวกันกับที่ส่งไปยังการเรียกกลับ

setIcon()

สัญญา 
chrome.action.setIcon(
  details: object,
  callback?: function,
)

ตั้งค่าไอคอนสำหรับการดำเนินการ ไอคอนดังกล่าวอาจระบุเป็นเส้นทางไปยังไฟล์ภาพหรือเป็นข้อมูลพิกเซลจากองค์ประกอบ Canvas หรือเป็นพจนานุกรมของไอคอนอย่างใดอย่างหนึ่งก็ได้ ต้องระบุพร็อพเพอร์ตี้ path หรือ imageData

พารามิเตอร์

  • รายละเอียด

    ออบเจ็กต์

    • imageData

      ImageData | ออบเจ็กต์ ไม่บังคับ

      ออบเจ็กต์ ImageData หรือพจนานุกรม {size -> ImageData} ซึ่งแสดงไอคอนที่จะตั้งค่า หากระบุไอคอนเป็นพจนานุกรม ระบบจะเลือกรูปภาพจริงที่จะใช้โดยขึ้นอยู่กับความหนาแน่นของพิกเซลของหน้าจอ หากจำนวนพิกเซลรูปภาพที่พอดีกับหน่วยพื้นที่หน้าจอ 1 หน่วยเท่ากับ scale ระบบจะเลือกรูปภาพขนาด scale * n โดยที่ n คือขนาดของไอคอนใน UI ต้องระบุรูปภาพอย่างน้อย 1 รูป โปรดทราบว่า 'details.imageData = foo' จะเหมือนกับ 'details.imageData = {'16': foo}'

    • เส้นทาง

      string | object ไม่บังคับ

      เส้นทางรูปภาพแบบสัมพัทธ์หรือพจนานุกรม {size -> relative image path} ที่ชี้ไปยังไอคอนที่จะตั้งค่า หากระบุไอคอนเป็นพจนานุกรม ระบบจะเลือกรูปภาพจริงที่จะใช้โดยขึ้นอยู่กับความหนาแน่นของพิกเซลของหน้าจอ หากจำนวนพิกเซลรูปภาพที่มีขนาดพอดีกับหนึ่งหน่วยพื้นที่หน้าจอเท่ากับ scale ระบบจะเลือกรูปภาพที่มีขนาด scale * n โดย n คือขนาดของไอคอนใน UI ต้องระบุรูปภาพอย่างน้อยหนึ่งภาพ โปรดทราบว่า 'details.path = foo' เทียบเท่ากับ 'details.path = {'16': foo}'

    • tabId

      หมายเลข ไม่บังคับ

      จำกัดการเปลี่ยนแปลงไว้เฉพาะเมื่อเลือกแท็บหนึ่งๆ รีเซ็ตโดยอัตโนมัติเมื่อปิดแท็บ

  • Callback

    ไม่บังคับ

    พารามิเตอร์ callback มีลักษณะดังนี้ 

    () => void

การคืนสินค้า

  • Promise<void>

    Chrome 96 ขึ้นไป

    ไฟล์ Manifest เวอร์ชัน 3 ขึ้นไปรองรับ Promise แต่มี Callback ไว้เพื่อให้ใช้กับเวอร์ชันก่อนหน้าได้ คุณใช้ทั้ง 2 รูปแบบในการเรียกใช้ฟังก์ชันเดียวกันไม่ได้ พรอมต์จะได้รับการแก้ไขด้วยประเภทเดียวกันกับที่ส่งไปยังการเรียกกลับ

setPopup()

สัญญา 
chrome.action.setPopup(
  details: object,
  callback?: function,
)

ตั้งค่าให้เอกสาร HTML เปิดเป็นป๊อปอัปเมื่อผู้ใช้คลิกไอคอนของการดำเนินการ

พารามิเตอร์

  • รายละเอียด

    ออบเจ็กต์

    • ป๊อปอัป

      สตริง

      เส้นทางสัมพัทธ์ไปยังไฟล์ HTML ที่จะแสดงในป๊อปอัป หากตั้งค่าเป็นสตริงว่าง ('') ระบบจะไม่แสดงป๊อปอัป

    • tabId

      หมายเลข ไม่บังคับ

      จำกัดการเปลี่ยนแปลงไว้เฉพาะเมื่อเลือกแท็บหนึ่งๆ รีเซ็ตโดยอัตโนมัติเมื่อปิดแท็บ

  • Callback

    ไม่บังคับ

    พารามิเตอร์ callback มีลักษณะดังนี้ 

    () => void

การคืนสินค้า

  • Promise<void>

    ไฟล์ Manifest เวอร์ชัน 3 ขึ้นไปรองรับ Promise แต่มี Callback ไว้เพื่อให้ใช้กับเวอร์ชันก่อนหน้าได้ คุณใช้ทั้ง 2 รูปแบบในการเรียกใช้ฟังก์ชันเดียวกันไม่ได้ พรอมต์จะได้รับการแก้ไขด้วยประเภทเดียวกันกับที่ส่งไปยังการเรียกกลับ

setTitle()

สัญญา 
chrome.action.setTitle(
  details: object,
  callback?: function,
)

ตั้งชื่อการดำเนินการ ซึ่งจะแสดงอยู่ในเคล็ดลับเครื่องมือ

พารามิเตอร์

  • รายละเอียด

    ออบเจ็กต์

    • tabId

      หมายเลข ไม่บังคับ

      จำกัดการเปลี่ยนแปลงไว้เฉพาะเมื่อเลือกแท็บหนึ่งๆ รีเซ็ตโดยอัตโนมัติเมื่อปิดแท็บ

    • title

      สตริง

      สตริงที่การดำเนินการควรจะแสดงเมื่อวางเมาส์เหนือ

  • Callback

    ไม่บังคับ

    พารามิเตอร์ callback มีลักษณะดังนี้ 

    () => void

การคืนสินค้า

  • Promise<void>

    Promise รองรับไฟล์ Manifest V3 ขึ้นไป แต่จะมี Callback เพื่อรองรับความเข้ากันได้แบบย้อนหลัง คุณไม่สามารถใช้ทั้ง 2 อย่างในการเรียกใช้ฟังก์ชันเดียวกันได้ โดยสัญญาจะได้รับการแก้ไขด้วยประเภทเดียวกันกับที่ส่งไปยัง Callback

กิจกรรม

onClicked

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

เริ่มทํางานเมื่อมีการคลิกไอคอนการดําเนินการ เหตุการณ์นี้จะไม่ทริกเกอร์หากการดําเนินการมีพอพปอัป

พารามิเตอร์

  • Callback

    ฟังก์ชัน

    พารามิเตอร์ callback จะมีลักษณะดังนี้ 

    (tab: tabs.Tab) => void

onUserSettingsChanged

Chrome 130 ขึ้นไป 
chrome.action.onUserSettingsChanged.addListener(
  callback: function,
)

เริ่มทำงานเมื่อการตั้งค่าที่ผู้ใช้ระบุซึ่งเกี่ยวข้องกับการเปลี่ยนแปลงการดำเนินการของส่วนขยาย

พารามิเตอร์

  • Callback

    ฟังก์ชัน

    พารามิเตอร์ callback จะมีลักษณะดังนี้ 

    (change: UserSettingsChange) => void