From f3c9d405382dd81d426c7eab1f6390ec8e6dad00 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Mon, 5 Mar 2018 08:45:25 +0100 Subject: Documentation update. --- .../-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 | 215 --------------------- .../-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, 507 deletions(-) delete mode 100644 docs/api/pl.treksoft.kvision.panel/-flex-panel/-init-.html delete mode 100644 docs/api/pl.treksoft.kvision.panel/-flex-panel/add-all.html delete mode 100644 docs/api/pl.treksoft.kvision.panel/-flex-panel/add.html delete mode 100644 docs/api/pl.treksoft.kvision.panel/-flex-panel/align-content.html delete mode 100644 docs/api/pl.treksoft.kvision.panel/-flex-panel/align-items.html delete mode 100644 docs/api/pl.treksoft.kvision.panel/-flex-panel/direction.html delete mode 100644 docs/api/pl.treksoft.kvision.panel/-flex-panel/flex-panel.html delete mode 100644 docs/api/pl.treksoft.kvision.panel/-flex-panel/get-sn-style.html delete mode 100644 docs/api/pl.treksoft.kvision.panel/-flex-panel/index.html delete mode 100644 docs/api/pl.treksoft.kvision.panel/-flex-panel/justify.html delete mode 100644 docs/api/pl.treksoft.kvision.panel/-flex-panel/remove-all.html delete mode 100644 docs/api/pl.treksoft.kvision.panel/-flex-panel/remove.html delete mode 100644 docs/api/pl.treksoft.kvision.panel/-flex-panel/spacing.html delete mode 100644 docs/api/pl.treksoft.kvision.panel/-flex-panel/wrap.html (limited to 'docs/api/pl.treksoft.kvision.panel/-flex-panel') diff --git a/docs/api/pl.treksoft.kvision.panel/-flex-panel/-init-.html b/docs/api/pl.treksoft.kvision.panel/-flex-panel/-init-.html deleted file mode 100644 index 23a1d6e5..00000000 --- a/docs/api/pl.treksoft.kvision.panel/-flex-panel/-init-.html +++ /dev/null @@ -1,33 +0,0 @@ - - - -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/docs/api/pl.treksoft.kvision.panel/-flex-panel/add-all.html b/docs/api/pl.treksoft.kvision.panel/-flex-panel/add-all.html deleted file mode 100644 index 0d9db186..00000000 --- a/docs/api/pl.treksoft.kvision.panel/-flex-panel/add-all.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -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/docs/api/pl.treksoft.kvision.panel/-flex-panel/add.html b/docs/api/pl.treksoft.kvision.panel/-flex-panel/add.html deleted file mode 100644 index fe953bd6..00000000 --- a/docs/api/pl.treksoft.kvision.panel/-flex-panel/add.html +++ /dev/null @@ -1,39 +0,0 @@ - - - -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/docs/api/pl.treksoft.kvision.panel/-flex-panel/align-content.html b/docs/api/pl.treksoft.kvision.panel/-flex-panel/align-content.html deleted file mode 100644 index f4df572f..00000000 --- a/docs/api/pl.treksoft.kvision.panel/-flex-panel/align-content.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -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/docs/api/pl.treksoft.kvision.panel/-flex-panel/align-items.html b/docs/api/pl.treksoft.kvision.panel/-flex-panel/align-items.html deleted file mode 100644 index b6d46129..00000000 --- a/docs/api/pl.treksoft.kvision.panel/-flex-panel/align-items.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -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/docs/api/pl.treksoft.kvision.panel/-flex-panel/direction.html b/docs/api/pl.treksoft.kvision.panel/-flex-panel/direction.html deleted file mode 100644 index b4cb415a..00000000 --- a/docs/api/pl.treksoft.kvision.panel/-flex-panel/direction.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -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/docs/api/pl.treksoft.kvision.panel/-flex-panel/flex-panel.html b/docs/api/pl.treksoft.kvision.panel/-flex-panel/flex-panel.html deleted file mode 100644 index 4627c54e..00000000 --- a/docs/api/pl.treksoft.kvision.panel/-flex-panel/flex-panel.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -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/docs/api/pl.treksoft.kvision.panel/-flex-panel/get-sn-style.html b/docs/api/pl.treksoft.kvision.panel/-flex-panel/get-sn-style.html deleted file mode 100644 index 32fccbed..00000000 --- a/docs/api/pl.treksoft.kvision.panel/-flex-panel/get-sn-style.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -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/docs/api/pl.treksoft.kvision.panel/-flex-panel/index.html b/docs/api/pl.treksoft.kvision.panel/-flex-panel/index.html deleted file mode 100644 index 6bcd8aa8..00000000 --- a/docs/api/pl.treksoft.kvision.panel/-flex-panel/index.html +++ /dev/null @@ -1,215 +0,0 @@ - - - -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.

Inheritors

- - - - - - - - - - - -

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

- - diff --git a/docs/api/pl.treksoft.kvision.panel/-flex-panel/justify.html b/docs/api/pl.treksoft.kvision.panel/-flex-panel/justify.html deleted file mode 100644 index cef4e63f..00000000 --- a/docs/api/pl.treksoft.kvision.panel/-flex-panel/justify.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -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/docs/api/pl.treksoft.kvision.panel/-flex-panel/remove-all.html b/docs/api/pl.treksoft.kvision.panel/-flex-panel/remove-all.html deleted file mode 100644 index 4a5a9db9..00000000 --- a/docs/api/pl.treksoft.kvision.panel/-flex-panel/remove-all.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -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/docs/api/pl.treksoft.kvision.panel/-flex-panel/remove.html b/docs/api/pl.treksoft.kvision.panel/-flex-panel/remove.html deleted file mode 100644 index 308625b1..00000000 --- a/docs/api/pl.treksoft.kvision.panel/-flex-panel/remove.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -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/docs/api/pl.treksoft.kvision.panel/-flex-panel/spacing.html b/docs/api/pl.treksoft.kvision.panel/-flex-panel/spacing.html deleted file mode 100644 index 4dc0bf66..00000000 --- a/docs/api/pl.treksoft.kvision.panel/-flex-panel/spacing.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -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/docs/api/pl.treksoft.kvision.panel/-flex-panel/wrap.html b/docs/api/pl.treksoft.kvision.panel/-flex-panel/wrap.html deleted file mode 100644 index 4ae5640d..00000000 --- a/docs/api/pl.treksoft.kvision.panel/-flex-panel/wrap.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -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