Skip to content
On this page

Interface: BaseTabFamily

features/tabs/tabFamily.BaseTabFamily

The properties that are added onto a processed TabFamilyOptions to create an TabFamily.

Properties

[Component]

[Component]: GenericComponent

The Vue component used to render this feature.

Defined in

profectus/src/features/tabs/tabFamily.ts:120


[GatherProps]

[GatherProps]: () => Record<string, unknown>

Type declaration

▸ (): Record<string, unknown>

A function to gather the props the vue component requires for this feature.

Returns

Record<string, unknown>

Defined in

profectus/src/features/tabs/tabFamily.ts:122


activeTab

activeTab: Ref<null | CoercableComponent | GenericTab>

The currently active tab, if any.

Defined in

profectus/src/features/tabs/tabFamily.ts:114


id

id: string

An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates.

Defined in

profectus/src/features/tabs/tabFamily.ts:110


selected

selected: Persistent<string>

The name of the tab that is currently active.

Defined in

profectus/src/features/tabs/tabFamily.ts:116


tabs

tabs: Record<string, TabButtonOptions>

All the tabs within this family.

Defined in

profectus/src/features/tabs/tabFamily.ts:112


type

type: typeof TabFamilyType

A symbol that helps identify features of the same type.

Defined in

profectus/src/features/tabs/tabFamily.ts:118