kvision-onsenui/io.kvision.onsenui.splitter/SplitterSide

SplitterSide

open class SplitterSide(animation: SideAnimation? = null, swipeable: Boolean? = null, collapse: Collapse? = null, side: Side? = null, className: String? = null, init: SplitterSide.() -> Unit? = null)

A splitter side component.

Parameters

animation

an animation type

swipeable

whether to enable swipe interaction on collapse mode

collapse

specify the collapse behavior

side

specify which side of the screen the side menu is located

className

CSS class names

init

an initializer extension function

Constructors

constructor(animation: SideAnimation? = null, swipeable: Boolean? = null, collapse: Collapse? = null, side: Side? = null, className: String? = null, init: SplitterSide.() -> Unit? = null)

Creates a splitter side component.

Properties

var animation: SideAnimation?

An animation type.

var collapse: Collapse?

Specify the collapse behavior.

val isOpen: Boolean

A dynamic property returning if the side menu is open.

val mode: String?

A dynamic property returning current collapse mode ("split", "collapse", "closed", "open" or "changing").

var openThreshold: Number?

Specify how much the menu needs to be swiped before opening.

val page: <Error class: unknown class>?

A dynamic property returning current page.

var side: Side?

Specify which side of the screen the side menu is located.

var sideWidth: <Error class: unknown class>?

The width of swipeable area calculated from the edge (in pixels).

var swipeable: Boolean?

Whether to enable swipe interaction on collapse mode.

swipeTargetWidth

var swipeTargetWidth: Number?

The width of swipeable area calculated from the edge (in pixels).

Functions

open fun afterInsert(node: <Error class: unknown class>)

buildAttributeSet

open fun buildAttributeSet(attributeSetBuilder: <Error class: unknown class>)

open fun close(options: dynamic = undefined): <Error class: unknown class><Unit>?

Closes side menu.

open fun load(page: Page, options: dynamic = undefined): <Error class: unknown class><Unit>?

open fun load(pageId: String, options: dynamic = undefined): <Error class: unknown class><Unit>?

Loads the specified page into the splitter side menu.

open fun onSwipe(callback: (ratio: Number) -> Unit)

Sets swipe event listener.

open fun onSwipeClear()

Clears swipe event listener.

open fun open(options: dynamic = undefined): <Error class: unknown class><Unit>?

Opens side menu.

fun SplitterSide.page(pageId: String? = null, className: String? = null, init: Page.() -> Unit? = null): Page

DSL builder extension function.

open fun render(): <Error class: unknown class>

open fun toggle(options: dynamic = undefined): <Error class: unknown class><Unit>?

Toggles side menu visibility.