TabModel API in JavaScript Tabs API control

Interface for a class Tab

Properties

added

EmitType<AddEventArgs>

The event will be fired after adding the item to the Tab.

adding

EmitType<AddEventArgs>

The event will be fired before adding the item to the Tab.

created

EmitType<Event>

The event will be fired once the component rendering is completed.

destroyed

EmitType<Event>

The event will be fired when the component gets destroyed.

removed

EmitType<RemoveEventArgs>

The event will be fired after removing the item from the Tab.

removing

EmitType<RemoveEventArgs>

The event will be fired before removing the item from the Tab.

selected

EmitType<SelectEventArgs>

The event will be fired after the item gets selected.

selecting

EmitType<SelectingEventArgs>

The event will be fired before the item gets selected.

animation

TabAnimationSettingsModel

Specifies the animation configuration settings while showing the content of the Tab.

cssClass

string

Sets the CSS classes to root element of the Tab that helps to customize component styles.

enableHtmlSanitizer

boolean

Defines whether to allow the cross-scripting site or not.

enablePersistence

boolean

Enable or disable persisting component’s state between page reloads. If enabled, following list of states will be persisted.

1. selectedItem

enableRtl

boolean

Enable or disable rendering component in right to left direction.

headerPlacement

string

Specifies the orientation of Tab header. The possible values are:

• Top: Places the Tab header on the top.
• Bottom: Places the Tab header at the bottom.
• Left: Places the Tab header on the left.
• Right: Places the Tab header at the right.

height

string | number

Specifies the height of the Tab component. By default, Tab height is set based on the height of its parent. To use height property, heightAdjustMode must be set to ‘None’.

heightAdjustMode

string

Specifies the height style for Tab content. The possible values are:

• None: Based on the given height property, the content panel height is set.
• Auto: Tallest panel height of a given Tab content is set to all the other panels.
• Content: Based on the corresponding content height, the content panel height is set.
• Fill: Based on the parent height, the content panel height is set.

items

TabItemModel[]

An array of object that is used to configure the Tab component.

  let tabObj: Tab = new Tab( {
    items: [
      { header: { text: 'TabItem1' }, content: 'Tab Item1 Content' },
      { header: { text: 'TabItem2' }, content: 'Tab Item2 Content' }
    ]
  });
  tabObj.appendTo('#tab');

loadOn

string

Specifies the modes for Tab content. The possible modes are: Dynamic Load Tab content dynamically at the time of switching it’s header. Init Load all tab contents at initial load. Demand Load Tab content when required but keep content once it is rendered.

locale

string

Overrides the global culture and localization value for this component. Default global culture is ‘en-US’.

overflowMode

string

Specifies the Tab display mode when Tab content exceeds the viewing area. The possible modes are:

• Scrollable: All the elements are displayed in a single line with horizontal scrolling enabled.
• Popup: Tab container holds the items that can be placed within the available space and rest of the items are moved to the popup. If the popup content overflows the height of the page, the rest of the elements can be viewed by scrolling the popup.

scrollStep

number

Specifies the scrolling distance in scroller.

selectedItem

number

Specifies the index for activating the current Tab item.

  let tabObj: Tab = new Tab( {
    selectedItem: 1,
    items: [
      { header: { text: 'TabItem1' }, content: 'Tab Item1 Content' },
      { header: { text: 'TabItem2' }, content: 'Tab Item2 Content' }
    ]
  });
  tabObj.appendTo('#tab');

showCloseButton

boolean

Specifies whether to show the close button for header items to remove the item from the Tab.

width

string | number

Specifies the width of the Tab component. Default, Tab width sets based on the width of its parent.