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 +	+`v`