Deskripsi
Gunakan chrome.contextMenus
API untuk menambahkan item ke menu konteks Google Chrome. Anda dapat memilih jenis objek yang akan diterapkan dengan penambahan menu konteks, seperti gambar, hyperlink, dan halaman.
Izin
contextMenus
Penggunaan
Item menu konteks dapat muncul di dokumen apa pun (atau bingkai dalam dokumen), bahkan item dengan URL file:// atau chrome://. Untuk mengontrol dokumen mana yang dapat menampilkan item Anda, tentukan kolom documentUrlPatterns saat Anda memanggil metode create()
atau update()
.
Anda dapat membuat item menu konteks sebanyak yang dibutuhkan. Namun, jika lebih dari satu item dari ekstensi Anda terlihat sekaligus, Google Chrome akan otomatis menciutkannya menjadi satu menu induk.
Manifes
Anda harus mendeklarasikan izin "contextMenus" dalam manifes ekstensi Anda untuk menggunakan API. Selain itu, Anda harus menentukan ikon 16x16 piksel untuk ditampilkan di samping item menu. Contoh:
{
"name": "My extension",
...
"permissions": [
"contextMenus"
],
"icons": {
"16": "icon-bitty.png",
"48": "icon-small.png",
"128": "icon-large.png"
},
...
}
Contoh
Untuk mencoba API ini, instal contoh contextMenus API dari repositori chrome-extension-samples.
Jenis
ContextType
Berbagai konteks yang dapat menampilkan menu. Menentukan 'all' setara dengan kombinasi semua konteks lainnya kecuali untuk 'launcher'. Konteks 'peluncur' hanya didukung oleh aplikasi dan digunakan untuk menambahkan item menu ke menu konteks yang muncul saat mengklik ikon aplikasi di peluncur/taskbar/dock/dll. Platform yang berbeda mungkin membatasi apa yang sebenarnya didukung dalam menu konteks peluncur.
Enum
"selection"
"link"
"video"
"audio"
"browser_action"
"page_action"
CreateProperties
Properti item menu konteks baru.
Properti
-
dicentang
boolean opsional
Status awal kotak centang atau tombol pilihan:
true
untuk dipilih,false
untuk tidak dipilih. Hanya satu tombol pilihan yang dapat dipilih pada satu waktu di grup tertentu. -
konteks
[ContextType, ...ContextType[]] opsional
Daftar konteks akan menampilkan item menu ini. Default-nya adalah
['page']
. -
documentUrlPatterns
string[] opsional
Membatasi item agar hanya diterapkan pada dokumen atau bingkai yang URL-nya cocok dengan salah satu pola yang ditentukan. Untuk mengetahui detail tentang format pola, lihat Pencocokan Pola.
-
diaktifkan
boolean opsional
Apakah item menu konteks ini diaktifkan atau dinonaktifkan. Default-nya adalah
true
. -
id
string opsional
ID unik yang akan ditetapkan ke item ini. Wajib untuk halaman acara. Tidak boleh sama dengan ID lain untuk ekstensi ini.
-
parentId
string | number opsional
ID item menu induk; ini membuat item menjadi turunan dari item yang ditambahkan sebelumnya.
-
targetUrlPatterns
string[] opsional
Serupa dengan
documentUrlPatterns
, filter berdasarkan atributsrc
dari tagimg
,audio
, danvideo
serta atributhref
dari taga
. -
title
string opsional
Teks yang akan ditampilkan dalam item; ini wajib, kecuali jika
type
adalahseparator
. Jika konteksnya adalahselection
, gunakan%s
dalam string untuk menampilkan teks yang dipilih. Misalnya, jika nilai parameter ini adalah "Translate '%s' to Pig Latin" dan pengguna memilih kata "cool", item menu konteks untuk pilihan tersebut adalah "Translate 'cool' to Pig Latin". -
tipe
ItemType opsional
Jenis item menu. Default-nya adalah
normal
. -
terlihat
boolean opsional
Apakah item terlihat di menu.
-
onclick
membatalkan opsional
Fungsi yang dipanggil kembali saat item menu diklik. Ini tidak tersedia di dalam pekerja layanan; sebagai gantinya, Anda harus mendaftarkan pemroses untuk
contextMenus.onClicked
.Fungsi
onclick
terlihat seperti:(info: OnClickData, tab: Tab) => {...}
-
info
Informasi tentang item yang diklik dan konteks tempat klik terjadi.
-
Subscription
Detail tab tempat klik terjadi. Parameter ini tidak ada untuk aplikasi platform.
-
ItemType
Jenis item menu.
Enum
"normal"
"radio"
OnClickData
Informasi yang dikirim saat item menu konteks diklik.
Properti
-
dicentang
boolean opsional
Tanda yang menunjukkan status kotak centang atau item radio setelah diklik.
-
dapat diedit
boolean
Flag yang menunjukkan apakah elemen dapat diedit (text input, textarea, dll.).
-
frameId
nomor opsional
Chrome 51+ID frame elemen tempat menu konteks diklik, jika berada dalam frame.
-
frameUrl
string opsional
URL frame elemen tempat menu konteks diklik, jika berada dalam frame.
-
linkUrl
string opsional
Jika elemen adalah link, URL yang dituju oleh elemen tersebut.
-
mediaType
string opsional
Salah satu dari 'gambar', 'video', atau 'audio' jika menu konteks diaktifkan pada salah satu jenis elemen ini.
-
string | angka
ID item menu yang diklik.
-
pageUrl
string opsional
URL halaman tempat item menu diklik. Properti ini tidak ditetapkan jika klik terjadi dalam konteks tempat tidak ada halaman saat ini, seperti di menu konteks peluncur.
-
parentMenuItemId
string | number opsional
ID induk, jika ada, untuk item yang diklik.
-
selectionText
string opsional
Teks untuk pemilihan konteks, jika ada.
-
srcUrl
string opsional
Akan ada untuk elemen dengan URL 'src'.
-
wasChecked
boolean opsional
Tanda yang menunjukkan status kotak centang atau item radio sebelum diklik.
Properti
ACTION_MENU_TOP_LEVEL_LIMIT
Jumlah maksimum item ekstensi tingkat teratas yang dapat ditambahkan ke menu konteks tindakan ekstensi. Item apa pun yang melebihi batas ini akan diabaikan.
Nilai
6
Metode
create()
chrome.contextMenus.create(
createProperties: CreateProperties,
callback?: function,
)
Membuat item menu konteks baru. Jika terjadi selama pembuatan, error tersebut mungkin tidak akan terdeteksi hingga callback pembuatan diaktifkan. Detailnya akan ada di runtime.lastError
.
Parameter
-
createProperties
-
callback
fungsi opsional
Parameter
callback
terlihat seperti:() => void
Hasil
-
angka | string
ID item yang baru dibuat.
remove()
chrome.contextMenus.remove(
menuItemId: string | number,
callback?: function,
)
Menghapus item menu konteks.
Parameter
-
string | angka
ID item menu konteks yang akan dihapus.
-
callback
fungsi opsional
Parameter
callback
terlihat seperti:() => void
Hasil
-
Promise<void>
Chrome 123 dan yang lebih baruPromise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.
removeAll()
chrome.contextMenus.removeAll(
callback?: function,
)
Menghapus semua item menu konteks yang ditambahkan oleh ekstensi ini.
Parameter
-
callback
fungsi opsional
Parameter
callback
terlihat seperti:() => void
Hasil
-
Promise<void>
Chrome 123 dan yang lebih baruPromise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.
update()
chrome.contextMenus.update(
id: string | number,
updateProperties: object,
callback?: function,
)
Memperbarui item menu konteks yang dibuat sebelumnya.
Parameter
-
id
string | angka
ID item yang akan diperbarui.
-
updateProperties
objek
Properti yang akan diperbarui. Menerima nilai yang sama dengan fungsi
contextMenus.create
.-
dicentang
boolean opsional
-
konteks
[ContextType, ...ContextType[]] opsional
-
documentUrlPatterns
string[] opsional
-
diaktifkan
boolean opsional
-
parentId
string | number opsional
ID item yang akan dibuat sebagai induk item ini. Catatan: Anda tidak dapat menetapkan item untuk menjadi turunan dari turunannya sendiri.
-
targetUrlPatterns
string[] opsional
-
title
string opsional
-
tipe
ItemType opsional
-
terlihat
boolean opsional
Chrome 62 dan yang lebih baruApakah item terlihat di menu.
-
onclick
membatalkan opsional
Fungsi
onclick
terlihat seperti:(info: OnClickData, tab: Tab) => {...}
-
infoChrome 44+
-
SubscriptionChrome 44+
Detail tab tempat klik terjadi. Parameter ini tidak ada untuk aplikasi platform.
-
-
-
callback
fungsi opsional
Parameter
callback
terlihat seperti:() => void
Hasil
-
Promise<void>
Chrome 123 dan yang lebih baruPromise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.
Acara
onClicked
chrome.contextMenus.onClicked.addListener(
callback: function,
)
Diaktifkan saat item menu konteks diklik.
Parameter
-
callback
fungsi
Parameter
callback
terlihat seperti:(info: OnClickData, tab?: tabs.Tab) => void
-
info
-
Subscription
tabs.Tab opsional
-