From 7c2850063697f94a0d8b8d8f8588136dd4b3d05e Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sun, 21 Oct 2018 23:59:34 +0200 Subject: API documentation for KVision 0.0.19 --- .../-grid-panel/-init-.html | 45 ++++ .../-grid-panel/add-all.html | 21 ++ .../pl.treksoft.kvision.panel/-grid-panel/add.html | 45 ++++ .../-grid-panel/align-content.html | 21 ++ .../-grid-panel/align-items.html | 21 ++ .../-grid-panel/auto-columns.html | 21 ++ .../-grid-panel/auto-flow.html | 21 ++ .../-grid-panel/auto-rows.html | 21 ++ .../-grid-panel/column-gap.html | 21 ++ .../-grid-panel/get-sn-style.html | 18 ++ .../-grid-panel/grid-panel.html | 16 ++ .../-grid-panel/index.html | 246 +++++++++++++++++++++ .../-grid-panel/justify-content.html | 21 ++ .../-grid-panel/justify-items.html | 21 ++ .../-grid-panel/remove-all.html | 18 ++ .../-grid-panel/remove.html | 21 ++ .../-grid-panel/row-gap.html | 21 ++ .../-grid-panel/template-areas.html | 21 ++ .../-grid-panel/template-columns.html | 21 ++ .../-grid-panel/template-rows.html | 21 ++ 20 files changed, 682 insertions(+) create mode 100644 api/kvision/pl.treksoft.kvision.panel/-grid-panel/-init-.html create mode 100644 api/kvision/pl.treksoft.kvision.panel/-grid-panel/add-all.html create mode 100644 api/kvision/pl.treksoft.kvision.panel/-grid-panel/add.html create mode 100644 api/kvision/pl.treksoft.kvision.panel/-grid-panel/align-content.html create mode 100644 api/kvision/pl.treksoft.kvision.panel/-grid-panel/align-items.html create mode 100644 api/kvision/pl.treksoft.kvision.panel/-grid-panel/auto-columns.html create mode 100644 api/kvision/pl.treksoft.kvision.panel/-grid-panel/auto-flow.html create mode 100644 api/kvision/pl.treksoft.kvision.panel/-grid-panel/auto-rows.html create mode 100644 api/kvision/pl.treksoft.kvision.panel/-grid-panel/column-gap.html create mode 100644 api/kvision/pl.treksoft.kvision.panel/-grid-panel/get-sn-style.html create mode 100644 api/kvision/pl.treksoft.kvision.panel/-grid-panel/grid-panel.html create mode 100644 api/kvision/pl.treksoft.kvision.panel/-grid-panel/index.html create mode 100644 api/kvision/pl.treksoft.kvision.panel/-grid-panel/justify-content.html create mode 100644 api/kvision/pl.treksoft.kvision.panel/-grid-panel/justify-items.html create mode 100644 api/kvision/pl.treksoft.kvision.panel/-grid-panel/remove-all.html create mode 100644 api/kvision/pl.treksoft.kvision.panel/-grid-panel/remove.html create mode 100644 api/kvision/pl.treksoft.kvision.panel/-grid-panel/row-gap.html create mode 100644 api/kvision/pl.treksoft.kvision.panel/-grid-panel/template-areas.html create mode 100644 api/kvision/pl.treksoft.kvision.panel/-grid-panel/template-columns.html create mode 100644 api/kvision/pl.treksoft.kvision.panel/-grid-panel/template-rows.html (limited to 'api/kvision/pl.treksoft.kvision.panel/-grid-panel') diff --git a/api/kvision/pl.treksoft.kvision.panel/-grid-panel/-init-.html b/api/kvision/pl.treksoft.kvision.panel/-grid-panel/-init-.html new file mode 100644 index 00000000..799216df --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.panel/-grid-panel/-init-.html @@ -0,0 +1,45 @@ + + + +GridPanel.<init> - kvision + + + +kvision / pl.treksoft.kvision.panel / GridPanel / <init>
+
+

<init>

+ +

GridPanel(autoColumns: String? = null, autoRows: String? = null, autoFlow: GridFlow? = null, templateColumns: String? = null, templateRows: String? = null, templateAreas: List<String>? = null, columnGap: Int? = null, rowGap: Int? = null, justifyItems: GridJustify? = null, alignItems: GridAlign? = null, justifyContent: GridJustifyContent? = null, alignContent: GridAlignContent? = null, classes: Set<String> = setOf(), init: GridPanel.() -> Unit = null)

Parameters

+autoColumns - grid auto columns

+autoRows - grid auto rows

+autoFlow - grid auto flow

+templateColumns - grid columns template

+templateRows - grid rows template

+templateAreas - grid areas template

+columnGap - grid column gap

+rowGap - grid row gap

+justifyItems - grid items justification

+alignItems - grid items alignment

+justifyContent - flexbox content justification

+alignContent - flexbox content alignment

+classes - a set of CSS class names

+init - an initializer extension function

Constructor
+

+ + diff --git a/api/kvision/pl.treksoft.kvision.panel/-grid-panel/add-all.html b/api/kvision/pl.treksoft.kvision.panel/-grid-panel/add-all.html new file mode 100644 index 00000000..c66d1169 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.panel/-grid-panel/add-all.html @@ -0,0 +1,21 @@ + + + +GridPanel.addAll - kvision + + + +kvision / pl.treksoft.kvision.panel / GridPanel / addAll
+
+

addAll

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

Overrides SimplePanel.addAll

Adds a list of components to the current container.

Parameters

+children - list of child components

Return
+current container

+ + diff --git a/api/kvision/pl.treksoft.kvision.panel/-grid-panel/add.html b/api/kvision/pl.treksoft.kvision.panel/-grid-panel/add.html new file mode 100644 index 00000000..8948ae0d --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.panel/-grid-panel/add.html @@ -0,0 +1,45 @@ + + + +GridPanel.add - kvision + + + +kvision / pl.treksoft.kvision.panel / GridPanel / add
+
+

add

+ +

fun add(child: Component, columnStart: Int? = null, rowStart: Int? = null, columnEnd: String? = null, rowEnd: String? = null, area: String? = null, justifySelf: GridJustify? = null, alignSelf: GridAlign? = null, classes: Set<String> = setOf()): GridPanel

Adds a component to the grid container.

Parameters

+child - child component

+columnStart - number of starting column

+rowStart - number of starting row

+columnEnd - number of ending column

+rowEnd - number of ending row

+area - grid area

+justifySelf - child self justification

+alignSelf - child self alignment

+classes - a set of CSS class names

Return
+current container

+ +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/kvision/pl.treksoft.kvision.panel/-grid-panel/grid-panel.html b/api/kvision/pl.treksoft.kvision.panel/-grid-panel/grid-panel.html new file mode 100644 index 00000000..777636fe --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.panel/-grid-panel/grid-panel.html @@ -0,0 +1,16 @@ + + + +GridPanel.gridPanel - kvision + + + +kvision / pl.treksoft.kvision.panel / GridPanel / gridPanel
+
+

gridPanel

+ +

fun Container.gridPanel(autoColumns: String? = null, autoRows: String? = null, autoFlow: GridFlow? = null, templateColumns: String? = null, templateRows: String? = null, templateAreas: List<String>? = null, columnGap: Int? = null, rowGap: Int? = null, justifyItems: GridJustify? = null, alignItems: GridAlign? = null, justifyContent: GridJustifyContent? = null, alignContent: GridAlignContent? = null, classes: Set<String> = setOf(), init: GridPanel.() -> Unit = null): GridPanel

DSL builder extension function.

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

+ + diff --git a/api/kvision/pl.treksoft.kvision.panel/-grid-panel/index.html b/api/kvision/pl.treksoft.kvision.panel/-grid-panel/index.html new file mode 100644 index 00000000..6d933d58 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.panel/-grid-panel/index.html @@ -0,0 +1,246 @@ + + + +GridPanel - kvision + + + +kvision / pl.treksoft.kvision.panel / GridPanel
+
+

GridPanel

+open class GridPanel : SimplePanel +

The container with CSS grid layout support.

Constructors

+ + + + + + + +

<init>

GridPanel(autoColumns: String? = null, autoRows: String? = null, autoFlow: GridFlow? = null, templateColumns: String? = null, templateRows: String? = null, templateAreas: List<String>? = null, columnGap: Int? = null, rowGap: Int? = null, justifyItems: GridJustify? = null, alignItems: GridAlign? = null, justifyContent: GridJustifyContent? = null, alignContent: GridAlignContent? = null, classes: Set<String> = setOf(), init: GridPanel.() -> Unit = null)

Properties

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

+ alignContent +	+`var alignContent: GridAlignContent?` + CSS grid content alignment. +
+ alignItems +	+`var alignItems: GridAlign?` + CSS grid items alignment. +
+ autoColumns +	+`var autoColumns: String?` + CSS grid auto columns. +
+ autoFlow +	+`var autoFlow: GridFlow?` + CSS grid auto flow. +
+ autoRows +	+`var autoRows: String?` + CSS grid auto rows. +
+ columnGap +	+`var columnGap: Int?` + CSS grid column gap. +
+ justifyContent +	+`var justifyContent: GridJustifyContent?` + CSS grid content justification. +
+ justifyItems +	+`var justifyItems: GridJustify?` + CSS grid items justification. +
+ rowGap +	+`var rowGap: Int?` + CSS grid row gap. +
+ templateAreas +	+`var templateAreas: List<String>?` + CSS grid areas template. +
+ templateColumns +	+`var templateColumns: String?` + CSS grid columns template. +
+ templateRows +	+`var templateRows: String?` + CSS grid rows template. +

Functions

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

+ add +	+`fun add(child: Component, columnStart: Int? = null, rowStart: Int? = null, columnEnd: String? = null, rowEnd: String? = null, area: String? = null, justifySelf: GridJustify? = null, alignSelf: GridAlign? = null, classes: Set<String> = setOf()): GridPanel` + Adds a component to the grid container. +`open fun add(child: Component): GridPanel` + Adds given component to the current container. +
+ addAll +	+`open fun addAll(children: List<Component>): GridPanel` + 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): GridPanel` + Removes given component from the current container. +
+ removeAll +	+`open fun removeAll(): GridPanel` + 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

+ + + + + + + +

gridPanel

fun Container.gridPanel(autoColumns: String? = null, autoRows: String? = null, autoFlow: GridFlow? = null, templateColumns: String? = null, templateRows: String? = null, templateAreas: List<String>? = null, columnGap: Int? = null, rowGap: Int? = null, justifyItems: GridJustify? = null, alignItems: GridAlign? = null, justifyContent: GridJustifyContent? = null, alignContent: GridAlignContent? = null, classes: Set<String> = setOf(), init: GridPanel.() -> Unit = null): GridPanel

DSL builder extension function.

+ + diff --git a/api/kvision/pl.treksoft.kvision.panel/-grid-panel/justify-content.html b/api/kvision/pl.treksoft.kvision.panel/-grid-panel/justify-content.html new file mode 100644 index 00000000..9f5a87b1 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.panel/-grid-panel/justify-content.html @@ -0,0 +1,21 @@ + + + +GridPanel.justifyContent - kvision + + + +kvision / pl.treksoft.kvision.panel / GridPanel / justifyContent
+
+

justifyContent

+ +var justifyContent: GridJustifyContent? +

CSS grid content justification.

Getter
+

CSS grid content justification.

Setter
+

CSS grid content justification.

+ + diff --git a/api/kvision/pl.treksoft.kvision.panel/-grid-panel/justify-items.html b/api/kvision/pl.treksoft.kvision.panel/-grid-panel/justify-items.html new file mode 100644 index 00000000..d2a8d1e9 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.panel/-grid-panel/justify-items.html @@ -0,0 +1,21 @@ + + + +GridPanel.justifyItems - kvision + + + +kvision / pl.treksoft.kvision.panel / GridPanel / justifyItems
+
+

justifyItems

+ +var justifyItems: GridJustify? +

CSS grid items justification.

Getter
+

CSS grid items justification.

Setter
+

CSS grid items justification.

+ + diff --git a/api/kvision/pl.treksoft.kvision.panel/-grid-panel/remove-all.html b/api/kvision/pl.treksoft.kvision.panel/-grid-panel/remove-all.html new file mode 100644 index 00000000..3406e020 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.panel/-grid-panel/remove-all.html @@ -0,0 +1,18 @@ + + + +GridPanel.removeAll - kvision + + + +kvision / pl.treksoft.kvision.panel / GridPanel / removeAll
+
+

removeAll

+ +open fun removeAll(): GridPanel +

Overrides SimplePanel.removeAll

Removes all children from the current container.

Return
+current container

+ + diff --git a/api/kvision/pl.treksoft.kvision.panel/-grid-panel/remove.html b/api/kvision/pl.treksoft.kvision.panel/-grid-panel/remove.html new file mode 100644 index 00000000..4ba69b23 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.panel/-grid-panel/remove.html @@ -0,0 +1,21 @@ + + + +GridPanel.remove - kvision + + + +kvision / pl.treksoft.kvision.panel / GridPanel / remove
+
+

remove

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

Overrides SimplePanel.remove

Removes given component from the current container.

Parameters

+child - child component

Return
+current container

+ + diff --git a/api/kvision/pl.treksoft.kvision.panel/-grid-panel/row-gap.html b/api/kvision/pl.treksoft.kvision.panel/-grid-panel/row-gap.html new file mode 100644 index 00000000..61bfb039 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.panel/-grid-panel/row-gap.html @@ -0,0 +1,21 @@ + + + +GridPanel.rowGap - kvision + + + +kvision / pl.treksoft.kvision.panel / GridPanel / rowGap
+
+

rowGap

+ +var rowGap: Int? +

CSS grid row gap.

Getter
+

CSS grid row gap.

Setter
+

CSS grid row gap.

+ + diff --git a/api/kvision/pl.treksoft.kvision.panel/-grid-panel/template-areas.html b/api/kvision/pl.treksoft.kvision.panel/-grid-panel/template-areas.html new file mode 100644 index 00000000..8cc09bb2 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.panel/-grid-panel/template-areas.html @@ -0,0 +1,21 @@ + + + +GridPanel.templateAreas - kvision + + + +kvision / pl.treksoft.kvision.panel / GridPanel / templateAreas
+
+

templateAreas

+ +var templateAreas: List<String>? +

CSS grid areas template.

Getter
+

CSS grid areas template.

Setter
+

CSS grid areas template.

+ + diff --git a/api/kvision/pl.treksoft.kvision.panel/-grid-panel/template-columns.html b/api/kvision/pl.treksoft.kvision.panel/-grid-panel/template-columns.html new file mode 100644 index 00000000..0d1923ac --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.panel/-grid-panel/template-columns.html @@ -0,0 +1,21 @@ + + + +GridPanel.templateColumns - kvision + + + +kvision / pl.treksoft.kvision.panel / GridPanel / templateColumns
+
+

templateColumns

+ +var templateColumns: String? +

CSS grid columns template.

Getter
+

CSS grid columns template.

Setter
+

CSS grid columns template.

+ + diff --git a/api/kvision/pl.treksoft.kvision.panel/-grid-panel/template-rows.html b/api/kvision/pl.treksoft.kvision.panel/-grid-panel/template-rows.html new file mode 100644 index 00000000..95a8f91c --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.panel/-grid-panel/template-rows.html @@ -0,0 +1,21 @@ + + + +GridPanel.templateRows - kvision + + + +kvision / pl.treksoft.kvision.panel / GridPanel / templateRows
+
+

templateRows

+ +var templateRows: String? +

CSS grid rows template.

Getter
+

CSS grid rows template.

Setter
+

CSS grid rows template.

+ + -- cgit