API Reference / @gtkx/components / TabCollection
Type Alias: TabCollection<T>
TabCollection<
T> =object
Defined in: packages/components/src/types.ts:316
Owns independent JSX tab roots across native view transfers. Its lifetime can span several windows. Remove a page after accepting its native close request, remove a view's pages before destroying that view, and dispose the collection when its owner is finished.
Type Parameters
T
T
Properties
append
append: (
view,item,options?) =>Adw.TabPage
Defined in: packages/components/src/types.ts:318
Renders synchronously and returns the native page, including from an overview's create-tab handler.
Parameters
view
Adw.TabView
item
T
options?
Returns
Adw.TabPage
dispose
dispose: () =>
void
Defined in: packages/components/src/types.ts:330
Unmounts every managed page. The collection may subsequently be reused.
Returns
void
get
get: (
page) =>T|undefined
Defined in: packages/components/src/types.ts:320
Returns a managed page's current value, or undefined for an unmanaged page.
Parameters
page
Adw.TabPage
Returns
T | undefined
remove
remove: (
page) =>void
Defined in: packages/components/src/types.ts:324
Unmounts a managed page from its current native owner; already removed pages are ignored.
Parameters
page
Adw.TabPage
Returns
void
removeView
removeView: (
view) =>void
Defined in: packages/components/src/types.ts:326
Unmounts this collection's pages currently belonging to the given view, including transferred pages.
Parameters
view
Adw.TabView
Returns
void
transfer
transfer: (
page,target,position?) =>void
Defined in: packages/components/src/types.ts:328
Moves a managed page to another view, appending within its pinned or unpinned group by default.
Parameters
page
Adw.TabPage
target
Adw.TabView
position?
number
Returns
void
update
update: (
page,item) =>void
Defined in: packages/components/src/types.ts:322
Updates the value and rerenders the existing JSX root, preserving component state and native identity.
Parameters
page
Adw.TabPage
item
T
Returns
void