chrome.offscreen

คำอธิบาย

สิทธิ์

หากต้องการใช้ Offscreen API ให้ประกาศสิทธิ์ "offscreen" ใน ไฟล์ Manifest ของส่วนขยาย เช่น

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

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

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

Service Worker ไม่มีสิทธิ์เข้าถึง DOM และเว็บไซต์จำนวนมากมีนโยบายความปลอดภัยของเนื้อหาที่จำกัดฟังก์ชันการทำงานของ Content Script Offscreen API ช่วยให้ส่วนขยายใช้ DOM API ในเอกสารที่ซ่อนอยู่ได้โดยไม่ขัดขวางประสบการณ์ของผู้ใช้ด้วยการเปิดหน้าต่างหรือแท็บใหม่ runtime API เป็น API ของส่วนขยายเพียงรายการเดียว ที่เอกสารนอกหน้าจอรองรับ

ระบบจะจัดการหน้าเว็บที่โหลดเป็นเอกสารนอกหน้าจอแตกต่างจากหน้าเว็บประเภทอื่นๆ ของส่วนขยาย สิทธิ์ของส่วนขยายจะมีผลกับเอกสารนอกหน้าจอด้วย แต่มีการจำกัดการเข้าถึง API ของส่วนขยาย ตัวอย่างเช่น เนื่องจาก chrome.runtime API เป็น API ของส่วนขยายเพียงรายการเดียวที่เอกสารนอกหน้าจอรองรับ จึงต้องจัดการการรับส่งข้อความโดยใช้สมาชิกของ API ดังกล่าว

เอกสารนอกหน้าจอมีลักษณะการทำงานแตกต่างจากหน้าเว็บปกติในลักษณะอื่นๆ ดังนี้

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

ใช้ chrome.offscreen.createDocument() และ chrome.offscreen.closeDocument() เพื่อสร้างและปิดเอกสารนอกหน้าจอ createDocument() ต้องใช้ url ของเอกสาร เหตุผล และเหตุผลรองรับ

chrome.offscreen.createDocument({
  url: 'off_screen.html',
  reasons: ['CLIPBOARD'],
  justification: 'reason for needing the document',
});

เหตุผล

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

ตัวอย่าง

รักษาวงจรของเอกสารนอกหน้าจอ

ตัวอย่างต่อไปนี้แสดงวิธีตรวจสอบว่าเอกสารนอกหน้าจอมีอยู่ ฟังก์ชัน setupOffscreenDocument() จะเรียก runtime.getContexts() เพื่อค้นหา เอกสารนอกหน้าจอที่มีอยู่ หรือสร้างเอกสารหากยังไม่มี

let creating; // A global promise to avoid concurrency issues
async function setupOffscreenDocument(path) {
  // Check all windows controlled by the service worker to see if one
  // of them is the offscreen document with the given path
  const offscreenUrl = chrome.runtime.getURL(path);
  const existingContexts = await chrome.runtime.getContexts({
    contextTypes: ['OFFSCREEN_DOCUMENT'],
    documentUrls: [offscreenUrl]
  });

  if (existingContexts.length > 0) {
    return;
  }

  // create offscreen document
  if (creating) {
    await creating;
  } else {
    creating = chrome.offscreen.createDocument({
      url: path,
      reasons: ['CLIPBOARD'],
      justification: 'reason for needing the document',
    });
    await creating;
    creating = null;
  }
}

ก่อนส่งข้อความไปยังเอกสารนอกหน้าจอ ให้เรียก setupOffscreenDocument() เพื่อตรวจสอบว่าเอกสารมีอยู่ ดังที่แสดงในตัวอย่างต่อไปนี้

chrome.action.onClicked.addListener(async () => {
  await setupOffscreenDocument('off_screen.html');

  // Send message to offscreen document
  chrome.runtime.sendMessage({
    type: '...',
    target: 'offscreen',
    data: '...'
  });
});

ดูตัวอย่างฉบับเต็มได้ที่การสาธิต offscreen-clipboard และ offscreen-dom ใน GitHub

ก่อน Chrome 116: ตรวจสอบว่าเอกสารนอกหน้าจอเปิดอยู่หรือไม่

runtime.getContexts() ได้เพิ่มใน Chrome 116 ใน Chrome เวอร์ชันก่อนหน้า ให้ใช้ clients.matchAll() เพื่อตรวจสอบเอกสารนอกหน้าจอที่มีอยู่

async function hasOffscreenDocument() {
  if ('getContexts' in chrome.runtime) {
    const contexts = await chrome.runtime.getContexts({
      contextTypes: ['OFFSCREEN_DOCUMENT'],
      documentUrls: [OFFSCREEN_DOCUMENT_PATH]
    });
    return Boolean(contexts.length);
  } else {
    const matchedClients = await clients.matchAll();
    return matchedClients.some(client => {
      return client.url.includes(chrome.runtime.id);
    });
  }
}

chrome.offscreen.closeDocument(): Promise<void>

chrome.offscreen.createDocument(
  parameters: CreateParameters,
): Promise<void>

chrome.offscreen.hasDocument(): Promise<boolean>