chrome.tabGroups

Opis

Użyj interfejsu API chrome.tabGroups, aby wchodzić w interakcje z systemem grupowania kart przeglądarki. Za pomocą tego interfejsu API możesz modyfikować i przestawiać grupy kart w przeglądarce. Aby grupować i rozgrupowywać karty lub zapytać, które karty znajdują się w grupach, użyj interfejsu chrome.tabs API.

Uprawnienia

tabGroups

Dostępność

Chrome 89 lub nowszy MV3+

Typy

Color

kolor grupy,

Typ wyliczeniowy

„szara”

"blue"

„red”

„yellow”

„green”

"pink"

"purple"

„cyjan”

"pomarańczowy"

TabGroup

Właściwości

  • zwinięto

    wartość logiczna

    Czy grupa jest zwinięta. Zwinięta grupa to taka, której karty są ukryte.

  • kolor

    kolor grupy,

  • id

    liczba

    Identyfikator grupy. Identyfikatory grup są unikalne w ramach sesji przeglądarki.

  • udostępniony

    wartość logiczna

    Oczekuje

    czy grupa jest udostępniona.

  • tytuł

    string opcjonalny

    Tytuł grupy.

  • windowId

    liczba

    Identyfikator okna zawierającego grupę.

Właściwości

TAB_GROUP_ID_NONE

Identyfikator, który reprezentuje brak grupy.

Wartość

-1

Metody

get()

Obietnice
chrome.tabGroups.get(
  groupId: number,
  callback?: function,
)

Pobiera szczegóły określonej grupy.

Parametry

  • groupId

    liczba

  • callback

    function opcjonalny

    Parametr callback ma postać:

    (group: TabGroup) => void

Zwroty

  • Obietnica<TabGroup>

    Chrome 90+

    Obietnice są obsługiwane w pliku manifestu w wersji 3 i późniejszych, ale wywołania zwrotne są dostępne ze względu na zgodność wsteczną. Nie możesz używać obu w tym samym wywołaniu funkcji. Obiet na obietnicy zwracany jest z tym samym typem, który jest przekazywany do funkcji wywołania zwrotnego.

move()

Obietnice
chrome.tabGroups.move(
  groupId: number,
  moveProperties: object,
  callback?: function,
)

Przenosi grupę i wszystkie jej karty w oknie lub do nowego okna.

Parametry

  • groupId

    liczba

    Identyfikator grupy, którą chcesz przenieść.

  • moveProperties

    obiekt

    • indeks

      liczba

      Pozycja, do której chcesz przenieść grupę. Aby umieścić grupę na końcu okna, użyj -1.

    • windowId

      numer opcjonalny

      Okno, do którego chcesz przenieść grupę. Domyślnie jest to okno, w którym znajduje się grupa. Pamiętaj, że grupy można przenosić tylko do i z okien typu windows.WindowType."normal"

  • callback

    function opcjonalny

    Parametr callback ma postać:

    (group?: TabGroup) => void

    • grupa

      TabGroup opcjonalnie

      Szczegóły dotyczące przeniesionej grupy.

Zwroty

  • Obietnica<TabGroup | nieokreślona>

    Chrome 90+

    Obietnice są obsługiwane w pliku manifestu w wersji 3 i późniejszych, ale wywołania zwrotne są dostępne ze względu na zgodność wsteczną. Nie możesz używać obu w tym samym wywołaniu funkcji. Obiet na obietnicy zwracany jest z tym samym typem, który jest przekazywany do funkcji wywołania zwrotnego.

query()

Obietnice
chrome.tabGroups.query(
  queryInfo: object,
  callback?: function,
)

Pobiera wszystkie grupy o określonych właściwościach lub wszystkie grupy, jeśli nie określono żadnych właściwości.

Parametry

  • queryInfo

    obiekt

    • zwinięto

      logiczna opcjonalna

      czy grupy są zwinięte.

    • kolor

      Kolor opcjonalny

      Kolor grup.

    • udostępniony

      logiczna opcjonalna

      Oczekuje

      czy grupa jest udostępniona.

    • tytuł

      string opcjonalny

      Dopasowuj tytuły grup do wzoru.

    • windowId

      numer opcjonalny

      Identyfikator nadrzędnego okna lub windows.WINDOW_ID_CURRENT w przypadku bieżącego okna.

  • callback

    function opcjonalny

    Parametr callback ma postać:

    (result: TabGroup[]) => void

Zwroty

  • Obietnica<TabGroup[]>

    Chrome 90+

    Obietnice są obsługiwane w pliku manifestu w wersji 3 i późniejszych, ale wywołania zwrotne są dostępne ze względu na zgodność wsteczną. Nie możesz używać obu w tym samym wywołaniu funkcji. Obiet na obietnicy zwracany jest z tym samym typem, który jest przekazywany do funkcji wywołania zwrotnego.

update()

Obietnice
chrome.tabGroups.update(
  groupId: number,
  updateProperties: object,
  callback?: function,
)

Modyfikuje właściwości grupy. Właściwości, które nie są określone w sekcji updateProperties, nie są modyfikowane.

Parametry

  • groupId

    liczba

    Identyfikator grupy, którą chcesz zmodyfikować.

  • updateProperties

    obiekt

    • zwinięto

      logiczna opcjonalna

      Określa, czy grupa powinna być zwinięta.

    • kolor

      Kolor opcjonalny

      Kolor grupy.

    • tytuł

      string opcjonalny

      Tytuł grupy.

  • callback

    function opcjonalny

    Parametr callback ma postać:

    (group?: TabGroup) => void

    • grupa

      TabGroup opcjonalnie

      Szczegóły zaktualizowanej grupy.

Zwroty

  • Obietnica<TabGroup | nieokreślona>

    Chrome 90+

    Obietnice są obsługiwane w pliku manifestu w wersji 3 i późniejszych, ale wywołania zwrotne są dostępne ze względu na zgodność wsteczną. Nie możesz używać obu w tym samym wywołaniu funkcji. Obiet na obietnicy zwracany jest z tym samym typem, który jest przekazywany do funkcji wywołania zwrotnego.

Wydarzenia

onCreated

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

Wywoływany po utworzeniu grupy.

Parametry

  • callback

    funkcja

    Parametr callback ma postać:

    (group: TabGroup) => void

onMoved

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

Wywoływane, gdy grupa jest przenoszona w oknie. Zdarzenia przenoszenia są nadal wywoływane w przypadku poszczególnych kart w grupie, a także samej grupy. To zdarzenie nie jest wywoływane, gdy grupa jest przenoszona między oknami. Zamiast tego zostaje ona usunięta z jednego okna i utworzona w drugim.

Parametry

  • callback

    funkcja

    Parametr callback ma postać:

    (group: TabGroup) => void

onRemoved

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

Uruchamiane, gdy grupa zostanie zamknięta bezpośrednio przez użytkownika lub automatycznie, ponieważ nie zawierała żadnych kart.

Parametry

  • callback

    funkcja

    Parametr callback ma postać:

    (group: TabGroup) => void

onUpdated

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

Wyzwalane po zaktualizowaniu grupy.

Parametry

  • callback

    funkcja

    Parametr callback ma postać:

    (group: TabGroup) => void