ProfectusModule: features/tabs/tabFamily
Interfaces
BaseTabButton
• BaseTabButton: Object
The properties that are added onto a processed TabButtonOptions to create an TabButton.
| Name | Type | Description |
|---|---|---|
[Component] | GenericComponent | The Vue component used to render this feature. |
type | typeof TabButtonType | A symbol that helps identify features of the same type. |
Defined in
profectus/src/features/tabs/tabFamily.ts:58
BaseTabFamily
• BaseTabFamily: Object
The properties that are added onto a processed TabFamilyOptions to create an TabFamily.
| Name | Type | Description |
|---|---|---|
[Component] | GenericComponent | The Vue component used to render this feature. |
[GatherProps] | () => Record<string, unknown> | A function to gather the props the vue component requires for this feature. |
activeTab | Ref<null | CoercableComponent | GenericTab> | The currently active tab, if any. |
id | string | An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates. |
selected | Persistent<string> | The name of the tab that is currently active. |
tabs | Record<string, TabButtonOptions> | All the tabs within this family. |
type | typeof TabFamilyType | A symbol that helps identify features of the same type. |
Defined in
profectus/src/features/tabs/tabFamily.ts:108
TabButtonOptions
• TabButtonOptions: Object
An object that configures a TabButton.
| Name | Type | Description |
|---|---|---|
classes? | Computable<Record<string, boolean>> | Dictionary of CSS classes to apply to this feature. |
display | Computable<CoercableComponent> | The label on this button. |
glowColor? | Computable<string> | The color of the glow effect to display when this button is active. |
style? | Computable<StyleValue> | CSS to apply to this feature. |
tab | Computable<CoercableComponent | GenericTab> | The tab to display when this button is clicked. |
visibility? | Computable<boolean | Visibility> | Whether this tab button should be visible. |
Defined in
profectus/src/features/tabs/tabFamily.ts:40
TabFamilyOptions
• TabFamilyOptions: Object
An object that configures a TabFamily.
| Name | Type | Description |
|---|---|---|
buttonContainerClasses? | Computable<Record<string, boolean>> | A dictionary of CSS classes to apply to the list of buttons for changing tabs. |
buttonContainerStyle? | Computable<StyleValue> | CSS to apply to the list of buttons for changing tabs. |
classes? | Computable<Record<string, boolean>> | Dictionary of CSS classes to apply to this feature. |
style? | Computable<StyleValue> | CSS to apply to this feature. |
visibility? | Computable<boolean | Visibility> | Whether this tab button should be visible. |
Defined in
profectus/src/features/tabs/tabFamily.ts:92
Type Aliases
GenericTabButton
Ƭ GenericTabButton: Replace<TabButton<TabButtonOptions>, { visibility: ProcessedComputable<Visibility | boolean> }>
A type that matches any valid TabButton object.
Defined in
profectus/src/features/tabs/tabFamily.ts:82
GenericTabFamily
Ƭ GenericTabFamily: Replace<TabFamily<TabFamilyOptions>, { visibility: ProcessedComputable<Visibility | boolean> }>
A type that matches any valid TabFamily object.
Defined in
profectus/src/features/tabs/tabFamily.ts:138
TabButton
Ƭ TabButton<T>: Replace<T & BaseTabButton, { classes: GetComputableType<T["classes"]> ; display: GetComputableType<T["display"]> ; glowColor: GetComputableType<T["glowColor"]> ; style: GetComputableType<T["style"]> ; tab: GetComputableType<T["tab"]> ; visibility: GetComputableTypeWithDefault<T["visibility"], Visible> }>
An object that represents a button that can be clicked to change tabs in a tabbed interface.
See
Type parameters
| Name | Type |
|---|---|
T | extends TabButtonOptions |
Defined in
profectus/src/features/tabs/tabFamily.ts:69
TabFamily
Ƭ TabFamily<T>: Replace<T & BaseTabFamily, { tabs: Record<string, GenericTabButton> ; visibility: GetComputableTypeWithDefault<T["visibility"], Visible> }>
An object that represents a tabbed interface.
See
Type parameters
| Name | Type |
|---|---|
T | extends TabFamilyOptions |
Defined in
profectus/src/features/tabs/tabFamily.ts:129
Variables
TabButtonType
• Const TabButtonType: typeof TabButtonType
A symbol used to identify TabButton features.
Defined in
profectus/src/features/tabs/tabFamily.ts:33
TabFamilyType
• Const TabFamilyType: typeof TabFamilyType
A symbol used to identify TabFamily features.
Defined in
profectus/src/features/tabs/tabFamily.ts:35
Functions
createTabFamily
▸ createTabFamily<T>(tabs, optionsFunc?): TabFamily<T>
Lazily creates a tab family with the given options.
Type parameters
| Name | Type |
|---|---|
T | extends TabFamilyOptions |
Parameters
| Name | Type | Description |
|---|---|---|
tabs | Record<string, () => TabButtonOptions> | - |
optionsFunc? | OptionsFunc<T, BaseTabFamily, GenericTabFamily> | Tab family options. |
Returns
TabFamily<T>