kvision/io.kvision.panel

Package-level declarations

Rich set of container classes, supporting both simple use cases and sophisticated layouts (including CSS flexbox, CSS grid and Bootstrap responsive 12 columns gid).

Types

ContainerType

enum ContainerType : Enum<ContainerType>

Root container types.

Direction

enum Direction : Enum<Direction>

Split panel direction.

DockPanel

open class DockPanel(className: String? = null, init: DockPanel.() -> Unit? = null) : SimplePanel

The container with dock layout (up, down, left, right and center positions).

FieldsetPanel

open class FieldsetPanel(legend: String? = null, className: String? = null, init: FieldsetPanel.() -> Unit? = null) : SimplePanel

The HTML fieldset container.

FlexPanel

open class FlexPanel(direction: FlexDirection? = null, wrap: FlexWrap? = null, justify: JustifyContent? = null, alignItems: AlignItems? = null, alignContent: AlignContent? = null, spacing: Int? = null, useWrappers: Boolean = false, className: String? = null, init: FlexPanel.() -> Unit? = null) : SimplePanel

The container with CSS flexbox layout support.

GridPanel

open class GridPanel(autoColumns: String? = null, autoRows: String? = null, autoFlow: GridAutoFlow? = null, templateColumns: String? = null, templateRows: String? = null, templateAreas: List<String>? = null, columnGap: Int? = null, rowGap: Int? = null, justifyItems: JustifyItems? = null, alignItems: AlignItems? = null, justifyContent: JustifyContent? = null, alignContent: AlignContent? = null, useWrappers: Boolean = false, className: String? = null, init: GridPanel.() -> Unit? = null) : SimplePanel

The container with CSS grid layout support.

GridSize

enum GridSize : Enum<GridSize>

Bootstrap grid sizes.

GutterAlign

enum GutterAlign : Enum<GutterAlign>

Split panel gutter alignment.

HPanel

open class HPanel(wrap: FlexWrap? = null, justify: JustifyContent? = null, alignItems: AlignItems? = null, spacing: Int? = null, useWrappers: Boolean = false, className: String? = null, init: HPanel.() -> Unit? = null) : FlexPanel

The container with horizontal layout.

ResponsiveGridPanel

open class ResponsiveGridPanel(gridSize: GridSize = GridSize.MD, rows: Int = 0, cols: Int = 0, align: Align? = null, className: String? = null, init: ResponsiveGridPanel.() -> Unit? = null) : SimplePanel

The container with support for Bootstrap responsive grid layout.

Root

class Root : SimplePanel

Root container.

Side

enum Side : Enum<Side>

Dock layout directions.

SideTabSize

enum SideTabSize : Enum<SideTabSize>

Left or right tab size.

SimplePanel

open class SimplePanel(className: String? = null, init: SimplePanel.() -> Unit? = null) : Widget, Container

Basic container class, rendered as a DIV element with all children directly within.

SplitPanel

open class SplitPanel(direction: Direction = Direction.VERTICAL, className: String? = null, init: SplitPanel.() -> Unit? = null) : SimplePanel

The container with draggable splitter.

StackPanel

open class StackPanel(activateLast: Boolean = true, className: String? = null, init: StackPanel.() -> Unit? = null) : SimplePanel

The container with only one active (visible) child at any moment.

Tab

open class Tab(label: String? = null, icon: String? = null, image: ResString? = null, closable: Boolean = false, val route: String? = null, init: Tab.() -> Unit? = null) : Tag

The single Tab component inside the TabPanel container.

TabPanel

open class TabPanel(tabPosition: TabPosition = TabPosition.TOP, sideTabSize: SideTabSize = SideTabSize.SIZE_3, val scrollableTabs: Boolean = false, val draggableTabs: Boolean = false, className: String? = null, init: TabPanel.() -> Unit? = null) : SimplePanel

The container rendering its children as tabs.

TabPosition

enum TabPosition : Enum<TabPosition>

Tab position.

VPanel

open class VPanel(justify: JustifyContent? = null, alignItems: AlignItems? = null, spacing: Int? = null, useWrappers: Boolean = false, className: String? = null, init: VPanel.() -> Unit? = null) : FlexPanel

The container with vertical layout.

Functions

dockPanel

fun Container.dockPanel(className: String? = null, init: DockPanel.() -> Unit? = null): DockPanel

DSL builder extension function.

fieldsetPanel

fun Container.fieldsetPanel(legend: String? = null, className: String? = null, init: FieldsetPanel.() -> Unit? = null): FieldsetPanel

DSL builder extension function.

flexPanel

fun Container.flexPanel(direction: FlexDirection? = null, wrap: FlexWrap? = null, justify: JustifyContent? = null, alignItems: AlignItems? = null, alignContent: AlignContent? = null, spacing: Int? = null, useWrappers: Boolean = false, className: String? = null, init: FlexPanel.() -> Unit? = null): FlexPanel

DSL builder extension function.

gridPanel

fun Container.gridPanel(autoColumns: String? = null, autoRows: String? = null, autoFlow: GridAutoFlow? = null, templateColumns: String? = null, templateRows: String? = null, templateAreas: List<String>? = null, columnGap: Int? = null, rowGap: Int? = null, justifyItems: JustifyItems? = null, alignItems: AlignItems? = null, justifyContent: JustifyContent? = null, alignContent: AlignContent? = null, useWrappers: Boolean = false, className: String? = null, init: GridPanel.() -> Unit? = null): GridPanel

DSL builder extension function.

hPanel

fun Container.hPanel(wrap: FlexWrap? = null, justify: JustifyContent? = null, alignItems: AlignItems? = null, spacing: Int? = null, useWrappers: Boolean = false, className: String? = null, init: HPanel.() -> Unit? = null): HPanel

DSL builder extension function.

responsiveGridPanel

fun Container.responsiveGridPanel(gridSize: GridSize = GridSize.MD, rows: Int = 0, cols: Int = 0, align: Align? = null, className: String? = null, init: ResponsiveGridPanel.() -> Unit? = null): ResponsiveGridPanel

DSL builder extension function.

root

fun Application.root(element: <Error class: unknown class>, containerType: ContainerType = ContainerType.NONE, addRow: Boolean = containerType != ContainerType.FIXED && containerType != ContainerType.NONE, init: Root.() -> Unit? = null): Root

Create new Root container based on HTML element

fun Application.root(id: String, containerType: ContainerType = ContainerType.NONE, addRow: Boolean = containerType != ContainerType.FIXED && containerType != ContainerType.NONE, init: Root.() -> Unit? = null): Root

Create new Root container based on ID

simplePanel

fun Container.simplePanel(vararg styles: Style, init: SimplePanel.() -> Unit? = null): SimplePanel

DSL builder extension function with Style support

fun Container.simplePanel(className: String? = null, init: SimplePanel.() -> Unit? = null): SimplePanel

DSL builder extension function.

splitPanel

fun Container.splitPanel(direction: Direction = Direction.VERTICAL, className: String? = null, init: SplitPanel.() -> Unit? = null): SplitPanel

DSL builder extension function.

stackPanel

fun Container.stackPanel(activateLast: Boolean = true, className: String? = null, init: StackPanel.() -> Unit? = null): StackPanel

DSL builder extension function.

tab

fun TabPanel.tab(label: String? = null, icon: String? = null, image: ResString? = null, closable: Boolean = false, route: String? = null, init: Tab.() -> Unit? = null): Tab

DSL builder extension function.

tabPanel

fun Container.tabPanel(tabPosition: TabPosition = TabPosition.TOP, sideTabSize: SideTabSize = SideTabSize.SIZE_3, scrollableTabs: Boolean = false, draggableTabs: Boolean = false, className: String? = null, init: TabPanel.() -> Unit? = null): TabPanel

DSL builder extension function.

vPanel

fun Container.vPanel(justify: JustifyContent? = null, alignItems: AlignItems? = null, spacing: Int? = null, useWrappers: Boolean = false, className: String? = null, init: VPanel.() -> Unit? = null): VPanel

DSL builder extension function.