kvision / pl.treksoft.kvision.panel

Package pl.treksoft.kvision.panel

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

(js)

ContainerType

Root container types.

enum class ContainerType
(js)

Direction

Split panel direction.

enum class Direction
(js)

DockPanel

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

open class DockPanel : SimplePanel
(js)

FieldsetPanel

The HTML fieldset container.

open class FieldsetPanel : SimplePanel
(js)

FlexAlignContent

CSS flexbox content alignment options.

enum class FlexAlignContent
(js)

FlexAlignItems

CSS flexbox alignments options.

enum class FlexAlignItems
(js)

FlexDir

CSS flexbox directions.

enum class FlexDir
(js)

FlexJustify

CSS flexbox justification options.

enum class FlexJustify
(js)

FlexPanel

The container with CSS flexbox layout support.

open class FlexPanel : SimplePanel
(js)

FlexWrap

CSS flexbox wrap modes.

enum class FlexWrap
(js)

GridAlign

CSS grid alignment options.

enum class GridAlign
(js)

GridAlignContent

CSS grid content alignment options.

enum class GridAlignContent
(js)

GridFlow

CSS grid flow options.

enum class GridFlow
(js)

GridJustify

CSS grid justification options.

enum class GridJustify
(js)

GridJustifyContent

CSS grid content justification options.

enum class GridJustifyContent
(js)

GridPanel

The container with CSS grid layout support.

open class GridPanel : SimplePanel
(js)

GridSize

Bootstrap grid sizes.

enum class GridSize
(js)

GridWrapper

class GridWrapper : WidgetWrapper
(js)

HPanel

The container with horizontal layout.

open class HPanel : FlexPanel
(js)

ResponsiveGridPanel

The container with support for Bootstrap responsive grid layout.

open class ResponsiveGridPanel : SimplePanel
(js)

Root

Root container.

class Root : SimplePanel
(js)

Side

Dock layout directions.

enum class Side
(js)

SideTabSize

Left or right tab size.

enum class SideTabSize
(js)

SimplePanel

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

open class SimplePanel : Widget, Container
(js)

SplitPanel

The container with draggable splitter.

open class SplitPanel : SimplePanel
(js)

StackPanel

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

open class StackPanel : SimplePanel
(js)

TabPanel

The container rendering it's children as tabs.

open class TabPanel : SimplePanel
(js)

TabPosition

Tab position.

enum class TabPosition
(js)

VPanel

The container with vertical layout.

open class VPanel : FlexPanel

Functions

(js)

dockPanel

DSL builder extension function.

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

fieldsetPanel

DSL builder extension function.

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

flexPanel

DSL builder extension function.

fun Container.flexPanel(direction: FlexDir? = null, wrap: FlexWrap? = null, justify: FlexJustify? = null, alignItems: FlexAlignItems? = null, alignContent: FlexAlignContent? = null, spacing: Int? = null, classes: Set<String>? = null, className: String? = null, init: (FlexPanel.() -> Unit)? = null): FlexPanel
(js)

gridPanel

DSL builder extension function.

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>? = null, className: String? = null, init: (GridPanel.() -> Unit)? = null): GridPanel
(js)

hPanel

DSL builder extension function.

fun Container.hPanel(wrap: FlexWrap? = null, justify: FlexJustify? = null, alignItems: FlexAlignItems? = null, spacing: Int? = null, classes: Set<String>? = null, className: String? = null, init: (HPanel.() -> Unit)? = null): HPanel
(js)

responsiveGridPanel

DSL builder extension function.

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

root

Create new Root container based on ID

fun Application.root(id: String, containerType: ContainerType = ContainerType.FLUID, addRow: Boolean = containerType != ContainerType.FIXED, init: Root.() -> Unit): Root
fun Application.root(id: String, fixed: Boolean = false, containerType: ContainerType = if (fixed) ContainerType.FIXED else ContainerType.FLUID, addRow: Boolean = !fixed, init: Root.() -> Unit): Root

Create new Root container based on HTML element

fun Application.root(element: HTMLElement, containerType: ContainerType = ContainerType.FLUID, addRow: Boolean = containerType != ContainerType.FIXED, init: Root.() -> Unit): Root
fun Application.root(element: HTMLElement, fixed: Boolean = false, containerType: ContainerType = if (fixed) ContainerType.FIXED else ContainerType.FLUID, addRow: Boolean = !fixed, init: Root.() -> Unit): Root
(js)

simplePanel

DSL builder extension function.

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

splitPanel

DSL builder extension function.

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

stackPanel

DSL builder extension function.

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

tabPanel

DSL builder extension function.

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

vPanel

DSL builder extension function.

fun Container.vPanel(justify: FlexJustify? = null, alignItems: FlexAlignItems? = null, spacing: Int? = null, classes: Set<String>? = null, className: String? = null, init: (VPanel.() -> Unit)? = null): VPanel