Trang này được dịch bởi Cloud Translation API.

chrome.contextMenus

Mô tả

Sử dụng API chrome.contextMenus để thêm các mục vào trình đơn theo bối cảnh của Google Chrome. Bạn có thể chọn loại đối tượng mà nội dung bổ sung trong trình đơn theo bối cảnh sẽ áp dụng, chẳng hạn như hình ảnh, siêu liên kết và trang.

Quyền

contextMenus

Bạn phải khai báo quyền "contextMenus" trong tệp kê khai của tiện ích để sử dụng API này. Ngoài ra, bạn nên chỉ định một biểu tượng 16 x 16 pixel để hiển thị bên cạnh mục trình đơn. Ví dụ:

{
  "name": "My extension",
  ...
  "permissions": [
    "contextMenus"
  ],
  "icons": {
    "16": "icon-bitty.png",
    "48": "icon-small.png",
    "128": "icon-large.png"
  },
  ...
}

Khái niệm và cách sử dụng

Các mục trong trình đơn theo bối cảnh có thể xuất hiện trong bất kỳ tài liệu nào (hoặc khung trong tài liệu), ngay cả những tài liệu có URL file:// hoặc chrome://. Để kiểm soát những tài liệu mà các mục của bạn có thể xuất hiện, hãy chỉ định trường documentUrlPatterns khi bạn gọi phương thức create() hoặc update().

Bạn có thể tạo bao nhiêu mục trong trình đơn theo bối cảnh tuỳ ý, nhưng nếu có nhiều mục trong tiện ích của bạn xuất hiện cùng lúc, thì Google Chrome sẽ tự động thu gọn các mục đó thành một trình đơn mẹ duy nhất.

Ví dụ

Để dùng thử API này, hãy cài đặt ví dụ về contextMenus API trong kho lưu trữ chrome-extension-samples.

Loại

ContextType

Chrome 44 trở lên

Các bối cảnh khác nhau mà trình đơn có thể xuất hiện. Việc chỉ định "all" tương đương với việc kết hợp tất cả các ngữ cảnh khác, ngoại trừ "launcher". Bối cảnh "trình chạy" chỉ được các ứng dụng hỗ trợ và được dùng để thêm các mục vào trình đơn theo bối cảnh xuất hiện khi nhấp vào biểu tượng ứng dụng trong trình chạy/thanh tác vụ/thanh công cụ/v.v. Các nền tảng khác nhau có thể đặt ra những hạn chế đối với nội dung thực sự được hỗ trợ trong trình đơn theo bối cảnh của trình chạy.

Enum

"tất cả"

"page"

"frame"

"selection"

"link"

"editable"

"image"

"video"

"audio"

"launcher"

"browser_action"

"page_action"

"action"

CreateProperties

Chrome 123 trở lên

Các thuộc tính của mục mới trong trình đơn ngữ cảnh.

Thuộc tính

đã chọn

boolean không bắt buộc

Trạng thái ban đầu của hộp đánh dấu hoặc nút chọn: true cho trạng thái đã chọn, false cho trạng thái chưa chọn. Mỗi lần, bạn chỉ có thể chọn một nút chọn trong một nhóm nhất định.
bối cảnh

[ContextType, ...ContextType[]] không bắt buộc

Danh sách các bối cảnh mà mục trong trình đơn này sẽ xuất hiện. Giá trị mặc định là ['page'].
documentUrlPatterns

string[] không bắt buộc

Hạn chế mục chỉ áp dụng cho những tài liệu hoặc khung có URL khớp với một trong các mẫu đã cho. Để biết thông tin chi tiết về định dạng mẫu, hãy xem bài viết Mẫu so khớp.
đang bật

boolean không bắt buộc

Mục trình đơn ngữ cảnh này được bật hay tắt. Giá trị mặc định là true.
id

chuỗi không bắt buộc

Mã nhận dạng duy nhất để chỉ định cho mặt hàng này. Bắt buộc đối với các trang sự kiện. Không được trùng với một mã nhận dạng khác cho tiện ích này.
parentId

string | number không bắt buộc

Mã nhận dạng của một mục trong trình đơn mẹ; mã này sẽ biến mục đó thành mục con của một mục đã thêm trước đó.
targetUrlPatterns

string[] không bắt buộc

Tương tự như documentUrlPatterns, các bộ lọc dựa trên thuộc tính src của thẻ img, audio và video cũng như thuộc tính href của thẻ a.
tiêu đề

chuỗi không bắt buộc

Văn bản sẽ hiển thị trong mục; đây là thông tin bắt buộc, trừ phi type là separator. Khi ngữ cảnh là selection, hãy dùng %s trong chuỗi để hiện văn bản đã chọn. Ví dụ: nếu giá trị của tham số này là "Dịch "%s" sang tiếng Lợn" và người dùng chọn từ "cool", thì mục trong trình đơn theo bối cảnh cho lựa chọn này là "Dịch "cool" sang tiếng Lợn".
loại

ItemType không bắt buộc

Loại mục trong trình đơn. Giá trị mặc định là normal.
hiển thị

boolean không bắt buộc

Mục đó có xuất hiện trong trình đơn hay không.
onclick

void optional

Một hàm được gọi lại khi người dùng nhấp vào mục trong trình đơn. Không thể dùng phương thức này trong trình chạy dịch vụ. Thay vào đó, bạn nên đăng ký một trình nghe cho contextMenus.onClicked.

Hàm onclick có dạng như sau:
```
(info: OnClickData, tab: Tab) => {...}
```
- info
  
  OnClickData
  
  Thông tin về mặt hàng được nhấp vào và bối cảnh xảy ra lượt nhấp.
- phím tab
  
  Thẻ
  
  Thông tin chi tiết về thẻ nơi xảy ra lượt nhấp. Thông số này không có trong các ứng dụng nền tảng.

ItemType

Chrome 44 trở lên

Loại mục trong trình đơn.

Enum

"normal"

"checkbox"

"radio"

"separator"

OnClickData

Thông tin được gửi khi một mục trong trình đơn theo bối cảnh được nhấp vào.

Thuộc tính

đã chọn

boolean không bắt buộc

Cờ cho biết trạng thái của hộp đánh dấu hoặc mục chọn sau khi được nhấp vào.
có thể chỉnh sửa

boolean

Cờ cho biết liệu phần tử có thể chỉnh sửa hay không (nhập văn bản, vùng văn bản, v.v.).
frameId

number không bắt buộc

Chrome 51 trở lên

Mã nhận dạng của khung của phần tử nơi người dùng nhấp vào trình đơn theo bối cảnh, nếu phần tử đó nằm trong một khung.
frameUrl

chuỗi không bắt buộc

URL của khung của phần tử mà người dùng nhấp vào trình đơn theo bối cảnh, nếu phần tử đó nằm trong một khung.
linkUrl

chuỗi không bắt buộc

Nếu phần tử là một đường liên kết, thì đây là URL mà phần tử đó trỏ đến.
mediaType

chuỗi không bắt buộc

Một trong các giá trị "image", "video" hoặc "audio" nếu trình đơn theo bối cảnh được kích hoạt trên một trong các loại phần tử này.
menuItemId

chuỗi | số

Mã của mục trong trình đơn mà người dùng đã nhấp vào.
pageUrl

chuỗi không bắt buộc

URL của trang mà người dùng đã nhấp vào mục trong trình đơn. Thuộc tính này không được đặt nếu lượt nhấp xảy ra trong một bối cảnh không có trang hiện tại, chẳng hạn như trong trình đơn theo bối cảnh của trình chạy.
parentMenuItemId

string | number không bắt buộc

Mã nhận dạng gốc (nếu có) của mặt hàng được nhấp vào.
selectionText

chuỗi không bắt buộc

Văn bản cho lựa chọn theo bối cảnh (nếu có).
srcUrl

chuỗi không bắt buộc

Sẽ xuất hiện cho các phần tử có URL "src".
wasChecked

boolean không bắt buộc

Cờ cho biết trạng thái của hộp đánh dấu hoặc mục chọn trước khi được nhấp vào.

Thuộc tính

ACTION_MENU_TOP_LEVEL_LIMIT

Số lượng tối đa các mục tiện ích cấp cao nhất có thể được thêm vào trình đơn theo bối cảnh của hành động trên tiện ích. Mọi mặt hàng vượt quá hạn mức này sẽ bị bỏ qua.

Giá trị

Phương thức

create()

chrome.contextMenus.create(
  createProperties: CreateProperties,
  callback?: function,
): number | string

Tạo một mục mới trong trình đơn ngữ cảnh. Nếu xảy ra lỗi trong quá trình tạo, lỗi đó có thể không được phát hiện cho đến khi lệnh gọi lại tạo kích hoạt; thông tin chi tiết sẽ có trong runtime.lastError.

Thông số

createProperties

CreateProperties
callback

hàm không bắt buộc

Tham số callback có dạng như sau:
```
() => void
```

Giá trị trả về

number | string

Mã nhận dạng của mặt hàng mới tạo.

remove()

chrome.contextMenus.remove(
  menuItemId: string | number,
): Promise<void>

Xoá một mục trong trình đơn theo bối cảnh.

Thông số

menuItemId

chuỗi | số

Mã của mục trong trình đơn theo bối cảnh cần xoá.

Giá trị trả về

Promise<void>

Chrome 123 trở lên

removeAll()

chrome.contextMenus.removeAll(): Promise<void>

Xoá tất cả các mục trong trình đơn theo bối cảnh do tiện ích này thêm vào.

Giá trị trả về

Promise<void>

Chrome 123 trở lên

update()

chrome.contextMenus.update(
  id: string | number,
  updateProperties: object,
): Promise<void>

Cập nhật một mục trong trình đơn theo bối cảnh đã tạo trước đó.

Thông số

id

chuỗi | số

Mã nhận dạng của mặt hàng cần cập nhật.
updateProperties

đối tượng

Các thuộc tính cần cập nhật. Chấp nhận các giá trị giống như hàm contextMenus.create.
- đã chọn
  
  boolean không bắt buộc
- bối cảnh
  
  [ContextType, ...ContextType[]] không bắt buộc
- documentUrlPatterns
  
  string[] không bắt buộc
- đang bật
  
  boolean không bắt buộc
- parentId
  
  string | number không bắt buộc
  
  Mã nhận dạng của mặt hàng sẽ trở thành mặt hàng mẹ của mặt hàng này. Lưu ý: Bạn không thể đặt một mục làm mục con của chính mục đó.
- targetUrlPatterns
  
  string[] không bắt buộc
- tiêu đề
  
  chuỗi không bắt buộc
- loại
  
  ItemType không bắt buộc
- hiển thị
  
  boolean không bắt buộc
  
  Chrome 62 trở lên
  
  Mục đó có xuất hiện trong trình đơn hay không.
- onclick
  
  void optional
  
  Hàm onclick có dạng như sau:
```
(info: OnClickData, tab: Tab) => {...}
```
  - info
    
    OnClickData
    
    Chrome 44 trở lên
  - phím tab
    
    Thẻ
    
    Chrome 44 trở lên
    
    Thông tin chi tiết về thẻ nơi xảy ra lượt nhấp. Thông số này không có trong các ứng dụng nền tảng.

Giá trị trả về

Promise<void>

Chrome 123 trở lên

Sự kiện

onClicked

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

Được kích hoạt khi người dùng nhấp vào một mục trong trình đơn theo bối cảnh.

Thông số

callback

hàm

Tham số callback có dạng như sau:
```
(info: OnClickData, tab?: tabs.Tab) => void
```
- info
  
  OnClickData
- phím tab
  
  tabs.Tab không bắt buộc

chrome.contextMenus Sử dụng bộ sưu tập để sắp xếp ngăn nắp các trang Lưu và phân loại nội dung dựa trên lựa chọn ưu tiên của bạn.

Mô tả

Quyền

Khái niệm và cách sử dụng

Ví dụ

Loại

ContextType

Enum

CreateProperties

Thuộc tính

ItemType

Enum

OnClickData

Thuộc tính

Thuộc tính

ACTION_MENU_TOP_LEVEL_LIMIT

Giá trị

Phương thức

create()

Thông số

Giá trị trả về

remove()

Thông số

Giá trị trả về

removeAll()

Giá trị trả về

update()

Thông số

Giá trị trả về

Sự kiện

onClicked

Thông số

chrome.contextMenus