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 --- .../-flex-panel/-init-.html | 2 +- .../-flex-panel/add-all.html | 3 +- api/pl.treksoft.kvision.panel/-flex-panel/add.html | 5 +- .../-flex-panel/align-content.html | 2 +- .../-flex-panel/align-items.html | 2 +- .../-flex-panel/direction.html | 2 +- .../-flex-panel/get-sn-style.html | 3 +- .../-flex-panel/index.html | 718 ++++++++++----------- .../-flex-panel/justify.html | 2 +- .../-flex-panel/remove-all.html | 3 +- .../-flex-panel/remove.html | 3 +- .../-flex-panel/spacing.html | 2 +- .../-flex-panel/wrap.html | 2 +- 13 files changed, 349 insertions(+), 400 deletions(-) (limited to 'api/pl.treksoft.kvision.panel/-flex-panel') diff --git a/api/pl.treksoft.kvision.panel/-flex-panel/-init-.html b/api/pl.treksoft.kvision.panel/-flex-panel/-init-.html index f3d06b40..a985a0db 100644 --- a/api/pl.treksoft.kvision.panel/-flex-panel/-init-.html +++ b/api/pl.treksoft.kvision.panel/-flex-panel/-init-.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.panel / FlexPanel / <init>

<init>

- +(js) FlexPanel(direction: FlexDir? = null, wrap: FlexWrap? = null, justify: FlexJustify? = null, alignItems: FlexAlignItems? = null, alignContent: FlexAlignContent? = null, spacing: Int? = null, classes: Set<String> = setOf(), init: (FlexPanel.() -> Unit)? = null)

Parameters

diff --git a/api/pl.treksoft.kvision.panel/-flex-panel/add-all.html b/api/pl.treksoft.kvision.panel/-flex-panel/add-all.html index 0d9db186..583548df 100644 --- a/api/pl.treksoft.kvision.panel/-flex-panel/add-all.html +++ b/api/pl.treksoft.kvision.panel/-flex-panel/add-all.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.panel / FlexPanel / addAll

addAll

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

Overrides SimplePanel.addAll

Adds a list of components to the current container.

Parameters

diff --git a/api/pl.treksoft.kvision.panel/-flex-panel/add.html b/api/pl.treksoft.kvision.panel/-flex-panel/add.html index fe953bd6..68b02903 100644 --- a/api/pl.treksoft.kvision.panel/-flex-panel/add.html +++ b/api/pl.treksoft.kvision.panel/-flex-panel/add.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.panel / FlexPanel / add

add

- +(js) fun add(child: Component, order: Int? = null, grow: Int? = null, shrink: Int? = null, basis: Int? = null, alignSelf: FlexAlignItems? = null, classes: Set<String> = setOf()): FlexPanel

Adds a component to the flexbox container.

Parameters

@@ -26,9 +26,8 @@ alignSelf - child self alignment

classes - a set of CSS class names

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

Overrides SimplePanel.add

Adds given component to the current container.

Parameters

diff --git a/api/pl.treksoft.kvision.panel/-flex-panel/align-content.html b/api/pl.treksoft.kvision.panel/-flex-panel/align-content.html index f4df572f..ba24818f 100644 --- a/api/pl.treksoft.kvision.panel/-flex-panel/align-content.html +++ b/api/pl.treksoft.kvision.panel/-flex-panel/align-content.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.panel / FlexPanel / alignContent

alignContent

- +(js) var alignContent: FlexAlignContent?

CSS flexbox content alignment.

Getter
diff --git a/api/pl.treksoft.kvision.panel/-flex-panel/align-items.html b/api/pl.treksoft.kvision.panel/-flex-panel/align-items.html index b6d46129..d773ee6d 100644 --- a/api/pl.treksoft.kvision.panel/-flex-panel/align-items.html +++ b/api/pl.treksoft.kvision.panel/-flex-panel/align-items.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.panel / FlexPanel / alignItems

alignItems

- +(js) var alignItems: FlexAlignItems?

CSS flexbox items alignment.

Getter
diff --git a/api/pl.treksoft.kvision.panel/-flex-panel/direction.html b/api/pl.treksoft.kvision.panel/-flex-panel/direction.html index b4cb415a..115f6393 100644 --- a/api/pl.treksoft.kvision.panel/-flex-panel/direction.html +++ b/api/pl.treksoft.kvision.panel/-flex-panel/direction.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.panel / FlexPanel / direction

direction

- +(js) var direction: FlexDir?

CSS flexbox direction.

Getter
diff --git a/api/pl.treksoft.kvision.panel/-flex-panel/get-sn-style.html b/api/pl.treksoft.kvision.panel/-flex-panel/get-sn-style.html index 32fccbed..e3c6dab7 100644 --- a/api/pl.treksoft.kvision.panel/-flex-panel/get-sn-style.html +++ b/api/pl.treksoft.kvision.panel/-flex-panel/get-sn-style.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.panel / FlexPanel / getSnStyle

getSnStyle

- +(js) protected open fun getSnStyle(): List<StringPair> -

Overrides StyledComponent.getSnStyle

Returns the list of String pairs defining CSS style attributes and their values.

Return
the list of attributes and their values

diff --git a/api/pl.treksoft.kvision.panel/-flex-panel/index.html b/api/pl.treksoft.kvision.panel/-flex-panel/index.html index 1bb02b74..5f0f357a 100644 --- a/api/pl.treksoft.kvision.panel/-flex-panel/index.html +++ b/api/pl.treksoft.kvision.panel/-flex-panel/index.html @@ -8,14 +8,15 @@ kvision / pl.treksoft.kvision.panel / FlexPanel

FlexPanel

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

The container with CSS flexbox layout support.

Constructors

@@ -27,69 +28,57 @@ +var alignContent: FlexAlignContent? +var alignItems: FlexAlignItems? +var direction: FlexDir? +var justify: FlexJustify? +var spacing: Int? - - -
-

<init>

+(js) +

<init>

FlexPanel(direction: FlexDir? = null, wrap: FlexWrap? = null, justify: FlexJustify? = null, alignItems: FlexAlignItems? = null, alignContent: FlexAlignContent? = null, spacing: Int? = null, classes: Set<String> = setOf(), init: (FlexPanel.() -> Unit)? = null)
-

alignContent

+(js) +

alignContent

-var alignContent: FlexAlignContent?

CSS flexbox content alignment.

-
-

alignItems

+(js) +

alignItems

-var alignItems: FlexAlignItems?

CSS flexbox items alignment.

-
-

direction

+(js) +

direction

-var direction: FlexDir?

CSS flexbox direction.

-
-

justify

+(js) +

justify

-var justify: FlexJustify?

CSS flexbox content justification.

-
-

spacing

+(js) +

spacing

-var spacing: Int?

The spacing between columns/rows.

-
-

wrap

+(js) +

wrap

-var wrap: FlexWrap?

CSS flexbox wrap mode.

-
-

Inherited Properties

- - - - - +var wrap: FlexWrap?
-

children

-
-val children: MutableList<Component>
@@ -98,91 +87,50 @@ -

add

+(js) +

add

-fun add(child: Component, order: Int? = null, grow: Int? = null, shrink: Int? = null, basis: Int? = null, alignSelf: FlexAlignItems? = null, classes: Set<String> = setOf()): FlexPanel

Adds a component to the flexbox container.

-open fun add(child: Component): FlexPanel +fun add(child: Component, order: Int? = null, grow: Int? = null, shrink: Int? = null, basis: Int? = null, alignSelf: FlexAlignItems? = null, classes: Set<String> = setOf()): FlexPanel

Adds given component to the current container.

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

addAll

+(js) +

addAll

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

Adds a list of components to the current container.

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

getSnStyle

+(js) +

getSnStyle

-open fun getSnStyle(): List<StringPair>

Returns the list of String pairs defining CSS style attributes and their values.

- +open fun getSnStyle(): List<StringPair> -

remove

+(js) +

remove

-open fun remove(child: Component): FlexPanel

Removes given component from the current container.

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

removeAll

+(js) +

removeAll

-open fun removeAll(): FlexPanel

Removes all children from the current container.

- - - - -

Inherited Functions

- - - - - - - - - - - - - - - - - +open fun removeAll(): FlexPanel
-

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.

-
@@ -191,24 +139,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> @@ -217,867 +168,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