From fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sat, 26 Oct 2019 00:17:24 +0200 Subject: API documentation for KVision 2.0.0 --- .../-flex-panel/-init-.html | 33 +++ .../-flex-panel/add-all.html | 21 ++ .../pl.treksoft.kvision.panel/-flex-panel/add.html | 39 ++++ .../-flex-panel/align-content.html | 21 ++ .../-flex-panel/align-items.html | 21 ++ .../-flex-panel/direction.html | 21 ++ .../-flex-panel/flex-panel.html | 16 ++ .../-flex-panel/get-sn-style.html | 18 ++ .../-flex-panel/index.html | 229 +++++++++++++++++++++ .../-flex-panel/justify.html | 21 ++ .../-flex-panel/remove-all.html | 18 ++ .../-flex-panel/remove.html | 21 ++ .../-flex-panel/spacing.html | 21 ++ .../-flex-panel/wrap.html | 21 ++ 14 files changed, 521 insertions(+) create mode 100644 api1/pl.treksoft.kvision.panel/-flex-panel/-init-.html create mode 100644 api1/pl.treksoft.kvision.panel/-flex-panel/add-all.html create mode 100644 api1/pl.treksoft.kvision.panel/-flex-panel/add.html create mode 100644 api1/pl.treksoft.kvision.panel/-flex-panel/align-content.html create mode 100644 api1/pl.treksoft.kvision.panel/-flex-panel/align-items.html create mode 100644 api1/pl.treksoft.kvision.panel/-flex-panel/direction.html create mode 100644 api1/pl.treksoft.kvision.panel/-flex-panel/flex-panel.html create mode 100644 api1/pl.treksoft.kvision.panel/-flex-panel/get-sn-style.html create mode 100644 api1/pl.treksoft.kvision.panel/-flex-panel/index.html create mode 100644 api1/pl.treksoft.kvision.panel/-flex-panel/justify.html create mode 100644 api1/pl.treksoft.kvision.panel/-flex-panel/remove-all.html create mode 100644 api1/pl.treksoft.kvision.panel/-flex-panel/remove.html create mode 100644 api1/pl.treksoft.kvision.panel/-flex-panel/spacing.html create mode 100644 api1/pl.treksoft.kvision.panel/-flex-panel/wrap.html (limited to 'api1/pl.treksoft.kvision.panel/-flex-panel') diff --git a/api1/pl.treksoft.kvision.panel/-flex-panel/-init-.html b/api1/pl.treksoft.kvision.panel/-flex-panel/-init-.html new file mode 100644 index 00000000..f3d06b40 --- /dev/null +++ b/api1/pl.treksoft.kvision.panel/-flex-panel/-init-.html @@ -0,0 +1,33 @@ + + + +FlexPanel.<init> - kvision + + + +kvision / pl.treksoft.kvision.panel / FlexPanel / <init>
+
+

<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)

Parameters

+direction - flexbox direction

+wrap - flexbox wrap

+justify - flexbox content justification

+alignItems - flexbox items alignment

+alignContent - flexbox content alignment

+spacing - spacing between columns/rows

+classes - a set of CSS class names

+init - an initializer extension function

Constructor
+

+ + diff --git a/api1/pl.treksoft.kvision.panel/-flex-panel/add-all.html b/api1/pl.treksoft.kvision.panel/-flex-panel/add-all.html new file mode 100644 index 00000000..0d9db186 --- /dev/null +++ b/api1/pl.treksoft.kvision.panel/-flex-panel/add-all.html @@ -0,0 +1,21 @@ + + + +FlexPanel.addAll - kvision + + + +kvision / pl.treksoft.kvision.panel / FlexPanel / addAll
+
+

addAll

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

Overrides SimplePanel.addAll

Adds a list of components to the current container.

Parameters

+children - list of child components

Return
+current container

+ + diff --git a/api1/pl.treksoft.kvision.panel/-flex-panel/add.html b/api1/pl.treksoft.kvision.panel/-flex-panel/add.html new file mode 100644 index 00000000..fe953bd6 --- /dev/null +++ b/api1/pl.treksoft.kvision.panel/-flex-panel/add.html @@ -0,0 +1,39 @@ + + + +FlexPanel.add - kvision + + + +kvision / pl.treksoft.kvision.panel / FlexPanel / add
+
+

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.

Parameters

+child - child component

+order - child flexbox ordering

+grow - child flexbox grow

+shrink - child flexbox shrink

+basis - child flexbox basis

+alignSelf - child self alignment

+classes - a set of CSS class names

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

Overrides SimplePanel.add

Adds given component to the current container.

Parameters

+child - child component

Return
+current container

+ + diff --git a/api1/pl.treksoft.kvision.panel/-flex-panel/align-content.html b/api1/pl.treksoft.kvision.panel/-flex-panel/align-content.html new file mode 100644 index 00000000..f4df572f --- /dev/null +++ b/api1/pl.treksoft.kvision.panel/-flex-panel/align-content.html @@ -0,0 +1,21 @@ + + + +FlexPanel.alignContent - kvision + + + +kvision / pl.treksoft.kvision.panel / FlexPanel / alignContent
+
+

alignContent

+ +var alignContent: FlexAlignContent? +

CSS flexbox content alignment.

Getter
+

CSS flexbox content alignment.

Setter
+

CSS flexbox content alignment.

+ + diff --git a/api1/pl.treksoft.kvision.panel/-flex-panel/align-items.html b/api1/pl.treksoft.kvision.panel/-flex-panel/align-items.html new file mode 100644 index 00000000..b6d46129 --- /dev/null +++ b/api1/pl.treksoft.kvision.panel/-flex-panel/align-items.html @@ -0,0 +1,21 @@ + + + +FlexPanel.alignItems - kvision + + + +kvision / pl.treksoft.kvision.panel / FlexPanel / alignItems
+
+

alignItems

+ +var alignItems: FlexAlignItems? +

CSS flexbox items alignment.

Getter
+

CSS flexbox items alignment.

Setter
+

CSS flexbox items alignment.

+ + diff --git a/api1/pl.treksoft.kvision.panel/-flex-panel/direction.html b/api1/pl.treksoft.kvision.panel/-flex-panel/direction.html new file mode 100644 index 00000000..b4cb415a --- /dev/null +++ b/api1/pl.treksoft.kvision.panel/-flex-panel/direction.html @@ -0,0 +1,21 @@ + + + +FlexPanel.direction - kvision + + + +kvision / pl.treksoft.kvision.panel / FlexPanel / direction
+
+

direction

+ +var direction: FlexDir? +

CSS flexbox direction.

Getter
+

CSS flexbox direction.

Setter
+

CSS flexbox direction.

+ + diff --git a/api1/pl.treksoft.kvision.panel/-flex-panel/flex-panel.html b/api1/pl.treksoft.kvision.panel/-flex-panel/flex-panel.html new file mode 100644 index 00000000..0a3f453a --- /dev/null +++ b/api1/pl.treksoft.kvision.panel/-flex-panel/flex-panel.html @@ -0,0 +1,16 @@ + + + +FlexPanel.flexPanel - kvision + + + +kvision / pl.treksoft.kvision.panel / FlexPanel / flexPanel
+
+

flexPanel

+ +

fun Container.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): FlexPanel

DSL builder extension function.

It takes the same parameters as the constructor of the built component.

+ + diff --git a/api1/pl.treksoft.kvision.panel/-flex-panel/get-sn-style.html b/api1/pl.treksoft.kvision.panel/-flex-panel/get-sn-style.html new file mode 100644 index 00000000..32fccbed --- /dev/null +++ b/api1/pl.treksoft.kvision.panel/-flex-panel/get-sn-style.html @@ -0,0 +1,18 @@ + + + +FlexPanel.getSnStyle - kvision + + + +kvision / pl.treksoft.kvision.panel / FlexPanel / getSnStyle
+
+

getSnStyle

+ +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/api1/pl.treksoft.kvision.panel/-flex-panel/index.html b/api1/pl.treksoft.kvision.panel/-flex-panel/index.html new file mode 100644 index 00000000..28644f6d --- /dev/null +++ b/api1/pl.treksoft.kvision.panel/-flex-panel/index.html @@ -0,0 +1,229 @@ + + + +FlexPanel - kvision + + + +kvision / pl.treksoft.kvision.panel / FlexPanel
+
+

FlexPanel

+open class FlexPanel : SimplePanel +

The container with CSS flexbox layout support.

Constructors

+ + + + + + + +

<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)

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ alignContent +	+`var alignContent: FlexAlignContent?` + CSS flexbox content alignment. +
+ alignItems +	+`var alignItems: FlexAlignItems?` + CSS flexbox items alignment. +
+ direction +	+`var direction: FlexDir?` + CSS flexbox direction. +
+ justify +	+`var justify: FlexJustify?` + CSS flexbox content justification. +
+ spacing +	+`var spacing: Int?` + The spacing between columns/rows. +
+ wrap +	+`var wrap: FlexWrap?` + CSS flexbox wrap mode. +

Functions

+ + + + + + + + + + + + + + + + + + + + + + + +

+ 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` + Adds given component to the current container. +
+ addAll +	+`open fun addAll(children: List<Component>): FlexPanel` + Adds a list of components to the current container. +
+ getSnStyle +	+`open fun getSnStyle(): List<StringPair>` + Returns the list of String pairs defining CSS style attributes and their values. +
+ remove +	+`open fun remove(child: Component): FlexPanel` + Removes given component from the current container. +
+ removeAll +	+`open fun removeAll(): FlexPanel` + Removes all children from the current container. +

Inherited Functions

+ + + + + + + + + + + + + + + + + + + +

+ 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. +

Companion Object Functions

+ + + + + + + +

flexPanel

fun Container.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): FlexPanel

DSL builder extension function.

Extension Functions

+ + + + + + + +

createInstance

+fun <T> Any?.createInstance(vararg args: dynamic): T +

Helper function for creating JavaScript objects from dynamic constructors.

Inheritors

+ + + + + + + + + + + +

+ HPanel +	+`open class HPanel : FlexPanel` + The container with horizontal layout. +
+ VPanel +	+`open class VPanel : FlexPanel` + The container with vertical layout. +

+ + diff --git a/api1/pl.treksoft.kvision.panel/-flex-panel/justify.html b/api1/pl.treksoft.kvision.panel/-flex-panel/justify.html new file mode 100644 index 00000000..cef4e63f --- /dev/null +++ b/api1/pl.treksoft.kvision.panel/-flex-panel/justify.html @@ -0,0 +1,21 @@ + + + +FlexPanel.justify - kvision + + + +kvision / pl.treksoft.kvision.panel / FlexPanel / justify
+
+

justify

+ +var justify: FlexJustify? +

CSS flexbox content justification.

Getter
+

CSS flexbox content justification.

Setter
+

CSS flexbox content justification.

+ + diff --git a/api1/pl.treksoft.kvision.panel/-flex-panel/remove-all.html b/api1/pl.treksoft.kvision.panel/-flex-panel/remove-all.html new file mode 100644 index 00000000..4a5a9db9 --- /dev/null +++ b/api1/pl.treksoft.kvision.panel/-flex-panel/remove-all.html @@ -0,0 +1,18 @@ + + + +FlexPanel.removeAll - kvision + + + +kvision / pl.treksoft.kvision.panel / FlexPanel / removeAll
+
+

removeAll

+ +open fun removeAll(): FlexPanel +

Overrides SimplePanel.removeAll

Removes all children from the current container.

Return
+current container

+ + diff --git a/api1/pl.treksoft.kvision.panel/-flex-panel/remove.html b/api1/pl.treksoft.kvision.panel/-flex-panel/remove.html new file mode 100644 index 00000000..308625b1 --- /dev/null +++ b/api1/pl.treksoft.kvision.panel/-flex-panel/remove.html @@ -0,0 +1,21 @@ + + + +FlexPanel.remove - kvision + + + +kvision / pl.treksoft.kvision.panel / FlexPanel / remove
+
+

remove

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

Overrides SimplePanel.remove

Removes given component from the current container.

Parameters

+child - child component

Return
+current container

+ + diff --git a/api1/pl.treksoft.kvision.panel/-flex-panel/spacing.html b/api1/pl.treksoft.kvision.panel/-flex-panel/spacing.html new file mode 100644 index 00000000..4dc0bf66 --- /dev/null +++ b/api1/pl.treksoft.kvision.panel/-flex-panel/spacing.html @@ -0,0 +1,21 @@ + + + +FlexPanel.spacing - kvision + + + +kvision / pl.treksoft.kvision.panel / FlexPanel / spacing
+
+

spacing

+ +var spacing: Int? +

The spacing between columns/rows.

Getter
+

The spacing between columns/rows.

Setter
+

The spacing between columns/rows.

+ + diff --git a/api1/pl.treksoft.kvision.panel/-flex-panel/wrap.html b/api1/pl.treksoft.kvision.panel/-flex-panel/wrap.html new file mode 100644 index 00000000..4ae5640d --- /dev/null +++ b/api1/pl.treksoft.kvision.panel/-flex-panel/wrap.html @@ -0,0 +1,21 @@ + + + +FlexPanel.wrap - kvision + + + +kvision / pl.treksoft.kvision.panel / FlexPanel / wrap
+
+

wrap

+ +var wrap: FlexWrap? +

CSS flexbox wrap mode.

Getter
+

CSS flexbox wrap mode.

Setter
+

CSS flexbox wrap mode.

+ + -- cgit