kvision-bootstrap/io.kvision.panel/TabPanel

TabPanel

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

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

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

Types

Link copied to clipboard
class TabPanelContent(tabPanel: TabPanel)

A helper component for rendering tab content.

Link copied to clipboard
class TabPanelNav(tabPanel: TabPanel, className: String)

A helper component for rendering tabs.

Properties

Link copied to clipboard
var activeIndex: Int

The index of the active tab.

Link copied to clipboard
var activeTab: Tab?

The active tab.

Link copied to clipboard
val draggableTabs: Boolean = false
Link copied to clipboard
val scrollableTabs: Boolean = false

Functions

Link copied to clipboard
open fun add(child: <Error class: unknown class>)
open fun add(position: Int, child: <Error class: unknown class>)
Link copied to clipboard
open fun addAll(children: List<<Error class: unknown class>>)
Link copied to clipboard
open fun addTab(title: String, panel: <Error class: unknown class>, icon: String? = null, image: <Error class: unknown class>? = null, closable: Boolean = false, route: String? = null)

Creates and adds new tab component.

Link copied to clipboard
open fun disposeAll()
Link copied to clipboard
open fun findTabWithComponent(component: <Error class: unknown class>): Tab?

Find the tab which contains the given component.

Link copied to clipboard
open fun getSize(): Int

Returns the number of tabs.

Link copied to clipboard
open fun getTab(index: Int): Tab?

Get the Tab component by index.

Link copied to clipboard
open fun getTabIndex(tab: Tab): Int

Get the index of the given tab.

Link copied to clipboard
open fun getTabs(): List<Tab>

Returns the list of tabs.

Link copied to clipboard
open fun moveTab(fromIndex: Int, toIndex: Int)

Move the tab to a different position.

Link copied to clipboard
open fun remove(child: <Error class: unknown class>)
Link copied to clipboard
open fun removeAll()
Link copied to clipboard
open fun removeAt(position: Int)
Link copied to clipboard
open fun removeTab(index: Int)

Removes tab at given index.

Link copied to clipboard
fun TabPanel.tab(label: String? = null, icon: String? = null, image: <Error class: unknown class>? = null, closable: Boolean = false, route: String? = null, init: Tab.() -> Unit? = null): Tab

DSL builder extension function.