From 0365722f8549ee93918be99da1b9f901cf0b2c8d Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Fri, 13 Mar 2020 01:05:20 +0100 Subject: API documentation for KVision 3.5.2 --- .../-tab-panel/-init-.html | 2 +- .../-tab-panel/active-index.html | 2 +- .../-tab-panel/add-all.html | 3 +- .../-tab-panel/add-tab.html | 2 +- api/pl.treksoft.kvision.panel/-tab-panel/add.html | 3 +- .../-tab-panel/get-child-component.html | 2 +- .../-tab-panel/get-nav-component.html | 2 +- .../-tab-panel/index.html | 692 ++++++++++----------- .../-tab-panel/remove-all.html | 3 +- .../-tab-panel/remove-tab.html | 2 +- .../-tab-panel/remove.html | 3 +- 11 files changed, 333 insertions(+), 383 deletions(-) (limited to 'api/pl.treksoft.kvision.panel/-tab-panel') diff --git a/api/pl.treksoft.kvision.panel/-tab-panel/-init-.html b/api/pl.treksoft.kvision.panel/-tab-panel/-init-.html index 76a3400c..92711980 100644 --- a/api/pl.treksoft.kvision.panel/-tab-panel/-init-.html +++ b/api/pl.treksoft.kvision.panel/-tab-panel/-init-.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.panel / TabPanel / <init>

<init>

- +(js) TabPanel(tabPosition: TabPosition = TabPosition.TOP, sideTabSize: SideTabSize = SideTabSize.SIZE_3, scrollableTabs: Boolean = false, classes: Set<String> = setOf(), init: (TabPanel.() -> Unit)? = null)

Parameters

diff --git a/api/pl.treksoft.kvision.panel/-tab-panel/active-index.html b/api/pl.treksoft.kvision.panel/-tab-panel/active-index.html index 01be57ab..51b3d1d4 100644 --- a/api/pl.treksoft.kvision.panel/-tab-panel/active-index.html +++ b/api/pl.treksoft.kvision.panel/-tab-panel/active-index.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.panel / TabPanel / activeIndex

activeIndex

- +(js) var activeIndex: Int

The index of active (visible) tab.

diff --git a/api/pl.treksoft.kvision.panel/-tab-panel/add-all.html b/api/pl.treksoft.kvision.panel/-tab-panel/add-all.html index 73a08956..1444ff0e 100644 --- a/api/pl.treksoft.kvision.panel/-tab-panel/add-all.html +++ b/api/pl.treksoft.kvision.panel/-tab-panel/add-all.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.panel / TabPanel / addAll

addAll

- +(js) open fun addAll(children: List<Component>): TabPanel -

Overrides SimplePanel.addAll

Adds a list of components to the current container.

Parameters

diff --git a/api/pl.treksoft.kvision.panel/-tab-panel/add-tab.html b/api/pl.treksoft.kvision.panel/-tab-panel/add-tab.html index fd140749..7481b612 100644 --- a/api/pl.treksoft.kvision.panel/-tab-panel/add-tab.html +++ b/api/pl.treksoft.kvision.panel/-tab-panel/add-tab.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.panel / TabPanel / addTab

addTab

- +(js) open fun addTab(title: String, panel: Component, icon: String? = null, image: ResString? = null, closable: Boolean = false, route: String? = null): TabPanel

Adds new tab and optionally bounds it's activation to a given route.

Parameters

diff --git a/api/pl.treksoft.kvision.panel/-tab-panel/add.html b/api/pl.treksoft.kvision.panel/-tab-panel/add.html index 21369b50..081ce708 100644 --- a/api/pl.treksoft.kvision.panel/-tab-panel/add.html +++ b/api/pl.treksoft.kvision.panel/-tab-panel/add.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.panel / TabPanel / add

add

- +(js) open fun add(child: Component): TabPanel -

Overrides SimplePanel.add

Adds given component to the current container.

Parameters

diff --git a/api/pl.treksoft.kvision.panel/-tab-panel/get-child-component.html b/api/pl.treksoft.kvision.panel/-tab-panel/get-child-component.html index a5e88799..87281ec1 100644 --- a/api/pl.treksoft.kvision.panel/-tab-panel/get-child-component.html +++ b/api/pl.treksoft.kvision.panel/-tab-panel/get-child-component.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.panel / TabPanel / getChildComponent

getChildComponent

- +(js) open fun getChildComponent(index: Int): Component?

Returns child component by tab index.

Parameters

diff --git a/api/pl.treksoft.kvision.panel/-tab-panel/get-nav-component.html b/api/pl.treksoft.kvision.panel/-tab-panel/get-nav-component.html index 825aaccd..83f20d74 100644 --- a/api/pl.treksoft.kvision.panel/-tab-panel/get-nav-component.html +++ b/api/pl.treksoft.kvision.panel/-tab-panel/get-nav-component.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.panel / TabPanel / getNavComponent

getNavComponent

- +(js) open fun getNavComponent(index: Int): Tag?

Returns tab header component by tab index.

Parameters

diff --git a/api/pl.treksoft.kvision.panel/-tab-panel/index.html b/api/pl.treksoft.kvision.panel/-tab-panel/index.html index 3a974d31..eb659f72 100644 --- a/api/pl.treksoft.kvision.panel/-tab-panel/index.html +++ b/api/pl.treksoft.kvision.panel/-tab-panel/index.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.panel / TabPanel

TabPanel

-open class TabPanel : SimplePanel +(js) open class TabPanel : SimplePanel

The container rendering it's children as tabs.

It supports activating children by a JavaScript route.

Constructors

@@ -16,7 +16,8 @@ -

<init>

+(js) +

<init>

TabPanel(tabPosition: TabPosition = TabPosition.TOP, sideTabSize: SideTabSize = SideTabSize.SIZE_3, scrollableTabs: Boolean = false, classes: Set<String> = setOf(), init: (TabPanel.() -> Unit)? = null) @@ -28,24 +29,12 @@ -

activeIndex

+(js) +

activeIndex

-var activeIndex: Int

The index of active (visible) tab.

- - - - -

Inherited Properties

- - - - - +var activeIndex: Int
-

children

-		 -val children: MutableList<Component>
@@ -54,116 +43,75 @@ -

add

+(js) +

add

-open fun add(child: Component): TabPanel

Adds given component to the current container.

- +open fun add(child: Component): TabPanel -

addAll

+(js) +

addAll

-open fun addAll(children: List<Component>): TabPanel

Adds a list of components to the current container.

- +open fun addAll(children: List<Component>): TabPanel -

addTab

+(js) +

addTab

-open fun addTab(title: String, panel: Component, icon: String? = null, image: ResString? = null, closable: Boolean = false, route: String? = null): TabPanel

Adds new tab and optionally bounds it's activation to a given route.

- +open fun addTab(title: String, panel: Component, icon: String? = null, image: ResString? = null, closable: Boolean = false, route: String? = null): TabPanel -

getChildComponent

+(js) +

getChildComponent

-open fun getChildComponent(index: Int): Component?

Returns child component by tab index.

- +open fun getChildComponent(index: Int): Component? -

getNavComponent

+(js) +

getNavComponent

-open fun getNavComponent(index: Int): Tag?

Returns tab header component by tab index.

- +open fun getNavComponent(index: Int): Tag? -

remove

+(js) +

remove

-open fun remove(child: Component): TabPanel

Removes given component from the current container.

- +open fun remove(child: Component): TabPanel -

removeAll

+(js) +

removeAll

-open fun removeAll(): TabPanel

Removes all children from the current container.

- +open fun removeAll(): TabPanel -

removeTab

+(js) +

removeTab

-open fun removeTab(index: Int): TabPanel

Removes tab at given index.

- - - - -

Inherited Functions

- - - - - - - - - - - - - - - - - +open fun removeTab(index: Int): TabPanel
-

addInternal

-		 -fun addInternal(child: Component): SimplePanel -

Protected and final method to add given component to the current container.

-
-

childrenVNodes

-		 -open fun childrenVNodes(): Array<VNode> -

Returns the array of the children Snabbdom vnodes.

-
-

getChildren

-		 -open fun getChildren(): List<Component> -

Returns a list of children of the current container.

-
-

render

-		 -open fun render(): VNode -

Renders current component as a Snabbdom vnode.

-
@@ -172,24 +120,27 @@ -

changeFlow

+(js) +

changeFlow

-val <T : Widget> T.changeFlow: <ERROR CLASS><T> +val <T : Widget> T.changeFlow: Flow<T> -

clickFlow

+(js) +

clickFlow

-val <T : Widget> T.clickFlow: <ERROR CLASS><T> +val <T : Widget> T.clickFlow: Flow<T> -

inputFlow

+(js) +

inputFlow

-val <T : Widget> T.inputFlow: <ERROR CLASS><T> +val <T : Widget> T.inputFlow: Flow<T> @@ -198,867 +149,870 @@ -

addBsBgColor

+(js) +

addBsBgColor

fun Component.addBsBgColor(bsBgColor: BsBgColor): Unit -

addBsBorder

+(js) +

addBsBorder

fun Component.addBsBorder(vararg bsBorder: BsBorder): Unit -

addBsClearfix

+(js) +

addBsClearfix

fun Component.addBsClearfix(): Unit -

addBsColor

+(js) +

addBsColor

fun Component.addBsColor(bsColor: BsColor): Unit -

addBsRounded

+(js) +

addBsRounded

fun Component.addBsRounded(vararg bsRounded: BsRounded): Unit -

bold

+(js) +

bold

-fun Container.bold(content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: (Bold.() -> Unit)? = null): Bold

DSL builder extension function.

- +fun Container.bold(content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: (Bold.() -> Unit)? = null): Bold -

button

+(js) +

button

-fun Container.button(text: String, icon: String? = null, style: ButtonStyle = ButtonStyle.PRIMARY, type: ButtonType = ButtonType.BUTTON, disabled: Boolean = false, classes: Set<String> = setOf(), init: (Button.() -> Unit)? = null): Button

DSL builder extension function.

- +fun Container.button(text: String, icon: String? = null, style: ButtonStyle = ButtonStyle.PRIMARY, type: ButtonType = ButtonType.BUTTON, disabled: Boolean = false, classes: Set<String> = setOf(),