chrome.tabs

คำอธิบาย

ใช้ chrome.tabs API เพื่อโต้ตอบกับระบบแท็บของเบราว์เซอร์ คุณสามารถใช้ API นี้เพื่อสร้าง แก้ไข และจัดเรียงแท็บในเบราว์เซอร์ใหม่

ภาพรวม

Tabs API ไม่เพียงนำเสนอฟีเจอร์สำหรับการจัดการและจัดการแท็บเท่านั้น แต่ยังสามารถตรวจหา ภาษาของแท็บ ให้ถ่ายภาพหน้าจอ และ สื่อสารด้วยสคริปต์เนื้อหาของแท็บ

สิทธิ์

ฟีเจอร์ส่วนใหญ่ไม่ต้องใช้สิทธิ์ใดๆ ในการใช้งาน เช่น การสร้างแท็บใหม่ การโหลดแท็บซ้ำ การนำทางไปยัง URL อื่น เป็นต้น

มีสิทธิ์ 3 รายการที่นักพัฒนาซอฟต์แวร์ควรทราบเมื่อทำงานกับ Tabs API

"แท็บ" สิทธิ์
สิทธิ์นี้ไม่ได้ให้สิทธิ์เข้าถึงเนมสเปซ chrome.tabs ผลลัพธ์ ให้การขยายความสามารถในการเรียกใช้ tabs.query() ต่อ 4 พร็อพเพอร์ตี้ที่มีความละเอียดอ่อนในอินสแตนซ์ tabs.Tab: url, pendingUrl, title และ favIconUrl
สิทธิ์ของโฮสต์
สิทธิ์ของโฮสต์อนุญาตให้ส่วนขยายอ่านและค้นหาความละเอียดอ่อน 4 ประการของแท็บที่ตรงกัน พร็อพเพอร์ตี้ tabs.Tab นอกจากนี้ยังโต้ตอบกับแท็บที่ตรงกันได้โดยตรงโดยใช้วิธีต่างๆ เช่น ด้วยชื่อ tabs.captureVisibleTab() tabs.executeScript(), tabs.insertCSS() และ tabs.removeCSS()
แท็บ "activeTab" สิทธิ์
activeTab ให้สิทธิ์โฮสต์ชั่วคราวของส่วนขยายสำหรับแท็บปัจจุบันใน การตอบสนองต่อคำขอของผู้ใช้ activeTab จะไม่แสดงคำเตือน ซึ่งต่างจากสิทธิ์ของโฮสต์

ไฟล์ Manifest

ต่อไปนี้เป็นตัวอย่างวิธีประกาศสิทธิ์แต่ละรายการในไฟล์ Manifest

  {
    "name": "My extension",
    ...
    "permissions": [
      "tabs"
    ],
    ...
  }


  {
    "name": "My extension",
    ...
    "host_permissions": [
      "http://*/*",
      "https://*/*"
    ],
    ...
  }


  {
    "name": "My extension",
    ...
    "permissions": [
      "activeTab"
    ],
    ...
  }

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

ส่วนต่อไปนี้จะแสดง Use Case ที่พบบ่อย

การเปิดหน้าส่วนขยายในแท็บใหม่

รูปแบบที่พบบ่อยสำหรับส่วนขยายคือการเปิดหน้าเริ่มต้นใช้งานในแท็บใหม่เมื่อส่วนขยาย ติดตั้งไว้แล้ว ตัวอย่างต่อไปนี้แสดงวิธีดำเนินการ

background.js:

chrome.runtime.onInstalled.addListener(({reason}) => {
  if (reason === 'install') {
    chrome.tabs.create({
      url: "onboarding.html"
    });
  }
});

รับแท็บปัจจุบัน

ตัวอย่างนี้แสดงให้เห็นว่า Service Worker ของส่วนขยายสามารถเรียกแท็บที่ใช้งานอยู่จาก หน้าต่างที่โฟกัสอยู่ (หรือหน้าต่างที่เพิ่งโฟกัสล่าสุด หากไม่ได้โฟกัสหน้าต่าง Chrome อยู่) ช่วงเวลานี้ โดยปกติแล้วจะเป็นแท็บปัจจุบันของผู้ใช้

  async function getCurrentTab() {
    let queryOptions = { active: true, lastFocusedWindow: true };
    // `tab` will either be a `tabs.Tab` instance or `undefined`.
    let [tab] = await chrome.tabs.query(queryOptions);
    return tab;
  }


  function getCurrentTab(callback) {
    let queryOptions = { active: true, lastFocusedWindow: true };
    chrome.tabs.query(queryOptions, ([tab]) => {
      if (chrome.runtime.lastError)
      console.error(chrome.runtime.lastError);
      // `tab` will either be a `tabs.Tab` instance or `undefined`.
      callback(tab);
    });
  }

ปิดเสียงแท็บที่ระบุ

ตัวอย่างนี้แสดงให้เห็นว่าส่วนขยายสามารถสลับสถานะปิดเสียงของแท็บหนึ่งๆ ได้อย่างไร

  async function toggleMuteState(tabId) {
    const tab = await chrome.tabs.get(tabId);
    const muted = !tab.mutedInfo.muted;
    await chrome.tabs.update(tabId, {muted});
    console.log(`Tab ${tab.id} is ${muted ? "muted" : "unmuted"}`);
  }


  function toggleMuteState(tabId) {
    chrome.tabs.get(tabId, async (tab) => {
      let muted = !tab.mutedInfo.muted;
      await chrome.tabs.update(tabId, { muted });
      console.log(`Tab ${tab.id} is ${ muted ? "muted" : "unmuted" }`);
    });
  }

ย้ายแท็บปัจจุบันไปที่ตำแหน่งแรกเมื่อคลิก

ตัวอย่างนี้แสดงวิธีย้ายแท็บในขณะที่การลากอาจดำเนินการอยู่หรือไม่อยู่ ขณะที่ตัวอย่างนี้ ใช้ chrome.tabs.move คุณสามารถใช้รูปแบบการรอแบบเดียวกันสำหรับการเรียกอื่นๆ ที่แก้ไขแท็บในขณะที่ อยู่ระหว่างการลาก

  chrome.tabs.onActivated.addListener(moveToFirstPosition);

  async function moveToFirstPosition(activeInfo) {
    try {
      await chrome.tabs.move(activeInfo.tabId, {index: 0});
      console.log("Success.");
    } catch (error) {
      if (error == "Error: Tabs cannot be edited right now (user may be dragging a tab).") {
        setTimeout(() => moveToFirstPosition(activeInfo), 50);
      } else {
        console.error(error);
      }
    }
  }


  chrome.tabs.onActivated.addListener(moveToFirstPositionMV2);

  function moveToFirstPositionMV2(activeInfo) {
    chrome.tabs.move(activeInfo.tabId, { index: 0 }, () => {
      if (chrome.runtime.lastError) {
        const error = chrome.runtime.lastError;
        if (error == "Error: Tabs cannot be edited right now (user may be dragging a tab).") {
          setTimeout(() => moveToFirstPositionMV2(activeInfo), 50);
        } else {
          console.error(error);
        }
      } else {
        console.log("Success.");
      }
    });
  }

ส่งข้อความไปยังสคริปต์เนื้อหาของแท็บที่เลือก

ตัวอย่างนี้แสดงให้เห็นว่า Service Worker ของส่วนขยายสามารถสื่อสารกับสคริปต์เนื้อหาในแท็บเบราว์เซอร์ที่เจาะจงโดยใช้ tabs.sendMessage() ได้อย่างไร

function sendMessageToActiveTab(message) {
  const [tab] = await chrome.tabs.query({ active: true, lastFocusedWindow: true });
  const response = await chrome.tabs.sendMessage(tab.id, message);
  // TODO: Do something with the response.
}

ตัวอย่างส่วนขยาย

สำรวจการสาธิตส่วนขยาย Tabs API อื่นๆ ดังต่อไปนี้

ประเภท

MutedInfo

Chrome 46 ขึ้นไป

สถานะปิดเสียงของแท็บและเหตุผลในการเปลี่ยนแปลงสถานะครั้งล่าสุด

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

  • extensionId

    string ไม่บังคับ

    รหัสของส่วนขยายที่เปลี่ยนสถานะปิดเสียง ไม่ได้ตั้งค่าหากส่วนขยายไม่ใช่เหตุผลที่มีการเปลี่ยนแปลงสถานะการปิดเสียงครั้งล่าสุด

  • ปิดเสียงอยู่

    boolean

    แท็บปิดเสียงอยู่หรือไม่ (ป้องกันไม่ให้เล่นเสียง) แท็บอาจถูกปิดเสียงแม้ว่าจะไม่ได้เล่นหรือไม่ได้เล่นเสียงในขณะนี้ เทียบเท่ากับการที่ปุ่ม "ปิดเสียง" สัญญาณบอกสถานะเสียงแสดงอยู่

  • สาเหตุ

    MutedInfoReason ไม่บังคับ

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

MutedInfoReason

Chrome 46 ขึ้นไป

เหตุการณ์ที่ทำให้เกิดการเปลี่ยนแปลงสถานะปิดเสียง

ค่าแจกแจง

"user"
การดำเนินการป้อนข้อมูลของผู้ใช้ตั้งค่าสถานะปิดเสียง

"capture"
เริ่มจับภาพแท็บแล้ว บังคับให้เปลี่ยนสถานะเป็นปิดเสียง

"extension"
ส่วนขยายที่ระบุโดยช่องextensionId เป็นผู้ตั้งสถานะปิดเสียง

Tab

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

  • ใช้งาน

    boolean

    แท็บทํางานในหน้าต่างหรือไม่ ไม่ได้หมายความว่าหน้าต่างโฟกัสอยู่เสมอไป

  • audible

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

    Chrome 45 ขึ้นไป

    แท็บมีเสียงในช่วง 2-3 วินาทีที่ผ่านมาหรือไม่ (แต่อาจไม่ได้ยินเสียงหากปิดเสียงด้วย) เทียบเท่ากับที่ "เสียงจากลำโพง" สัญญาณบอกสถานะกำลังแสดงอยู่

  • autoDiscardable

    boolean

    Chrome 54 ขึ้นไป

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

  • ทิ้งแล้ว

    boolean

    Chrome 54 ขึ้นไป

    ระบุว่ามีการทิ้งแท็บหรือไม่ แท็บที่ทิ้งคือแท็บที่มีการยกเลิกการโหลดเนื้อหาจากหน่วยความจำ แต่ยังคงมองเห็นได้ในแนวแท็บ เนื้อหาของระบบจะโหลดซ้ำเมื่อเปิดใช้งานครั้งถัดไป

  • favIconUrl

    string ไม่บังคับ

    URL ของไอคอน Fav ของแท็บ พร็อพเพอร์ตี้นี้จะปรากฏเมื่อไฟล์ Manifest ของส่วนขยายมีสิทธิ์ "tabs" เท่านั้น หรืออาจเป็นสตริงว่างเปล่าหากแท็บกำลังโหลดอยู่

  • groupId

    ตัวเลข

    Chrome เวอร์ชัน 88 ขึ้นไป

    รหัสของกลุ่มที่มีแท็บนั้นอยู่

  • ส่วนสูง

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

    ความสูงของแท็บในหน่วยพิกเซล

  • ไฮไลต์ไว้

    boolean

    แท็บมีการไฮไลต์หรือไม่

  • id

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

    รหัสของแท็บ รหัสแท็บจะไม่ซ้ำกันในเซสชันเบราว์เซอร์ ในบางกรณี ระบบอาจกำหนดรหัสให้กับแท็บไม่ได้ เช่น เมื่อค้นหาแท็บนอกโดยใช้ API sessions ซึ่งในกรณีนี้อาจมีรหัสเซสชัน คุณยังตั้งค่ารหัสแท็บเป็น chrome.tabs.TAB_ID_NONE สำหรับแอปและหน้าต่างเครื่องมือสำหรับนักพัฒนาเว็บได้ด้วย

  • ไม่ระบุตัวตน

    boolean

    แท็บอยู่ในหน้าต่างที่ไม่ระบุตัวตนหรือไม่

  • ดัชนี

    ตัวเลข

    ดัชนีฐาน 0 ของแท็บภายในหน้าต่าง

  • lastAccessed

    ตัวเลข

    Chrome 121 ขึ้นไป

    เวลาล่าสุดที่มีการเข้าถึงแท็บเป็นจำนวนมิลลิวินาทีตั้งแต่ Epoch

  • mutedInfo

    MutedInfo ไม่บังคับ

    Chrome 46 ขึ้นไป

    สถานะปิดเสียงของแท็บและเหตุผลในการเปลี่ยนแปลงสถานะครั้งล่าสุด

  • openerTabId

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

    รหัสของแท็บที่เปิดแท็บนี้ (หากมี) คุณสมบัตินี้จะปรากฏต่อเมื่อแท็บที่เปิดไว้ยังคงอยู่เท่านั้น

  • pendingUrl

    string ไม่บังคับ

    Chrome 79 ขึ้นไป

    URL ที่แท็บนำทางไปก่อนที่จะทำการคอมมิต พร็อพเพอร์ตี้นี้จะปรากฏเฉพาะเมื่อไฟล์ Manifest ของส่วนขยายมีสิทธิ์ "tabs" และมีการนำทางที่รอดำเนินการ

  • ตรึงอยู่

    boolean

    ปักหมุดแท็บอยู่หรือไม่

  • เลือกแล้ว

    boolean

    เลิกใช้งานแล้ว

    โปรดใช้ tabs.Tab.highlighted

    มีการเลือกแท็บหรือไม่

  • sessionId

    string ไม่บังคับ

    รหัสเซสชันที่ใช้เพื่อระบุแท็บที่ได้รับจาก sessions API โดยไม่ซ้ำกัน

  • สถานะ

    TabStatus ไม่บังคับ

    สถานะการโหลดของแท็บ

  • title

    string ไม่บังคับ

    ชื่อแท็บ พร็อพเพอร์ตี้นี้จะปรากฏเมื่อไฟล์ Manifest ของส่วนขยายมีสิทธิ์ "tabs" เท่านั้น

  • URL

    string ไม่บังคับ

    URL ที่คอมมิตล่าสุดของเฟรมหลักของแท็บ พร็อพเพอร์ตี้นี้จะปรากฏหากไฟล์ Manifest ของส่วนขยายมีสิทธิ์ "tabs" เท่านั้น และอาจเป็นสตริงว่างเปล่าหากแท็บยังไม่ได้คอมมิต ดู Tab.pendingUrl เพิ่มเติม

  • ความกว้าง

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

    ความกว้างของแท็บในหน่วยพิกเซล

  • windowId

    ตัวเลข

    รหัสของหน้าต่างที่มีแท็บนั้น

TabStatus

Chrome 44 ขึ้นไป

สถานะการโหลดของแท็บ

ค่าแจกแจง

"ยกเลิกการโหลด"

"loading"

"เสร็จสมบูรณ์"

WindowType

Chrome 44 ขึ้นไป

ประเภทของหน้าต่าง

ค่าแจกแจง

"ปกติ"

"ป๊อปอัป"

"panel"

"แอป"

"devtools"

ZoomSettings

กำหนดวิธีจัดการการเปลี่ยนแปลงการซูมในแท็บและขอบเขต

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

  • defaultZoomFactor

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

    Chrome 43 ขึ้นไป

    ใช้เพื่อคืนระดับการซูมเริ่มต้นสำหรับแท็บปัจจุบันในการเรียกแท็บgetZoomSettings

  • โหมด

    ZoomSettingsMode optional

    กำหนดวิธีจัดการการเปลี่ยนแปลงการซูม กล่าวคือ เอนทิตีใดที่รับผิดชอบการปรับขนาดหน้าเว็บจริง ค่าเริ่มต้นคือ automatic

  • ขอบเขต

    ZoomSettingsScope ไม่บังคับ

    กำหนดว่าการเปลี่ยนแปลงการซูมจะยังคงอยู่สำหรับจุดเริ่มต้นของหน้าหรือมีผลในแท็บนี้เท่านั้น ค่าเริ่มต้นคือ per-origin เมื่ออยู่ในโหมด automatic และจะเป็น per-tab ในกรณีอื่นๆ

ZoomSettingsMode

Chrome 44 ขึ้นไป

กำหนดวิธีจัดการการเปลี่ยนแปลงการซูม กล่าวคือ เอนทิตีใดที่รับผิดชอบการปรับขนาดหน้าเว็บจริง ค่าเริ่มต้นคือ automatic

ค่าแจกแจง

"อัตโนมัติ"
เบราว์เซอร์จะจัดการการเปลี่ยนแปลงของการซูมโดยอัตโนมัติ

"manual"
ลบล้างการจัดการการซูมอัตโนมัติเมื่อมีการเปลี่ยนแปลงการซูม ระบบจะยังคงส่งเหตุการณ์ onZoomChange อยู่ และส่วนขยายมีหน้าที่รับผิดชอบที่จะติดตามเหตุการณ์นี้และปรับขนาดหน้าด้วยตนเอง โหมดนี้ไม่รองรับการซูมแบบ per-origin ดังนั้นจะไม่สนใจการตั้งค่าการซูม scope และจะถือว่า per-tab

"disable"
ปิดใช้การซูมทั้งหมดในแท็บ แท็บจะเปลี่ยนกลับเป็นระดับการซูมเริ่มต้น และระบบจะไม่สนใจการเปลี่ยนแปลงการซูมทั้งหมดที่พยายามดำเนินการ

ZoomSettingsScope

Chrome 44 ขึ้นไป

กำหนดว่าการเปลี่ยนแปลงการซูมจะยังคงอยู่สำหรับจุดเริ่มต้นของหน้าหรือมีผลในแท็บนี้เท่านั้น ค่าเริ่มต้นคือ per-origin เมื่ออยู่ในโหมด automatic และจะเป็น per-tab ในกรณีอื่นๆ

ค่าแจกแจง

"per-origin"
การเปลี่ยนแปลงในการซูมจะยังคงอยู่ในต้นทางของหน้าที่ซูม กล่าวคือ แท็บอื่นๆ ทั้งหมดที่ไปยังต้นทางเดียวกันจะได้รับการซูมด้วยเช่นกัน นอกจากนี้ การเปลี่ยนแปลงการซูม per-origin รายการจะบันทึกพร้อมต้นทาง ซึ่งหมายความว่าเมื่อไปยังหน้าอื่นๆ ในต้นทางเดียวกัน การเปลี่ยนแปลงการซูมทั้งหมดจะถูกซูมที่ปัจจัยการซูมเดียวกัน ขอบเขต per-origin พร้อมใช้งานในโหมด automatic เท่านั้น

"ต่อแท็บ"
การเปลี่ยนแปลงการซูมจะมีผลกับแท็บนี้เท่านั้น และการเปลี่ยนแปลงการซูมในแท็บอื่นๆ จะไม่มีผลต่อการซูมของแท็บนี้ นอกจากนี้ ระบบจะรีเซ็ตการเปลี่ยนแปลงการซูม per-tab รายการเมื่อนำทาง การไปยังส่วนต่างๆ ของแท็บจะโหลดหน้าเว็บโดยใช้ปัจจัยการซูม per-origin เสมอ

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

MAX_CAPTURE_VISIBLE_TAB_CALLS_PER_SECOND

Chrome 92 ขึ้นไป

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

ค่า

2

TAB_ID_NONE

Chrome 46 ขึ้นไป

รหัสที่แสดงถึงการไม่มีแท็บเบราว์เซอร์

ค่า

-1

TAB_INDEX_NONE

Chrome 123 ขึ้นไป

ดัชนีที่แสดงการไม่มีดัชนีแท็บใน Tab_strip

ค่า

-1

เมธอด

captureVisibleTab()

สัญญา 
chrome.tabs.captureVisibleTab(
  windowId?: number,
  options?: ImageDetails,
  callback?: function,
)

จับภาพพื้นที่ที่มองเห็นได้ของแท็บที่ใช้งานอยู่ในปัจจุบันในหน้าต่างที่ระบุ หากต้องการเรียกใช้เมธอดนี้ ส่วนขยายต้องมีสิทธิ์ <all_urls> หรือสิทธิ์ activeTab นอกจากเว็บไซต์ที่ส่วนขยายสามารถเข้าถึงได้ตามปกติแล้ว วิธีการนี้ยังอนุญาตให้ส่วนขยายจับภาพเว็บไซต์ที่ละเอียดอ่อนซึ่งถูกจํากัดด้วย ซึ่งรวมถึงหน้า chrome:-scheme, ส่วนขยายอื่นๆ หน้าเว็บ และข้อมูล: URL บันทึกเว็บไซต์ที่ละเอียดอ่อนเหล่านี้ได้ด้วยสิทธิ์ ActiveTab เท่านั้น สามารถบันทึก URL ของไฟล์ได้ต่อเมื่อส่วนขยายได้รับสิทธิ์เข้าถึงไฟล์แล้วเท่านั้น

พารามิเตอร์

  • windowId

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

    หน้าต่างเป้าหมาย ค่าเริ่มต้นคือหน้าต่างปัจจุบัน

  • ตัวเลือก

    ImageDetails ไม่บังคับ

  • Callback

    ไม่บังคับ

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

    (dataUrl: string) => void

    • dataUrl

      สตริง

      URL ข้อมูลที่เข้ารหัสรูปภาพของส่วนที่มองเห็นได้ของแท็บที่ถ่าย อาจกำหนดให้กับ "src" ขององค์ประกอบ HTML img สำหรับการแสดงผล

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

  • คำมั่นสัญญา<สตริง>

    Chrome เวอร์ชัน 88 ขึ้นไป

    Promise รองรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้ Callback

connect()

chrome.tabs.connect(
  tabId: number,
  connectInfo?: object,
)

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

พารามิเตอร์

  • tabId

    ตัวเลข

  • connectInfo

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

    • documentId

      string ไม่บังคับ

      Chrome 106 ขึ้นไป

      เปิดพอร์ตไปยังเอกสารที่ระบุโดย documentId แทนเฟรมทั้งหมดในแท็บ

    • frameId

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

      เปิดพอร์ตไปยังเฟรมที่เจาะจงซึ่ง frameId ระบุ แทนเฟรมทั้งหมดในแท็บ

    • ชื่อ

      string ไม่บังคับ

      ส่งผ่านไปยัง onConnect สำหรับสคริปต์เนื้อหาที่รอรับเหตุการณ์การเชื่อมต่อ

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

  • พอร์ตที่ใช้สื่อสารกับสคริปต์เนื้อหาที่ทำงานอยู่ในแท็บที่ระบุ เหตุการณ์ runtime.Port ของพอร์ตจะเริ่มทำงานหากแท็บปิดหรือไม่มีอยู่

create()

สัญญา 
chrome.tabs.create(
  createProperties: object,
  callback?: function,
)

สร้างแท็บใหม่

พารามิเตอร์

  • createProperties

    ออบเจ็กต์

    • ใช้งาน

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

      แท็บดังกล่าวควรจะกลายเป็นแท็บที่ใช้งานอยู่ในหน้าต่างหรือไม่ ไม่มีผลต่อการโฟกัสหน้าต่าง (ดู windows.update) ค่าเริ่มต้นคือ true

    • ดัชนี

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

      ตำแหน่งที่แท็บควรปรากฏในหน้าต่าง ค่าที่ระบุจะถูกบีบให้อยู่ระหว่าง 0 ถึงจำนวนแท็บในหน้าต่าง

    • openerTabId

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

      รหัสของแท็บที่เปิดแท็บนี้ หากระบุไว้ แท็บที่เปิดต้องอยู่ในหน้าต่างเดียวกับแท็บที่สร้างขึ้นใหม่

    • ตรึงอยู่

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

      ควรปักหมุดแท็บไหม ค่าเริ่มต้นคือ false

    • เลือกแล้ว

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

      เลิกใช้งานแล้ว

      โปรดใช้ active

      แท็บดังกล่าวควรเป็นแท็บที่เลือกในหน้าต่างหรือไม่ ค่าเริ่มต้นคือ true

    • URL

      string ไม่บังคับ

      URL ที่จะไปยังแท็บในตอนแรก URL ที่สมบูรณ์ในตัวเองต้องมีรูปแบบ (เช่น "http://www.google.com" ไม่ใช่ "www.google.com") URL สัมพัทธ์จะสัมพันธ์กับหน้าปัจจุบันภายในส่วนขยาย ค่าเริ่มต้นจะเป็นหน้าแท็บใหม่

    • windowId

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

      หน้าต่างที่จะใช้สร้างแท็บใหม่ ค่าเริ่มต้นคือหน้าต่างปัจจุบัน

  • Callback

    ไม่บังคับ

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

    (tab: Tab) => void

    • แท็บ

      แท็บ

      แท็บที่สร้าง

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

  • สัญญา<Tab>

    Chrome เวอร์ชัน 88 ขึ้นไป

    Promise รองรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้ Callback

detectLanguage()

สัญญา 
chrome.tabs.detectLanguage(
  tabId?: number,
  callback?: function,
)

ตรวจหาภาษาหลักของเนื้อหาในแท็บ

พารามิเตอร์

  • tabId

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

    ค่าเริ่มต้นจะเป็นแท็บที่ใช้งานอยู่ของหน้าต่างปัจจุบัน

  • Callback

    ไม่บังคับ

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

    (language: string) => void

    • ภาษา

      สตริง

      รหัสภาษา ISO เช่น en หรือ fr ดูรายการภาษาที่วิธีการนี้รองรับได้ที่ kLanguageInfoTable จะมีการทำเครื่องหมายคอลัมน์ที่สองถึงสี่ และแสดงผลค่าที่ไม่ใช่ค่าว่างค่าแรก ยกเว้นจีนตัวย่อที่แสดงผล zh-CN สำหรับภาษาที่ไม่รู้จัก/ไม่ระบุ ระบบจะแสดงผล und

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

  • คำมั่นสัญญา<สตริง>

    Chrome เวอร์ชัน 88 ขึ้นไป

    Promise รองรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้ Callback

discard()

สัญญา Chrome 54 ขึ้นไป 
chrome.tabs.discard(
  tabId?: number,
  callback?: function,
)

ยกเลิกแท็บออกจากความทรงจำ แท็บที่ยกเลิกแล้วจะยังคงปรากฏในแนวแท็บและจะได้รับการโหลดซ้ำเมื่อเปิดใช้งาน

พารามิเตอร์

  • tabId

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

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

  • Callback

    ไม่บังคับ

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

    (tab?: Tab) => void

    • แท็บ

      Tab ไม่บังคับ

      แท็บที่ทิ้ง หากมีการทิ้งสำเร็จ ไม่ได้กำหนดเป็นอย่างอื่น

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

  • สัญญา<แท็บ | ไม่ระบุ>

    Chrome เวอร์ชัน 88 ขึ้นไป

    Promise รองรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้ Callback

duplicate()

สัญญา 
chrome.tabs.duplicate(
  tabId: number,
  callback?: function,
)

ทำซ้ำแท็บ

พารามิเตอร์

  • tabId

    ตัวเลข

    รหัสของแท็บที่จะทำซ้ำ

  • Callback

    ไม่บังคับ

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

    (tab?: Tab) => void

    • แท็บ

      Tab ไม่บังคับ

      รายละเอียดเกี่ยวกับแท็บที่ซ้ำกัน ออบเจ็กต์ tabs.Tab ไม่มี url, pendingUrl, title และ favIconUrl หากยังไม่ได้ขอสิทธิ์ "tabs"

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

  • สัญญา<แท็บ | ไม่ระบุ>

    Chrome เวอร์ชัน 88 ขึ้นไป

    Promise รองรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้ Callback

executeScript()

สัญญา &amp;leq; MV2 เลิกใช้งานตั้งแต่ Chrome 91
chrome.tabs.executeScript(
  tabId?: number,
  details: InjectDetails,
  callback?: function,
)

แทนที่โดย scripting.executeScript ในไฟล์ Manifest V3

แทรกโค้ด JavaScript ลงในหน้าเว็บ โปรดดูรายละเอียดที่หัวข้อการแทรกแบบเป็นโปรแกรมของเอกสารสคริปต์เนื้อหา

พารามิเตอร์

  • tabId

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

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

  • รายละเอียด

    InjectDetails

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

  • Callback

    ไม่บังคับ

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

    (result?: any[]) => void

    • ผลลัพธ์

      any[] ไม่บังคับ

      ผลลัพธ์ของสคริปต์ในทุกเฟรมที่แทรก

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

  • Promise&lt;any[] | ไม่ระบุ>

    Chrome เวอร์ชัน 88 ขึ้นไป

    Promise รองรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้ Callback

get()

สัญญา 
chrome.tabs.get(
  tabId: number,
  callback?: function,
)

เรียกดูรายละเอียดเกี่ยวกับแท็บที่ระบุ

พารามิเตอร์

  • tabId

    ตัวเลข

  • Callback

    ไม่บังคับ

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

    (tab: Tab) => void

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

  • สัญญา<Tab>

    Chrome เวอร์ชัน 88 ขึ้นไป

    Promise รองรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้ Callback

getAllInWindow()

สัญญา &amp;leq; MV2 เลิกใช้งาน
chrome.tabs.getAllInWindow(
  windowId?: number,
  callback?: function,
)

โปรดใช้ tabs.query {windowId: windowId}

ดูรายละเอียดเกี่ยวกับแท็บทั้งหมดในหน้าต่างที่ระบุ

พารามิเตอร์

  • windowId

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

    ค่าเริ่มต้นคือหน้าต่างปัจจุบัน

  • Callback

    ไม่บังคับ

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

    (tabs: Tab[]) => void

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

  • สัญญา<Tab[]>

    Chrome เวอร์ชัน 88 ขึ้นไป

    Promise รองรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้ Callback

getCurrent()

สัญญา 
chrome.tabs.getCurrent(
  callback?: function,
)

รับแท็บที่ใช้สร้างการเรียกสคริปต์นี้ แสดงผล undefined หากมีการเรียกจากบริบทที่ไม่ใช่แท็บ (เช่น หน้าพื้นหลังหรือมุมมองป๊อปอัป)

พารามิเตอร์

  • Callback

    ไม่บังคับ

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

    (tab?: Tab) => void

    • แท็บ

      Tab ไม่บังคับ

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

  • สัญญา<แท็บ | ไม่ระบุ>

    Chrome เวอร์ชัน 88 ขึ้นไป

    Promise รองรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้ Callback

getSelected()

สัญญา &amp;leq; MV2 เลิกใช้งาน
chrome.tabs.getSelected(
  windowId?: number,
  callback?: function,
)

โปรดใช้ tabs.query {active: true}

รับแท็บที่เลือกไว้ในหน้าต่างที่ระบุ

พารามิเตอร์

  • windowId

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

    ค่าเริ่มต้นคือหน้าต่างปัจจุบัน

  • Callback

    ไม่บังคับ

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

    (tab: Tab) => void

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

  • สัญญา<Tab>

    Chrome เวอร์ชัน 88 ขึ้นไป

    Promise รองรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้ Callback

getZoom()

สัญญา 
chrome.tabs.getZoom(
  tabId?: number,
  callback?: function,
)

รับปัจจัยการซูมปัจจุบันของแท็บที่ระบุ

พารามิเตอร์

  • tabId

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

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

  • Callback

    ไม่บังคับ

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

    (zoomFactor: number) => void

    • zoomFactor

      ตัวเลข

      ปัจจัยการซูมปัจจุบันของแท็บ

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

  • Promise&lt;number&gt;

    Chrome เวอร์ชัน 88 ขึ้นไป

    Promise รองรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้ Callback

getZoomSettings()

สัญญา 
chrome.tabs.getZoomSettings(
  tabId?: number,
  callback?: function,
)

รับการตั้งค่าการซูมปัจจุบันของแท็บที่ระบุ

พารามิเตอร์

  • tabId

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

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

  • Callback

    ไม่บังคับ

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

    (zoomSettings: ZoomSettings) => void

    • zoomSettings

      ZoomSettings

      การตั้งค่าการซูมปัจจุบันของแท็บ

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

  • Promise&lt;ZoomSettings&gt;

    Chrome เวอร์ชัน 88 ขึ้นไป

    Promise รองรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้ Callback

goBack()

สัญญา Chrome 72 ขึ้นไป 
chrome.tabs.goBack(
  tabId?: number,
  callback?: function,
)

กลับไปที่หน้าก่อนนี้ หากมี

พารามิเตอร์

  • tabId

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

    รหัสของแท็บที่จะย้อนกลับ ค่าเริ่มต้นจะเป็นแท็บที่เลือกของหน้าต่างปัจจุบัน

  • Callback

    ไม่บังคับ

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

    () => void

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

  • คำสัญญา<โมฆะ>

    Chrome เวอร์ชัน 88 ขึ้นไป

    Promise รองรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้ Callback

goForward()

สัญญา Chrome 72 ขึ้นไป 
chrome.tabs.goForward(
  tabId?: number,
  callback?: function,
)

ไปยังหน้าถัดไป หากมี

พารามิเตอร์

  • tabId

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

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

  • Callback

    ไม่บังคับ

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

    () => void

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

  • คำสัญญา<โมฆะ>

    Chrome เวอร์ชัน 88 ขึ้นไป

    Promise รองรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้ Callback

group()

สัญญา Chrome 88 ขึ้นไป 
chrome.tabs.group(
  options: object,
  callback?: function,
)

เพิ่มแท็บอย่างน้อย 1 แท็บลงในกลุ่มที่ระบุ หรือหากไม่ได้ระบุกลุ่ม ให้เพิ่มแท็บดังกล่าวไปยังกลุ่มที่สร้างขึ้นใหม่

พารามิเตอร์

  • ตัวเลือก

    ออบเจ็กต์

    • createProperties

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

      การกำหนดค่าสำหรับการสร้างกลุ่ม ใช้ไม่ได้หากระบุ groupId ไว้แล้ว

      • windowId

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

        หน้าต่างของกลุ่มใหม่ ค่าเริ่มต้นคือหน้าต่างปัจจุบัน

    • groupId

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

      รหัสของกลุ่มที่จะเพิ่มแท็บ หากไม่ระบุ ระบบจะสร้างกลุ่มใหม่

    • tabIds

      ตัวเลข | [ตัวเลข, ...หมายเลข[]]

      รหัสแท็บหรือรายการรหัสแท็บที่จะเพิ่มไปยังกลุ่มที่ระบุ

  • Callback

    ไม่บังคับ

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

    (groupId: number) => void

    • groupId

      ตัวเลข

      รหัสของกลุ่มที่เพิ่มแท็บนั้น

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

  • Promise&lt;number&gt;

    Promise รองรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้ Callback

highlight()

สัญญา 
chrome.tabs.highlight(
  highlightInfo: object,
  callback?: function,
)

ไฮไลต์แท็บที่ระบุและโฟกัสที่แท็บแรกของกลุ่ม จะไม่แสดงการดำเนินการใดๆ หากแท็บที่ระบุมีการใช้งานอยู่

พารามิเตอร์

  • highlightInfo

    ออบเจ็กต์

    • แท็บ

      ตัวเลข | ตัวเลข[]

      ดัชนีแท็บอย่างน้อย 1 รายการเพื่อไฮไลต์

    • windowId

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

      หน้าต่างที่มีแท็บต่างๆ

  • Callback

    ไม่บังคับ

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

    (window: Window) => void

    • หน้าต่าง

      กรอบเวลา

      มีรายละเอียดเกี่ยวกับหน้าต่างที่มีแท็บที่ไฮไลต์

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

  • Promise&lt;windows.Window&gt;

    Chrome เวอร์ชัน 88 ขึ้นไป

    Promise รองรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้ Callback

insertCSS()

สัญญา &amp;leq; MV2 เลิกใช้งานตั้งแต่ Chrome 91
chrome.tabs.insertCSS(
  tabId?: number,
  details: InjectDetails,
  callback?: function,
)

แทนที่โดย scripting.insertCSS ในไฟล์ Manifest V3

แทรก CSS ลงในหน้าเว็บ คุณนำรูปแบบที่แทรกด้วยวิธีนี้ออกได้ด้วย scripting.removeCSS โปรดดูรายละเอียดที่หัวข้อการแทรกแบบเป็นโปรแกรมของเอกสารสคริปต์เนื้อหา

พารามิเตอร์

  • tabId

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

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

  • รายละเอียด

    InjectDetails

    รายละเอียดของข้อความ CSS ที่จะแทรก ต้องตั้งค่าโค้ดหรือคุณสมบัติของไฟล์อย่างใดอย่างหนึ่ง แต่ตั้งค่าทั้ง 2 อย่างพร้อมกันไม่ได้

  • Callback

    ไม่บังคับ

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

    () => void

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

  • คำสัญญา<โมฆะ>

    Chrome เวอร์ชัน 88 ขึ้นไป

    Promise รองรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้ Callback

move()

สัญญา 
chrome.tabs.move(
  tabIds: number | number[],
  moveProperties: object,
  callback?: function,
)

ย้ายแท็บอย่างน้อย 1 แท็บไปยังตำแหน่งใหม่ภายในหน้าต่างนั้น หรือไปยังหน้าต่างใหม่ โปรดทราบว่าสามารถย้ายแท็บเข้าและออกจากหน้าต่างปกติ (window.type === "ปกติ") เท่านั้น

พารามิเตอร์

  • tabIds

    ตัวเลข | ตัวเลข[]

    รหัสแท็บหรือรายการรหัสแท็บที่จะย้าย

  • moveProperties

    ออบเจ็กต์

    • ดัชนี

      ตัวเลข

      ตำแหน่งที่จะย้ายหน้าต่างไป ใช้ -1 เพื่อวางแท็บท้ายหน้าต่าง

    • windowId

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

      ค่าเริ่มต้นจะเป็นหน้าต่างที่มีแท็บนั้นอยู่

  • Callback

    ไม่บังคับ

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

    (tabs: Tab | Tab[]) => void

    • แท็บ

      แท็บ | แท็บ[]

      รายละเอียดเกี่ยวกับแท็บที่ย้าย

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

  • สัญญา<แท็บ | แท็บ[]>

    Chrome เวอร์ชัน 88 ขึ้นไป

    Promise รองรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้ Callback

query()

สัญญา 
chrome.tabs.query(
  queryInfo: object,
  callback?: function,
)

รับแท็บทั้งหมดที่มีพร็อพเพอร์ตี้ที่ระบุ หรือแท็บทั้งหมดหากไม่มีการระบุพร็อพเพอร์ตี้

พารามิเตอร์

  • queryInfo

    ออบเจ็กต์

    • ใช้งาน

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

      แท็บทํางานอยู่ในหน้าต่างหรือไม่

    • audible

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

      Chrome 45 ขึ้นไป

      ได้ยินเสียงแท็บไหม

    • autoDiscardable

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

      Chrome 54 ขึ้นไป

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

    • currentWindow

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

      แท็บอยู่ในหน้าต่างปัจจุบันหรือไม่

    • ทิ้งแล้ว

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

      Chrome 54 ขึ้นไป

      มีการปิดแท็บหรือไม่ แท็บที่ทิ้งคือแท็บที่มีการยกเลิกการโหลดเนื้อหาจากหน่วยความจำ แต่ยังคงมองเห็นได้ในแนวแท็บ เนื้อหาของระบบจะโหลดซ้ำเมื่อเปิดใช้งานครั้งถัดไป

    • groupId

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

      Chrome เวอร์ชัน 88 ขึ้นไป

      รหัสของกลุ่มที่มีแท็บนั้น หรือ tabGroups.TAB_GROUP_ID_NONE สำหรับแท็บที่ไม่ได้จัดกลุ่ม

    • ไฮไลต์ไว้

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

      แท็บมีการไฮไลต์หรือไม่

    • ดัชนี

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

      ตำแหน่งของแท็บภายในหน้าต่าง

    • lastFocusedWindow

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

      แท็บอยู่ในหน้าต่างที่โฟกัสล่าสุดหรือไม่

    • ปิดเสียงอยู่

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

      Chrome 45 ขึ้นไป

      แท็บต่างๆ ปิดเสียงอยู่หรือไม่

    • ตรึงอยู่

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

      แท็บมีการปักหมุดหรือไม่

    • สถานะ

      TabStatus ไม่บังคับ

      สถานะการโหลดแท็บ

    • title

      string ไม่บังคับ

      จับคู่ชื่อหน้ากับรูปแบบ พร็อพเพอร์ตี้นี้จะถูกละเว้นหากส่วนขยายไม่มีสิทธิ์ "tabs"

    • URL

      string | string[] ไม่บังคับ

      จับคู่แท็บกับรูปแบบ URL อย่างน้อย 1 รายการ ตัวระบุ Fragment ไม่ตรงกัน พร็อพเพอร์ตี้นี้จะถูกละเว้นหากส่วนขยายไม่มีสิทธิ์ "tabs"

    • windowId

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

      รหัสของหน้าต่างระดับบนสุดหรือ windows.WINDOW_ID_CURRENT ของหน้าต่างปัจจุบัน

    • windowType

      WindowType ไม่บังคับ

      ประเภทของหน้าต่างที่มีแท็บอยู่

  • Callback

    ไม่บังคับ

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

    (result: Tab[]) => void

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

  • สัญญา<Tab[]>

    Chrome เวอร์ชัน 88 ขึ้นไป

    Promise รองรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้ Callback

reload()

สัญญา 
chrome.tabs.reload(
  tabId?: number,
  reloadProperties?: object,
  callback?: function,
)

โหลดแท็บซ้ำ

พารามิเตอร์

  • tabId

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

    รหัสของแท็บที่จะโหลดซ้ำ ค่าเริ่มต้นจะเป็นแท็บที่เลือกของหน้าต่างปัจจุบัน

  • reloadProperties

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

    • bypassCache

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

      เลือกว่าจะข้ามการแคชในเครื่องหรือไม่ ค่าเริ่มต้นคือ false

  • Callback

    ไม่บังคับ

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

    () => void

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

  • คำสัญญา<โมฆะ>

    Chrome เวอร์ชัน 88 ขึ้นไป

    Promise รองรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้ Callback

remove()

สัญญา 
chrome.tabs.remove(
  tabIds: number | number[],
  callback?: function,
)

ปิดแท็บอย่างน้อย 1 แท็บ

พารามิเตอร์

  • tabIds

    ตัวเลข | ตัวเลข[]

    รหัสแท็บหรือรายการรหัสแท็บที่จะปิด

  • Callback

    ไม่บังคับ

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

    () => void

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

  • คำสัญญา<โมฆะ>

    Chrome เวอร์ชัน 88 ขึ้นไป

    Promise รองรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้ Callback

removeCSS()

สัญญา Chrome 87 ขึ้นไป &amp;leq; MV2 เลิกใช้งานตั้งแต่ Chrome 91
chrome.tabs.removeCSS(
  tabId?: number,
  details: DeleteInjectionDetails,
  callback?: function,
)

แทนที่โดย scripting.removeCSS ในไฟล์ Manifest V3

นำออกจาก CSS ของหน้าที่ก่อนหน้านี้แทรกโดยการเรียก scripting.insertCSS

พารามิเตอร์

  • tabId

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

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

  • รายละเอียด

    DeleteInjectionDetails

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

  • Callback

    ไม่บังคับ

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

    () => void

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

  • คำสัญญา<โมฆะ>

    Chrome เวอร์ชัน 88 ขึ้นไป

    Promise รองรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้ Callback

sendMessage()

สัญญา 
chrome.tabs.sendMessage(
  tabId: number,
  message: any,
  options?: object,
  callback?: function,
)

ส่งข้อความเดียวไปยังสคริปต์เนื้อหาในแท็บที่ระบุ โดยมีตัวเลือกการเรียกกลับที่จะทำงานเมื่อมีการส่งการตอบกลับ เหตุการณ์ runtime.onMessage จะเริ่มทำงานในสคริปต์เนื้อหาแต่ละรายการที่ทำงานอยู่ในแท็บที่ระบุสำหรับส่วนขยายปัจจุบัน

พารามิเตอร์

  • tabId

    ตัวเลข

  • ข้อความ

    ใดๆ

    ข้อความที่จะส่ง ข้อความนี้ควรเป็นออบเจ็กต์ JSON ที่รองรับได้

  • ตัวเลือก

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

    • documentId

      string ไม่บังคับ

      Chrome 106 ขึ้นไป

      ส่งข้อความไปยังเอกสารที่ระบุโดย documentId แทนเฟรมทั้งหมดในแท็บ

    • frameId

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

      ส่งข้อความไปยังเฟรมที่ระบุโดย frameId แทนเฟรมทั้งหมดในแท็บ

  • Callback

    ไม่บังคับ

    Chrome 99 ขึ้นไป

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

    (response: any) => void

    • การตอบกลับ

      ใดๆ

      ออบเจ็กต์การตอบกลับ JSON ที่ส่งโดยเครื่องจัดการข้อความ หากเกิดข้อผิดพลาดขณะเชื่อมต่อกับแท็บที่ระบุ ระบบจะเรียกใช้ Callback โดยไม่มีอาร์กิวเมนต์และตั้งค่า runtime.lastError ในข้อความแสดงข้อผิดพลาด

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

  • สัญญา<ไม่จำกัด>

    Chrome 99 ขึ้นไป

    Promise รองรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้ Callback

sendRequest()

สัญญา &amp;leq; MV2 เลิกใช้งาน
chrome.tabs.sendRequest(
  tabId: number,
  request: any,
  callback?: function,
)

โปรดใช้ runtime.sendMessage

ส่งคำขอรายการเดียวไปยังสคริปต์เนื้อหาในแท็บที่ระบุ โดยมีตัวเลือกการเรียกกลับที่จะทำงานเมื่อมีการส่งการตอบกลับ เหตุการณ์ extension.onRequest จะเริ่มทำงานในสคริปต์เนื้อหาแต่ละรายการที่ทำงานอยู่ในแท็บที่ระบุสำหรับส่วนขยายปัจจุบัน

พารามิเตอร์

  • tabId

    ตัวเลข

  • ส่งคำขอ

    ใดๆ

  • Callback

    ไม่บังคับ

    Chrome 99 ขึ้นไป

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

    (response: any) => void

    • การตอบกลับ

      ใดๆ

      ออบเจ็กต์การตอบสนอง JSON ที่ส่งโดยเครื่องจัดการคำขอ หากเกิดข้อผิดพลาดขณะเชื่อมต่อกับแท็บที่ระบุ ระบบจะเรียกใช้ Callback โดยไม่มีอาร์กิวเมนต์และตั้งค่า runtime.lastError ในข้อความแสดงข้อผิดพลาด

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

  • สัญญา<ไม่จำกัด>

    Chrome 99 ขึ้นไป

    Promise รองรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้ Callback

setZoom()

สัญญา 
chrome.tabs.setZoom(
  tabId?: number,
  zoomFactor: number,
  callback?: function,
)

ซูมแท็บที่ระบุ

พารามิเตอร์

  • tabId

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

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

  • zoomFactor

    ตัวเลข

    ปัจจัยการซูมใหม่ ค่า 0 จะตั้งค่าปัจจัยการซูมเริ่มต้นให้แท็บนั้น ค่าที่มากกว่า 0 จะระบุปัจจัยการซูม (อาจไม่ใช่ค่าเริ่มต้น) ของแท็บ

  • Callback

    ไม่บังคับ

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

    () => void

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

  • คำสัญญา<โมฆะ>

    Chrome เวอร์ชัน 88 ขึ้นไป

    Promise รองรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้ Callback

setZoomSettings()

สัญญา 
chrome.tabs.setZoomSettings(
  tabId?: number,
  zoomSettings: ZoomSettings,
  callback?: function,
)

ตั้งค่าการซูมสำหรับแท็บที่ระบุ ซึ่งจะกำหนดวิธีจัดการการเปลี่ยนแปลงการซูม การตั้งค่าเหล่านี้จะรีเซ็ตเป็นค่าเริ่มต้นเมื่อไปยังแท็บ

พารามิเตอร์

  • tabId

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

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

  • zoomSettings

    ZoomSettings

    กำหนดวิธีจัดการการเปลี่ยนแปลงการซูมและขอบเขต

  • Callback

    ไม่บังคับ

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

    () => void

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

  • คำสัญญา<โมฆะ>

    Chrome เวอร์ชัน 88 ขึ้นไป

    Promise รองรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้ Callback

ungroup()

สัญญา Chrome 88 ขึ้นไป 
chrome.tabs.ungroup(
  tabIds: number | [number, ...number[]],
  callback?: function,
)

นำแท็บอย่างน้อย 1 แท็บออกจากกลุ่มที่เกี่ยวข้อง หากกลุ่มใดว่างเปล่า ระบบจะลบกลุ่มเหล่านั้นออก

พารามิเตอร์

  • tabIds

    ตัวเลข | [ตัวเลข, ...หมายเลข[]]

    รหัสแท็บหรือรายการรหัสแท็บที่จะนำออกจากกลุ่มที่เกี่ยวข้อง

  • Callback

    ไม่บังคับ

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

    () => void

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

  • คำสัญญา<โมฆะ>

    Promise รองรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้ Callback

update()

สัญญา 
chrome.tabs.update(
  tabId?: number,
  updateProperties: object,
  callback?: function,
)

แก้ไขคุณสมบัติของแท็บ ระบบจะไม่แก้ไขพร็อพเพอร์ตี้ที่ไม่ได้ระบุใน updateProperties

พารามิเตอร์

  • tabId

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

    ค่าเริ่มต้นจะเป็นแท็บที่เลือกไว้ของหน้าต่างปัจจุบัน

  • updateProperties

    ออบเจ็กต์

    • ใช้งาน

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

      แท็บควรใช้งานอยู่หรือไม่ ไม่มีผลต่อการโฟกัสหน้าต่าง (ดู windows.update)

    • autoDiscardable

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

      Chrome 54 ขึ้นไป

      เบราว์เซอร์ควรทิ้งแท็บโดยอัตโนมัติเมื่อทรัพยากรเหลือน้อยหรือไม่

    • ไฮไลต์ไว้

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

      เพิ่มหรือนำแท็บออกจากการเลือกปัจจุบัน

    • ปิดเสียงอยู่

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

      Chrome 45 ขึ้นไป

      แท็บควรปิดเสียงไหม

    • openerTabId

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

      รหัสของแท็บที่เปิดแท็บนี้ หากระบุไว้ แท็บที่เปิดต้องอยู่ในหน้าต่างเดียวกับแท็บนี้

    • ตรึงอยู่

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

      ควรปักหมุดแท็บไหม

    • เลือกแล้ว

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

      เลิกใช้งานแล้ว

      โปรดใช้ส่วนไฮไลต์

      ควรเลือกแท็บหรือไม่

    • URL

      string ไม่บังคับ

      URL สำหรับไปยังแท็บ ระบบไม่รองรับ JavaScript URL ใช้ scripting.executeScript แทน

  • Callback

    ไม่บังคับ

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

    (tab?: Tab) => void

    • แท็บ

      Tab ไม่บังคับ

      รายละเอียดเกี่ยวกับแท็บที่อัปเดต ออบเจ็กต์ tabs.Tab ไม่มี url, pendingUrl, title และ favIconUrl หากยังไม่ได้ขอสิทธิ์ "tabs"

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

  • สัญญา<แท็บ | ไม่ระบุ>

    Chrome เวอร์ชัน 88 ขึ้นไป

    Promise รองรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้ Callback

กิจกรรม

onActivated

chrome.tabs.onActivated.addListener(
  callback: function,
)

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

พารามิเตอร์

  • Callback

    ฟังก์ชัน

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

    (activeInfo: object) => void

    • activeInfo

      ออบเจ็กต์

      • tabId

        ตัวเลข

        รหัสของแท็บที่เปิดใช้งานแล้ว

      • windowId

        ตัวเลข

        รหัสของหน้าต่างที่แท็บที่ใช้งานอยู่มีการเปลี่ยนแปลงภายใน

onActiveChanged

&amp;leq; MV2 เลิกใช้งานแล้ว
chrome.tabs.onActiveChanged.addListener(
  callback: function,
)

โปรดใช้ tabs.onActivated

เริ่มทำงานเมื่อแท็บที่เลือกในหน้าต่างมีการเปลี่ยนแปลง โปรดทราบว่า คุณอาจไม่ได้ตั้งค่า URL ของแท็บในเวลาที่เหตุการณ์นี้เริ่มทำงาน แต่คุณจะรับฟังเหตุการณ์ tabs.onUpdated เพื่อรับการแจ้งเตือนเมื่อตั้งค่า URL ได้

พารามิเตอร์

  • Callback

    ฟังก์ชัน

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

    (tabId: number, selectInfo: object) => void

    • tabId

      ตัวเลข

    • selectInfo

      ออบเจ็กต์

      • windowId

        ตัวเลข

        รหัสของหน้าต่างที่แท็บที่เลือกมีการเปลี่ยนแปลง

onAttached

chrome.tabs.onAttached.addListener(
  callback: function,
)

เริ่มทำงานเมื่อมีการแนบแท็บกับหน้าต่าง เช่น เพราะถูกย้ายไปมาระหว่างหน้าต่าง

พารามิเตอร์

  • Callback

    ฟังก์ชัน

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

    (tabId: number, attachInfo: object) => void

    • tabId

      ตัวเลข

    • attachInfo

      ออบเจ็กต์

      • newPosition

        ตัวเลข

      • newWindowId

        ตัวเลข

onCreated

chrome.tabs.onCreated.addListener(
  callback: function,
)

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

พารามิเตอร์

  • Callback

    ฟังก์ชัน

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

    (tab: Tab) => void

onDetached

chrome.tabs.onDetached.addListener(
  callback: function,
)

เริ่มทำงานเมื่อนำแท็บออกจากหน้าต่าง เช่น เพราะถูกย้ายไปมาระหว่างหน้าต่าง

พารามิเตอร์

  • Callback

    ฟังก์ชัน

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

    (tabId: number, detachInfo: object) => void

    • tabId

      ตัวเลข

    • detachInfo

      ออบเจ็กต์

      • oldPosition

        ตัวเลข

      • oldWindowId

        ตัวเลข

onHighlightChanged

&amp;leq; MV2 เลิกใช้งานแล้ว
chrome.tabs.onHighlightChanged.addListener(
  callback: function,
)

โปรดใช้ tabs.onHighlighted

เริ่มทำงานเมื่อแท็บที่ไฮไลต์หรือแท็บที่เลือกในหน้าต่างมีการเปลี่ยนแปลง

พารามิเตอร์

  • Callback

    ฟังก์ชัน

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

    (selectInfo: object) => void

    • selectInfo

      ออบเจ็กต์

      • tabIds

        ตัวเลข[]

        แท็บที่ไฮไลต์ทั้งหมดในหน้าต่าง

      • windowId

        ตัวเลข

        หน้าต่างที่มีการเปลี่ยนแปลงแท็บ

onHighlighted

chrome.tabs.onHighlighted.addListener(
  callback: function,
)

เริ่มทำงานเมื่อแท็บที่ไฮไลต์หรือแท็บที่เลือกในหน้าต่างมีการเปลี่ยนแปลง

พารามิเตอร์

  • Callback

    ฟังก์ชัน

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

    (highlightInfo: object) => void

    • highlightInfo

      ออบเจ็กต์

      • tabIds

        ตัวเลข[]

        แท็บที่ไฮไลต์ทั้งหมดในหน้าต่าง

      • windowId

        ตัวเลข

        หน้าต่างที่มีการเปลี่ยนแปลงแท็บ

onMoved

chrome.tabs.onMoved.addListener(
  callback: function,
)

เริ่มทำงานเมื่อมีการย้ายแท็บภายในหน้าต่าง มีเพียงเหตุการณ์การย้ายเท่านั้นที่เริ่มทำงาน โดยแสดงแท็บที่ผู้ใช้ย้ายโดยตรง เหตุการณ์การย้ายจะไม่เริ่มทำงานสำหรับแท็บอื่นๆ ที่ต้องย้ายไปตามแท็บที่ย้ายด้วยตนเอง เหตุการณ์นี้จะไม่เริ่มทำงานเมื่อมีการย้ายแท็บระหว่างหน้าต่าง ดูรายละเอียดได้ที่ tabs.onDetached

พารามิเตอร์

  • Callback

    ฟังก์ชัน

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

    (tabId: number, moveInfo: object) => void

    • tabId

      ตัวเลข

    • moveInfo

      ออบเจ็กต์

      • fromIndex

        ตัวเลข

      • toIndex

        ตัวเลข

      • windowId

        ตัวเลข

onRemoved

chrome.tabs.onRemoved.addListener(
  callback: function,
)

เริ่มทำงานเมื่อปิดแท็บ

พารามิเตอร์

  • Callback

    ฟังก์ชัน

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

    (tabId: number, removeInfo: object) => void

    • tabId

      ตัวเลข

    • removeInfo

      ออบเจ็กต์

      • isWindowClosing

        boolean

        เป็นจริงเมื่อแท็บถูกปิดเนื่องจากมีการปิดหน้าต่างระดับบนสุด

      • windowId

        ตัวเลข

        หน้าต่างที่แท็บปิดอยู่

onReplaced

chrome.tabs.onReplaced.addListener(
  callback: function,
)

เริ่มทำงานเมื่อมีการแทนที่แท็บด้วยแท็บอื่นเนื่องจากมีการแสดงผลล่วงหน้าหรือทันที

พารามิเตอร์

  • Callback

    ฟังก์ชัน

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

    (addedTabId: number, removedTabId: number) => void

    • addedTabId

      ตัวเลข

    • removedTabId

      ตัวเลข

onSelectionChanged

&amp;leq; MV2 เลิกใช้งานแล้ว
chrome.tabs.onSelectionChanged.addListener(
  callback: function,
)

โปรดใช้ tabs.onActivated

เริ่มทำงานเมื่อแท็บที่เลือกในหน้าต่างมีการเปลี่ยนแปลง

พารามิเตอร์

  • Callback

    ฟังก์ชัน

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

    (tabId: number, selectInfo: object) => void

    • tabId

      ตัวเลข

    • selectInfo

      ออบเจ็กต์

      • windowId

        ตัวเลข

        รหัสของหน้าต่างที่แท็บที่เลือกมีการเปลี่ยนแปลง

onUpdated

chrome.tabs.onUpdated.addListener(
  callback: function,
)

เริ่มทำงานเมื่อมีการอัปเดตแท็บ

พารามิเตอร์

  • Callback

    ฟังก์ชัน

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

    (tabId: number, changeInfo: object, tab: Tab) => void

    • tabId

      ตัวเลข

    • changeInfo

      ออบเจ็กต์

      • audible

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

        Chrome 45 ขึ้นไป

        สถานะเสียงใหม่ของแท็บ

      • autoDiscardable

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

        Chrome 54 ขึ้นไป

        สถานะการยกเลิกบัตรอัตโนมัติใหม่ของแท็บ

      • ทิ้งแล้ว

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

        Chrome 54 ขึ้นไป

        สถานะยกเลิกแบบใหม่ของแท็บ

      • favIconUrl

        string ไม่บังคับ

        URL ไอคอน Fav ใหม่ของแท็บ

      • groupId

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

        Chrome เวอร์ชัน 88 ขึ้นไป

        กลุ่มใหม่ของแท็บ

      • mutedInfo

        MutedInfo ไม่บังคับ

        Chrome 46 ขึ้นไป

        สถานะปิดเสียงใหม่ของแท็บและเหตุผลในการเปลี่ยนแปลง

      • ตรึงอยู่

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

        สถานะการปักหมุดใหม่ของแท็บ

      • สถานะ

        TabStatus ไม่บังคับ

        สถานะการโหลดของแท็บ

      • title

        string ไม่บังคับ

        Chrome 48 ขึ้นไป

        ชื่อใหม่ของแท็บ

      • URL

        string ไม่บังคับ

        URL ของแท็บ หากมีการเปลี่ยนแปลง

    • แท็บ

      แท็บ

onZoomChange

chrome.tabs.onZoomChange.addListener(
  callback: function,
)

เริ่มทำงานเมื่อซูมแท็บ

พารามิเตอร์

  • Callback

    ฟังก์ชัน

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

    (ZoomChangeInfo: object) => void

    • ZoomChangeInfo

      ออบเจ็กต์

      • newZoomFactor

        ตัวเลข

      • oldZoomFactor

        ตัวเลข

      • tabId

        ตัวเลข

      • zoomSettings

        ZoomSettings