SiTabsetComponent documentation¶

selector

si-tabset

Input Properties¶

Name	Type	Default	Description
selectDefaultTab ¶	`boolean`	`true`	If selectDefaultTab is passed as 'false', this implies no default tab selection i.e. on initial load of tabset component no tab gets selected.
selectedTabIndex ¶	`number`		Returns the currently selected tab index. Sets a selected tab index. This will activate the tab of the provided index, activates the tab and fires a notification about the change. If index is passed as -1 i.e. `selectedTabIndex = -1` , this implies to clear all tab selection.
tabButtonMaxWidth ¶	`number`		Define an optional max-width in px for the tab buttons. The minimum value is `100` .

Output Properties¶

Name	Type	Description
(readonly) deselect ¶	`EventEmitter`<`SiTabDeselectionEvent`>	Event emitter to notify when a tab became inactive.
(readonly) selectedTabIndexChange ¶	`EventEmitter`<`number`>	Event emitter to notify about selected tab index changes. You can either use bi-directional binding with [(selectedTabIndex)] or separate both with [selectedTabIndex]=... and (selectedTabIndexChange)=...

Types Documentation¶

SiTabDeselectionEvent

¶

Interface

Properties
To be called to prevent switching the tab cancel: () => `void`¶
The index of target tab tabIndex: `number`¶
The target tab target: `SiTabComponent`¶

TranslatableString (`string` & `Translatable`)¶ Type alias Represents a translatable string. This can either be a translation key, e.g. `ACTIONS.EDIT` that will be automatically translated when displayed on the UI or a pre-translated string, e.g. `Edit` . Equivalent to a normal string in usage and functionality.

Translatable ¶ import imported from @siemens/element-translate-ng

SiTabComponent

implements OnChanges¶

Class

▶

Constructor
() => `{}`¶

Properties
active: `WritableSignal`<`boolean`> = ...¶
Background color of the badge. If no color is provided a red dot badge will be rendered. badgeColor?: `string`¶
Additional badge content. A value of - `true` will render a red dot - any string without a `badgeColor` will render a red dot with text - any string with a `badgeColor` will render a normal badge badgeContent?: (`boolean` \| `TranslatableString`)¶
Close the current tab. closable?: `boolean` = `false`¶
Event emitter to notify when a tab is closed. closeTriggered: `EventEmitter`<`SiTabComponent`> = ...¶
Disables the tab. disabled: `boolean` = `false`¶
Title of the tab item. heading?: `TranslatableString`¶
Icon of the tab item. icon?: `string`¶
Alternative name or translation key for icon. Used for A11y. iconAltText?: `TranslatableString`¶
id: `string` = ...¶
parent?: `SiTabsetComponent`¶
tabId: `string` = ...¶
idCounter: `number` = `0`¶

Accessors
get isHidden: (`null` \| `boolean`)¶

Methods

A callback method that is invoked immediately after the default change detector has checked data-bound properties if at least one has changed, and before the view and content children are checked.
ngOnChanges: () => void from OnChanges.ngOnChanges¶

registerParent

(parent: SiTabsetComponent) => void¶

Parameters
parent: `SiTabsetComponent`¶

Except where otherwise noted, content on this site is licensed under MIT License.