kvision-onsenui/io.kvision.onsenui.core/Navigator

Navigator

open class Navigator(animation: NavAnimation? = null, swipeable: Boolean? = null, forceSwipeable: Boolean? = null, className: String? = null, init: Navigator.() -> Unit? = null)

A navigator component.

Parameters

animation

an animation type.

swipeable

an iOS swipe to pop feature

forceSwipeable

force iOS swipe on Android platform

className

CSS class names

init

an initializer extension function

Constructors

Navigator

constructor(animation: NavAnimation? = null, swipeable: Boolean? = null, forceSwipeable: Boolean? = null, className: String? = null, init: Navigator.() -> Unit? = null)

Creates a navigator component.

Properties

animation

var animation: NavAnimation?

An animation type.

forceSwipeable

var forceSwipeable: Boolean?

Force iOS swipe on Android platform.

pages

val pages: dynamic

A dynamic property returning current pages stack.

swipeable

var swipeable: Boolean?

An iOS swipe to pop feature.

swipeTargetWidth

var swipeTargetWidth: Number?

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

swipeThreshold

var swipeThreshold: Number?

Specify how much the page needs to be swiped before popping.

topPage

val topPage: dynamic

A dynamic property returning current top page.

Functions

afterInsert

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

bringPageTop

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

Brings the given page to the top of the page stack.

buildAttributeSet

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

insertPage

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

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

Insert the specified page into the stack with at a position defined by the index argument.

onDeviceBackButton

open fun onDeviceBackButton(callback: (event: BackButtonEvent) -> Unit)

Sets device back button event listener.

onDeviceBackButtonClear

open fun onDeviceBackButtonClear()

Clears device back button event listener.

onSwipe

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

Sets swipe event listener.

onSwipeClear

open fun onSwipeClear()

Clears swipe event listener.

page

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

DSL builder extension function.

popPage

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

Pops the current page from the page stack.

pushPage

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

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

Pushes the specified page into the stack.

removePage

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

Remove the specified page at a position in the stack defined by the index argument.

render

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

replacePage

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

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

Replaces the current top page with the specified one.

resetToPage

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

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

Clears page stack and adds the specified page to the stack.