Skip to content

Profectus / features/tabs/tabFamily / TabFamily

Interface: TabFamily ​

An object that represents a tabbed interface.

See ​

TabFamily

Extends ​

Properties ​

[VueFeature] ​

[VueFeature]: true

Used to identify Vue Features

Inherited from ​

VueFeature.[VueFeature]

Defined in ​

profectus/src/util/vue.tsx:43


activeTab ​

activeTab: Ref<null | MaybeGetter<Renderable> | Tab, null | MaybeGetter<Renderable> | Tab>

The currently active tab, if any.

Defined in ​

profectus/src/features/tabs/tabFamily.tsx:67


buttonContainerClasses? ​

optional buttonContainerClasses: MaybeRef<Record<string, boolean>>

A dictionary of CSS classes to apply to the list of buttons for changing tabs.

Defined in ​

profectus/src/features/tabs/tabFamily.tsx:61


buttonContainerStyle? ​

optional buttonContainerStyle: MaybeRef<CSSProperties>

CSS to apply to the list of buttons for changing tabs.

Defined in ​

profectus/src/features/tabs/tabFamily.tsx:63


classes? ​

optional classes: MaybeRef<Record<string, boolean>>

Dictionary of CSS classes to apply to this feature.

Inherited from ​

VueFeature.classes

Defined in ​

profectus/src/util/vue.tsx:35


components ​

components: MaybeGetter<Renderable>[]

The components to render inside the vue feature

Inherited from ​

VueFeature.components

Defined in ​

profectus/src/util/vue.tsx:39


id ​

id: string

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

Inherited from ​

VueFeature.id

Defined in ​

profectus/src/util/vue.tsx:31


selected ​

selected: Persistent<string>

The name of the tab that is currently active.

Defined in ​

profectus/src/features/tabs/tabFamily.tsx:69


style? ​

optional style: MaybeRef<CSSProperties>

CSS to apply to this feature.

Inherited from ​

VueFeature.style

Defined in ​

profectus/src/util/vue.tsx:37


tabs ​

tabs: Record<string, TabButton>

All the tabs within this family.

Defined in ​

profectus/src/features/tabs/tabFamily.tsx:65


type ​

type: typeof TabFamilyType

A symbol that helps identify features of the same type.

Defined in ​

profectus/src/features/tabs/tabFamily.tsx:71


visibility? ​

optional visibility: MaybeRef<boolean | Visibility>

Whether this feature should be visible.

Inherited from ​

VueFeature.visibility

Defined in ​

profectus/src/util/vue.tsx:33


wrappers ​

wrappers: Wrapper[]

The components to render wrapped around the vue feature

Inherited from ​

VueFeature.wrappers

Defined in ​

profectus/src/util/vue.tsx:41