kvision-onsenui/io.kvision.onsenui.tabbar/Tabbar

Tabbar

open class Tabbar(tabPosition: TabsPosition? = null, animation: Boolean? = null, swipeable: Boolean? = null, className: String? = null, init: Tabbar.() -> Unit? = null)

A tab bar component.

Parameters

tabPosition

the tab bar position

animation

determines if the transitions are animated

swipeable

determines if the tab bar can be scrolled by drag or swipe

className

CSS class names

init

an initializer extension function

Constructors

Link copied to clipboard
constructor(tabPosition: TabsPosition? = null, animation: Boolean? = null, swipeable: Boolean? = null, className: String? = null, init: Tabbar.() -> Unit? = null)

Creates a tab bar component.

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
var animation: Boolean?

Determines if the transitions are animated.

Link copied to clipboard
var hideTabs: Boolean?

Whether to hide the tabs.

Link copied to clipboard
var ignoreEdgeWidth: Number?

Distance in pixels from both edges. Swiping on these areas will prioritize parent components.

Link copied to clipboard
val isVisible: dynamic

A dynamic property returning visibility of the tab bar.

Link copied to clipboard
var modifier: String?

A modifier attribute to specify custom styles.

Link copied to clipboard
var swipeable: Boolean?

Determines if the tab bar can be scrolled by drag or swipe.

Link copied to clipboard
var tabBorder: Boolean?

Whether the tabs show a dynamic bottom border. Only works for iOS flat design since the border is always visible in Material Design.

Link copied to clipboard
var tabPosition: TabsPosition?

The tab bar position.

Functions

Link copied to clipboard
open fun afterCreate(node: <Error class: unknown class>)
Link copied to clipboard
open fun afterDestroy()
Link copied to clipboard
open fun afterInsert(node: <Error class: unknown class>)
Link copied to clipboard
open fun buildAttributeSet(attributeSetBuilder: <Error class: unknown class>)
Link copied to clipboard
open fun getActiveTabIndex(): Number

Gets the active tab index.

Link copied to clipboard
open fun onSwipe(callback: (ratio: Number) -> Unit)

Sets swipe event listener.

Link copied to clipboard
open fun onSwipeClear()

Clears swipe event listener.

Link copied to clipboard
open fun render(): <Error class: unknown class>
Link copied to clipboard
open fun setActiveTab(index: Int, options: dynamic = undefined): <Error class: unknown class><Unit>?

Shows specified tab page.

Link copied to clipboard
open fun setTabbarVisibility(visible: Boolean)

Shows or hides the tab bar.

Link copied to clipboard
fun Tabbar.tab(label: String? = null, icon: String? = null, activeIcon: String? = null, badge: String? = null, active: Boolean? = null, className: String? = null, init: Tab.() -> Unit? = null): Tab

DSL builder extension function.

Link copied to clipboard
open fun tabbarStyle(callback: <Error class: unknown class>.(index: Int) -> Unit)

Sets the tab bar panel styling callback.

Link copied to clipboard
open fun tabbarStyleClear()

Clears the tab bar panel styling callback.