chrome.app.window

Mô tả

Dùng API chrome.app.window để tạo cửa sổ. Cửa sổ có khung tuỳ chọn với thanh tiêu đề và các chế độ kiểm soát kích thước. Các tài khoản này không liên kết với bất kỳ cửa sổ trình duyệt Chrome nào. Xem Mẫu trạng thái cửa sổ để biết minh hoạ về các tuỳ chọn này.

Loại

AppWindow

Thuộc tính

  • contentWindow

    Cửa sổ

    "Cửa sổ" JavaScript cho đối tượng con đã tạo.

  • id

    string

    Mã nhận dạng cho cửa sổ được tạo.

  • innerBounds

    Vị trí, kích thước và các điểm hạn chế của nội dung cửa sổ, không bao gồm đồ trang trí cửa sổ. Thuộc tính này là tính năng mới trong Chrome 36.

  • outerBounds

    Vị trí, kích thước và các điều kiện ràng buộc của cửa sổ, bao gồm cả đồ trang trí cửa sổ, chẳng hạn như thanh tiêu đề và khung. Thuộc tính này là tính năng mới trong Chrome 36.

  • clearAttention

    void

    Thu hút sự chú ý rõ ràng vào cửa sổ.

    Hàm clearAttention có dạng như sau:

    () => {...}

  • đóng

    void

    Đóng cửa sổ.

    Hàm close có dạng như sau:

    () => {...}

  • drawAttention

    void

    Thu hút sự chú ý vào cửa sổ.

    Hàm drawAttention có dạng như sau:

    () => {...}

  • tiêu điểm

    void

    Lấy tiêu điểm là cửa sổ.

    Hàm focus có dạng như sau:

    () => {...}

  • toàn màn hình

    void

    Toàn màn hình cửa sổ.

    Người dùng có thể khôi phục cửa sổ bằng cách nhấn ESC. Ứng dụng có thể ngăn giữ lại trạng thái toàn màn hình khi nhấn ESC bằng cách yêu cầu quyền app.window.fullscreen.overrideEsc và huỷ sự kiện bằng cách gọi .preventDefault(), trong trình xử lý keydown và keyup như sau:

    window.onkeydown = window.onkeyup = function(e) { if (e.keyCode == 27 /* ESC *\/) { e.preventDefault(); } };

    Lưu ý: window.fullscreen() sẽ chuyển toàn bộ cửa sổ sang chế độ toàn màn hình và không cần người dùng thực hiện cử chỉ. API toàn màn hình của HTML5 cũng có thể được dùng để vào chế độ toàn màn hình (xem API web để biết thêm chi tiết).

    Hàm fullscreen có dạng như sau:

    () => {...}

  • getBounds

    void

    Không dùng nữa

    Sử dụng internalBounds (Ranh giới bên trong).

    Lấy ranh giới bên trong của cửa sổ dưới dạng đối tượng ContentBounds.

    Hàm getBounds có dạng như sau:

    () => {...}

  • ẩn

    void

    Ẩn cửa sổ này. Không làm gì cả nếu cửa sổ đã bị ẩn.

    Hàm hide có dạng như sau:

    () => {...}

  • isAlwaysOnTop

    void

    Có phải cửa sổ luôn ở trên cùng không?

    Hàm isAlwaysOnTop có dạng như sau:

    () => {...}

    • returns

      boolean

  • isFullscreen

    void

    Cửa sổ có ở chế độ toàn màn hình không? Điều này cũng đúng nếu cửa sổ được tạo ở chế độ toàn màn hình hoặc được đặt ở chế độ toàn màn hình thông qua API toàn màn hình AppWindow hoặc HTML5.

    Hàm isFullscreen có dạng như sau:

    () => {...}

    • returns

      boolean

  • isMaximized

    void

    Cửa sổ có đang ở phóng to không?

    Hàm isMaximized có dạng như sau:

    () => {...}

    • returns

      boolean

  • isMinimized

    void

    Cửa sổ có được thu nhỏ không?

    Hàm isMinimized có dạng như sau:

    () => {...}

    • returns

      boolean

  • tối đa hoá

    void

    Phóng to cửa sổ.

    Hàm maximize có dạng như sau:

    () => {...}

  • thu nhỏ

    void

    Thu nhỏ cửa sổ.

    Hàm minimize có dạng như sau:

    () => {...}

  • moveTo

    void

    Không được dùng nữa kể từ Chrome 43

    Sử dụng externalBounds.

    Di chuyển cửa sổ đến vị trí (left, top).

    Hàm moveTo có dạng như sau:

    (left: number, top: number) => {...}

    • trái

      số

    • trên cùng

      số

  • resizeTo

    void

    Không được dùng nữa kể từ Chrome 43

    Sử dụng externalBounds.

    Đổi kích thước cửa sổ thành kích thước widthxheight pixel.

    Hàm resizeTo có dạng như sau:

    (width: number, height: number) => {...}

    • chiều rộng

      số

    • độ cao

      số

  • khôi phục

    void

    Khôi phục cửa sổ, thoát khỏi trạng thái phóng to, thu nhỏ hoặc toàn màn hình.

    Hàm restore có dạng như sau:

    () => {...}

  • setAlwaysOnTop

    void

    Đặt xem có nên để cửa sổ phía trên hầu hết các cửa sổ khác hay không. Cần có quyền alwaysOnTopWindows.

    Hàm setAlwaysOnTop có dạng như sau:

    (alwaysOnTop: boolean) => {...}

    • alwaysOnTop

      boolean

  • setBounds

    void

    Không dùng nữa

    Sử dụng internalBounds (Ranh giới bên trong).

    Đặt ranh giới bên trong của cửa sổ.

    Hàm setBounds có dạng như sau:

    (bounds: ContentBounds) => {...}

  • setVisibleOnAllWorkspaces

    void

    Đặt xem cửa sổ có hiển thị trên tất cả các không gian làm việc hay không. (Chỉ dành cho các nền tảng hỗ trợ việc này).

    Hàm setVisibleOnAllWorkspaces có dạng như sau:

    (alwaysVisible: boolean) => {...}

    • alwaysVisible

      boolean

  • hiện (lên)/cho thấy

    void

    Hiển thị cửa sổ. Không làm gì nếu cửa sổ đã hiển thị. Lấy tiêu điểm cửa sổ nếu bạn đặt focused thành true hoặc bỏ qua.

    Hàm show có dạng như sau:

    (focused?: boolean) => {...}

    • tập trung

      boolean không bắt buộc

Bounds

Thuộc tính

  • độ cao

    số

    Thuộc tính này có thể dùng để đọc hoặc ghi chiều cao hiện tại của nội dung hoặc cửa sổ.

  • trái

    số

    Bạn có thể dùng thuộc tính này để đọc hoặc ghi toạ độ X hiện tại của nội dung hoặc cửa sổ.

  • maxHeight

    số không bắt buộc

    Bạn có thể dùng thuộc tính này để đọc hoặc ghi chiều cao tối đa hiện tại của nội dung hoặc cửa sổ. Giá trị null cho biết "un chỉ định".

  • maxWidth

    số không bắt buộc

    Bạn có thể dùng thuộc tính này để đọc hoặc ghi chiều rộng tối đa hiện tại của nội dung hoặc cửa sổ. Giá trị null cho biết "un chỉ định".

  • minHeight

    số không bắt buộc

    Bạn có thể dùng thuộc tính này để đọc hoặc ghi chiều cao tối thiểu hiện tại của nội dung hoặc cửa sổ. Giá trị null cho biết "un chỉ định".

  • minWidth

    số không bắt buộc

    Bạn có thể dùng thuộc tính này để đọc hoặc ghi chiều rộng tối thiểu hiện tại của nội dung hoặc cửa sổ. Giá trị null cho biết "un chỉ định".

  • trên cùng

    số

    Bạn có thể dùng thuộc tính này để đọc hoặc ghi toạ độ Y hiện tại của nội dung hoặc cửa sổ.

  • chiều rộng

    số

    Thuộc tính này có thể dùng để đọc hoặc ghi chiều rộng hiện tại của nội dung hoặc cửa sổ.

  • setMaximumSize

    void

    Đặt giới hạn kích thước tối đa của nội dung hoặc cửa sổ. Bạn có thể đặt chiều rộng hoặc chiều cao tối đa thành null để xoá quy tắc ràng buộc. Giá trị của undefined sẽ không thay đổi một quy tắc ràng buộc.

    Hàm setMaximumSize có dạng như sau:

    (maxWidth: number, maxHeight: number) => {...}

    • maxWidth

      số

    • maxHeight

      số

  • setMinimumSize

    void

    Đặt giới hạn kích thước tối thiểu của nội dung hoặc cửa sổ. Bạn có thể đặt chiều rộng hoặc chiều cao tối thiểu thành null để xoá quy tắc ràng buộc. Giá trị của undefined sẽ không thay đổi một quy tắc ràng buộc.

    Hàm setMinimumSize có dạng như sau:

    (minWidth: number, minHeight: number) => {...}

    • minWidth

      số

    • minHeight

      số

  • setPosition

    void

    Đặt vị trí bên trái và trên cùng của nội dung hoặc cửa sổ.

    Hàm setPosition có dạng như sau:

    (left: number, top: number) => {...}

    • trái

      số

    • trên cùng

      số

  • setSize

    void

    Đặt chiều rộng và chiều cao của nội dung hoặc cửa sổ.

    Hàm setSize có dạng như sau:

    (width: number, height: number) => {...}

    • chiều rộng

      số

    • độ cao

      số

BoundsSpecification

Thuộc tính

  • độ cao

    số không bắt buộc

    Chiều cao của nội dung hoặc cửa sổ.

  • trái

    số không bắt buộc

    Toạ độ X của nội dung hoặc cửa sổ.

  • maxHeight

    số không bắt buộc

    Chiều cao tối đa của nội dung hoặc cửa sổ.

  • maxWidth

    số không bắt buộc

    Chiều rộng tối đa của nội dung hoặc cửa sổ.

  • minHeight

    số không bắt buộc

    Chiều cao tối thiểu của nội dung hoặc cửa sổ.

  • minWidth

    số không bắt buộc

    Chiều rộng tối thiểu của nội dung hoặc cửa sổ.

  • trên cùng

    số không bắt buộc

    Toạ độ Y của nội dung hoặc cửa sổ.

  • chiều rộng

    số không bắt buộc

    Chiều rộng của nội dung hoặc cửa sổ.

ContentBounds

Thuộc tính

  • độ cao

    số không bắt buộc

  • trái

    số không bắt buộc

  • trên cùng

    số không bắt buộc

  • chiều rộng

    số không bắt buộc

CreateWindowOptions

Thuộc tính

  • alwaysOnTop

    boolean không bắt buộc

    Nếu đặt là true, cửa sổ này sẽ ở phía trên hầu hết các cửa sổ khác. Nếu có nhiều cửa sổ thuộc loại này, cửa sổ đang được lấy tiêu điểm sẽ nằm ở nền trước. Cần có quyền alwaysOnTopWindows. Giá trị mặc định là false.

    Gọi setAlwaysOnTop() trên cửa sổ để thay đổi thuộc tính này sau khi tạo.

  • ranh giới

    ContentBounds không bắt buộc

    Không dùng nữa

    Sử dụng internalBounds (Ranh giới bên trong).

    Kích thước và vị trí của nội dung trong cửa sổ (không bao gồm thanh tiêu đề). Nếu một mã nhận dạng cũng được chỉ định và một cửa sổ có mã nhận dạng trùng khớp đã hiển thị trước đó, thì các giới hạn đã ghi nhớ của cửa sổ đó sẽ được sử dụng.

  • tập trung

    boolean không bắt buộc

    Nếu đặt là true, cửa sổ sẽ được lấy làm tiêu điểm khi được tạo. Giá trị mặc định là đúng.

  • khung

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

    Loại khung hình: none hoặc chrome (mặc định là chrome). Đối với none, bạn có thể sử dụng thuộc tính CSS -webkit-app-region để áp dụng khả năng kéo cho cửa sổ của ứng dụng. Bạn có thể sử dụng -webkit-app-region: drag để đánh dấu các khu vực có thể kéo. Bạn có thể dùng no-drag để vô hiệu hoá kiểu này trên các phần tử lồng nhau.

    FrameOptions là hoạt động mới được sử dụng trong M36.

  • ẩn

    boolean không bắt buộc

    Nếu đặt là true, cửa sổ sẽ được tạo ở trạng thái ẩn. Gọi show() trên cửa sổ để hiển thị sau khi tạo. Giá trị mặc định là false.

  • biểu tượng

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

    Chrome 54 trở lên

    URL của biểu tượng cửa sổ. Một cửa sổ có thể có biểu tượng riêng khi showInShelf được đặt thành true. URL đó phải là URL chung hoặc URL cục bộ của tiện ích.

  • id

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

    Mã nhận dạng để xác định cửa sổ. Tham số này sẽ được sử dụng để ghi nhớ kích thước và vị trí của cửa sổ và khôi phục hình học đó khi cửa sổ có cùng id được mở sau đó. Nếu một cửa sổ có mã nhận dạng nhất định được tạo trong khi đã tồn tại một cửa sổ khác có cùng mã nhận dạng đó, thì cửa sổ hiện đang mở sẽ được lấy tiêu điểm thay vì tạo một cửa sổ mới.

  • innerBounds

    BoundsSpecification không bắt buộc

    Dùng để chỉ định vị trí ban đầu, kích thước ban đầu và các điều kiện ràng buộc đối với nội dung cửa sổ (không bao gồm trang trí cửa sổ). Nếu id cũng được chỉ định và một cửa sổ có id phù hợp đã hiển thị trước đó, thì các giới hạn đã ghi nhớ sẽ được sử dụng.

    Lưu ý: Khoảng đệm giữa giới hạn trong và giới hạn ngoài là do hệ điều hành xác định. Do đó, việc đặt cùng một thuộc tính giới hạn cho cả innerBoundsouterBounds sẽ dẫn đến lỗi.

    Thuộc tính này là tính năng mới trong Chrome 36.

  • maxHeight

    số không bắt buộc

    Không dùng nữa

    Sử dụng internalBounds (Ranh giới bên trong).

    Chiều cao tối đa của cửa sổ.

  • maxWidth

    số không bắt buộc

    Không dùng nữa

    Sử dụng internalBounds (Ranh giới bên trong).

    Chiều rộng tối đa của cửa sổ.

  • minHeight

    số không bắt buộc

    Không dùng nữa

    Sử dụng internalBounds (Ranh giới bên trong).

    Chiều cao tối thiểu của cửa sổ.

  • minWidth

    số không bắt buộc

    Không dùng nữa

    Sử dụng internalBounds (Ranh giới bên trong).

    Chiều rộng tối thiểu của cửa sổ.

  • outerBounds

    BoundsSpecification không bắt buộc

    Dùng để chỉ định vị trí ban đầu, kích thước ban đầu và các điều kiện ràng buộc của cửa sổ (bao gồm cả trang trí cửa sổ như thanh tiêu đề và khung). Nếu id cũng được chỉ định và một cửa sổ có id phù hợp đã hiển thị trước đó, thì các giới hạn đã ghi nhớ sẽ được sử dụng.

    Lưu ý: Khoảng đệm giữa giới hạn trong và giới hạn ngoài là do hệ điều hành xác định. Do đó, việc đặt cùng một thuộc tính giới hạn cho cả innerBoundsouterBounds sẽ dẫn đến lỗi.

    Thuộc tính này là tính năng mới trong Chrome 36.

  • có thể đổi kích thước

    boolean không bắt buộc

    Nếu đặt là true, người dùng sẽ có thể đổi kích thước cửa sổ. Giá trị mặc định là đúng.

  • showInShelf

    boolean không bắt buộc

    Chrome 54 trở lên

    Nếu đặt là true, cửa sổ sẽ có biểu tượng kệ riêng. Nếu không, cửa sổ đó sẽ được nhóm trong kệ với các cửa sổ khác được liên kết với ứng dụng. Giá trị mặc định là false. Nếu showInShelf được đặt thành true, bạn cần chỉ định mã nhận dạng cho cửa sổ.

  • singleton

    boolean không bắt buộc

    Không dùng nữa

    Nhiều cửa sổ có cùng mã không còn được hỗ trợ nữa.

    Theo mặc định, nếu bạn chỉ định id cho cửa sổ, cửa sổ sẽ chỉ được tạo nếu chưa tồn tại một cửa sổ khác có cùng id. Nếu đã tồn tại một cửa sổ có cùng mã thì cửa sổ đó sẽ được kích hoạt. Nếu muốn tạo nhiều cửa sổ có cùng một mã, bạn có thể đặt thuộc tính này thành false.

  • tiểu bang

    Tiểu bang không bắt buộc

    Trạng thái ban đầu của cửa sổ, cho phép tạo cửa sổ ở chế độ toàn màn hình, phóng to hoặc thu nhỏ. Giá trị mặc định là "bình thường".

  • loại

    WindowType không bắt buộc

    Chrome 45 trở lên Không dùng nữa kể từ Chrome 69

    Tất cả cửa sổ ứng dụng đều sử dụng "shell" loại cửa sổ

    Loại cửa sổ cần tạo.

  • visibleOnAllWorkspaces

    boolean không bắt buộc

    Nếu là true và được nền tảng hỗ trợ, cửa sổ này sẽ hiển thị trên tất cả các không gian làm việc.

FrameOptions

Thuộc tính

  • activeColor

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

    Cho phép đặt màu khung của cửa sổ khi đang hoạt động. Bạn chỉ dùng được màu khung nếu loại khung là chrome.

    Bạn chỉ dùng được màu khung nếu loại khung là chrome.

    Tính năng tô màu khung hình là tính năng mới trong Chrome 36.

  • màu

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

    Cho phép đặt màu khung. Bạn chỉ dùng được màu khung nếu loại khung là chrome.

    Tính năng tô màu khung hình là tính năng mới trong Chrome 36.

  • inactiveColor

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

    Cho phép đặt màu khung của cửa sổ khi không hoạt động khác với màu đang hoạt động. Bạn chỉ dùng được màu khung nếu loại khung là chrome.

    Bạn phải sử dụng inactiveColor cùng với color.

    Tính năng tô màu khung hình là tính năng mới trong Chrome 36.

  • loại

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

    Loại khung hình: none hoặc chrome (mặc định là chrome).

    Đối với none, bạn có thể sử dụng thuộc tính CSS -webkit-app-region để áp dụng khả năng kéo cho cửa sổ của ứng dụng.

    Bạn có thể sử dụng -webkit-app-region: drag để đánh dấu các khu vực có thể kéo. Bạn có thể dùng no-drag để vô hiệu hoá kiểu này trên các phần tử lồng nhau.

State

Trạng thái cửa sổ: bình thường, toàn màn hình, phóng to, thu nhỏ.

Enum

"normal" (bình thường)

"toàn màn hình"

"đã phóng to"

"giảm thiểu"

WindowType

Chrome 45 trở lên

Chỉ định loại cửa sổ cần tạo.

Enum

"shell"
Loại cửa sổ mặc định.

"panel"
Cửa sổ hệ điều hành do hệ điều hành quản lý (Không dùng nữa).

Phương thức

canSetVisibleOnAllWorkspaces()

chrome.app.window.canSetVisibleOnAllWorkspaces()

Liệu nền tảng hiện tại có hỗ trợ hiển thị các cửa sổ trên tất cả các không gian làm việc hay không.

Giá trị trả về

  • boolean

create()

Lời hứa
chrome.app.window.create(
  url: string,
  options?: CreateWindowOptions,
  callback?: function,
)

Có thể chỉ định kích thước và vị trí của cửa sổ theo một số cách khác nhau. Lựa chọn đơn giản nhất là không chỉ định bất kỳ thông tin nào. Trong trường hợp đó, kích thước mặc định và vị trí phụ thuộc vào nền tảng sẽ được sử dụng.

Để đặt vị trí, kích thước và các điều kiện ràng buộc của cửa sổ, hãy dùng thuộc tính innerBounds hoặc outerBounds. Giới hạn bên trong không bao gồm đồ trang trí cửa sổ. Giới hạn bên ngoài bao gồm khung và thanh tiêu đề của cửa sổ. Lưu ý: Khoảng đệm giữa giới hạn trong và giới hạn ngoài là do hệ điều hành xác định. Do đó, việc đặt cùng một thuộc tính cho cả ranh giới bên trong và bên ngoài bị coi là một lỗi (ví dụ: đặt cả innerBounds.leftouterBounds.left).

Để tự động ghi nhớ vị trí của các cửa sổ, bạn có thể cung cấp mã nhận dạng cho các cửa sổ đó. Nếu cửa sổ có mã nhận dạng, thì mã nhận dạng này được dùng để ghi nhớ kích thước và vị trí của cửa sổ bất cứ khi nào cửa sổ được di chuyển hoặc đổi kích thước. Sau đó, kích thước và vị trí này được dùng thay cho các giới hạn đã chỉ định khi mở một cửa sổ tiếp theo có cùng mã nhận dạng. Nếu cần mở một cửa sổ có mã nhận dạng tại một vị trí khác với vị trí đã nhớ, bạn có thể ẩn cửa sổ đó, di chuyển đến vị trí mong muốn rồi hiển thị cửa sổ đó.

Tham số

  • url

    string

  • tùy chọn

    CreateWindowOptions không bắt buộc

  • số gọi lại

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

    Tham số callback sẽ có dạng như sau:

    (createdWindow: AppWindow) => void

Giá trị trả về

  • Promise<AppWindow>

    Chrome 117 trở lên

    Lời hứa chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

current()

chrome.app.window.current()

Trả về một đối tượng AppWindow cho ngữ cảnh tập lệnh hiện tại (tức là đối tượng "window" của JavaScript). Thao tác này cũng có thể được gọi khi xử lý ngữ cảnh tập lệnh cho một trang khác, ví dụ: otherWindow.chrome.app.window.current().

Giá trị trả về

get()

chrome.app.window.get(
  id: string,
)

Nhận AppWindow có mã nhận dạng đã cho. Nếu không có cửa sổ nào có mã nhận dạng đã cho thì giá trị rỗng sẽ được trả về. Đây là phương thức mới trong Chrome 33.

Tham số

  • id

    string

Giá trị trả về

getAll()

chrome.app.window.getAll()

Lấy một mảng gồm tất cả cửa sổ ứng dụng hiện đã tạo. Đây là phương thức mới trong Chrome 33.

Giá trị trả về

Sự kiện

onBoundsChanged

chrome.app.window.onBoundsChanged.addListener(
  callback: function,
)

Được kích hoạt khi cửa sổ được đổi kích thước.

Tham số

  • số gọi lại

    hàm

    Tham số callback sẽ có dạng như sau:

    () => void

onClosed

chrome.app.window.onClosed.addListener(
  callback: function,
)

Được kích hoạt khi cửa sổ đóng. Lưu ý: Bạn nên nghe âm thanh này từ một cửa sổ khác với cửa sổ đang đóng, ví dụ như từ trang nền. Lý do là cửa sổ bị đóng sẽ trong quá trình bị huỷ bỏ khi sự kiện được kích hoạt, có nghĩa là không phải tất cả API trong ngữ cảnh tập lệnh của cửa sổ đều hoạt động.

Tham số

  • số gọi lại

    hàm

    Tham số callback sẽ có dạng như sau:

    () => void

onFullscreened

chrome.app.window.onFullscreened.addListener(
  callback: function,
)

Được kích hoạt khi cửa sổ ở chế độ toàn màn hình (qua API AppWindow hoặc HTML5).

Tham số

  • số gọi lại

    hàm

    Tham số callback sẽ có dạng như sau:

    () => void

onMaximized

chrome.app.window.onMaximized.addListener(
  callback: function,
)

Được kích hoạt khi cửa sổ được phóng to.

Tham số

  • số gọi lại

    hàm

    Tham số callback sẽ có dạng như sau:

    () => void

onMinimized

chrome.app.window.onMinimized.addListener(
  callback: function,
)

Được kích hoạt khi cửa sổ được thu nhỏ.

Tham số

  • số gọi lại

    hàm

    Tham số callback sẽ có dạng như sau:

    () => void

onRestored

chrome.app.window.onRestored.addListener(
  callback: function,
)

Được kích hoạt khi cửa sổ được khôi phục từ việc bị thu nhỏ hoặc phóng to.

Tham số

  • số gọi lại

    hàm

    Tham số callback sẽ có dạng như sau:

    () => void