Skip to content
On this page

Module: features/tabs/tab

Interfaces

BaseTab

BaseTab: Object

The properties that are added onto a processed TabOptions to create an Tab.

NameTypeDescription
[Component]GenericComponentThe Vue component used to render this feature.
[GatherProps]() => Record<string, unknown>A function to gather the props the vue component requires for this feature.
idstringAn auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates.
typetypeof TabTypeA symbol that helps identify features of the same type.

Defined in

profectus/src/features/tabs/tab.ts:31


TabOptions

TabOptions: Object

An object that configures a Tab.

NameTypeDescription
classes?Computable<Record<string, boolean>>Dictionary of CSS classes to apply to this feature.
displayComputable<CoercableComponent>The display to use for this tab.
style?Computable<StyleValue>CSS to apply to this feature.

Defined in

profectus/src/features/tabs/tab.ts:19

Type Aliases

GenericTab

Ƭ GenericTab: Tab<TabOptions>

A type that matches any valid Tab object.

Defined in

profectus/src/features/tabs/tab.ts:56


Tab

Ƭ Tab<T>: Replace<T & BaseTab, { classes: GetComputableType<T["classes"]> ; display: GetComputableType<T["display"]> ; style: GetComputableType<T["style"]> }>

An object representing a tab of content in a tabbed interface.

See

TabFamily

Type parameters

NameType
Textends TabOptions

Defined in

profectus/src/features/tabs/tab.ts:46

Variables

TabType

Const TabType: typeof TabType

A symbol used to identify Tab features.

Defined in

profectus/src/features/tabs/tab.ts:14

Functions

createTab

createTab<T>(optionsFunc): Tab<T>

Lazily creates a tab with the given options.

Type parameters
NameType
Textends TabOptions
Parameters
NameTypeDescription
optionsFuncOptionsFunc<T, BaseTab, GenericTab>Tab options.
Returns

Tab<T>

Defined in

profectus/src/features/tabs/tab.ts:62