kvision-bootstrap/io.kvision.panel/TabPanel

TabPanel

open class TabPanel(tabPosition: TabPosition, sideTabSize: SideTabSize, scrollableTabs: Boolean, draggableTabs: Boolean, className: String?, init: TabPanel.() -> Unit?)

The container rendering its children as tabs.

It supports activating children by a JavaScript route.

Parameters

tabPosition

tab position

sideTabSize

side tab size

scrollableTabs

determines if tabs are scrollable (default: false)

draggableTabs

determines if tabs are draggable (default: false)

className

CSS class names

init

an initializer extension function

Constructors

TabPanel

fun TabPanel(tabPosition: TabPosition = TabPosition.TOP, sideTabSize: SideTabSize = SideTabSize.SIZE_3, scrollableTabs: Boolean = false, draggableTabs: Boolean = false, className: String? = null, init: TabPanel.() -> Unit? = null)

Types

TabPanelContent

class TabPanelContent(tabPanel: TabPanel)

A helper component for rendering tab content.

TabPanelNav

class TabPanelNav(tabPanel: TabPanel, className: String)

A helper component for rendering tabs.

Functions

add

open fun add(child: <ERROR CLASS>): TabPanel

open fun add(position: Int, child: <ERROR CLASS>): TabPanel

addAll

open fun addAll(children: List<<ERROR CLASS>>): TabPanel

addTab

open fun addTab(title: String, panel: <ERROR CLASS>, icon: String? = null, image: <ERROR CLASS>? = null, closable: Boolean = false, route: String? = null): TabPanel

Creates and adds new tab component.

disposeAll

open fun disposeAll(): TabPanel

findTabWithComponent

open fun findTabWithComponent(component: <ERROR CLASS>): Tab?

Find the tab which contains the given component.

getSize

open fun getSize(): Int

Returns the number of tabs.

getTab

open fun getTab(index: Int): Tab?

Get the Tab component by index.

getTabIndex

open fun getTabIndex(tab: Tab): Int

Get the index of the given tab.

getTabs

open fun getTabs(): List<Tab>

Returns the list of tabs.

moveTab

open fun moveTab(fromIndex: Int, toIndex: Int)

Move the tab to a different position.

remove

open fun remove(child: <ERROR CLASS>): TabPanel

removeAll

open fun removeAll(): TabPanel

removeAt

open fun removeAt(position: Int): TabPanel

removeTab

open fun removeTab(index: Int): TabPanel

Removes tab at given index.

Properties

activeIndex

var activeIndex: Int

The index of the active tab.

activeTab

var activeTab: Tab?

The active tab.

draggableTabs

val draggableTabs: Boolean = false

scrollableTabs

val scrollableTabs: Boolean = false

Extensions

tab

fun TabPanel.tab(label: String? = null, icon: String? = null, image: <ERROR CLASS>? = null, closable: Boolean = false, route: String? = null, init: Tab.() -> Unit? = null): Tab

DSL builder extension function.