pl.treksoft.kvision.core

Package pl.treksoft.kvision.core

KVision core classes. This includes base interfaces for all components, CSS enums (for colors, borders, backgrounds, fonts, text and position) and the main Widget class.

Types

Background	`class Background` Type-safe definition of CSS background.
BgAttach	`enum class BgAttach` Definitions of CSS background attachment options.
BgClip	`enum class BgClip` Definitions of CSS background clipping options.
BgOrigin	`enum class BgOrigin` Definitions of CSS background origin options.
BgRepeat	`enum class BgRepeat` Definitions of CSS background repeat options.
BgSize	`enum class BgSize` Definitions of CSS background size.
Border	`class Border` Type-safe definition of CSS border.
BorderStyle	`enum class BorderStyle` Definitions of CSS border styles.
BsBgColor	`enum class BsBgColor`
BsBorder	`enum class BsBorder`
BsColor	`enum class BsColor`
BsRounded	`enum class BsRounded`
Clear	`enum class Clear` Definitions of CSS clear options.
Col	`enum class Col` Definitions of CSS color names.
Color	`class Color` Type-safe definition of CSS color.
Component	`interface Component` Base interface for all components.
Container	`interface Container : Component` Base interface for all containers.
Direction	`enum class Direction` Definitions of CSS text direction options.
Display	`enum class Display` Definitions of CSS display options.
FontStyle	`enum class FontStyle` Definitions of CSS font style options.
FontVariant	`enum class FontVariant` Definitions of CSS font variant options.
FontWeight	`enum class FontWeight` Definitions of CSS font weight options.
LineBreak	`enum class LineBreak` Definitions of CSS line-break options.
Overflow	`enum class Overflow` Definitions of CSS overflow options.
OverflowWrap	`enum class OverflowWrap` Definitions of CSS overflow-wrap options.
Placement	`enum class Placement` Tooltip / Popover placements.
PopoverOptions	`data class PopoverOptions` Popover options.
PosFloat	`enum class PosFloat` Definitions of CSS float options.
Position	`enum class Position` Definitions of CSS position options.
Resize	`enum class Resize` Definitions of CSS resize options.
Style	`open class Style : StyledComponent` CSS style object.
StyledComponent	`abstract class StyledComponent` Base class for components supporting CSS styling.
TextAlign	`enum class TextAlign` Definitions of CSS text align options.
TextDecoration	`class TextDecoration` Type-safe definition of CSS text decoration.
TextDecorationLine	`enum class TextDecorationLine` Definitions of CSS text decoration line options.
TextDecorationStyle	`enum class TextDecorationStyle` Definitions of CSS text decoration style options.
TextOverflow	`enum class TextOverflow` Definitions of CSS text overflow options.
TextShadow	`class TextShadow` Type-safe definition of CSS text shadow.
TextTransform	`enum class TextTransform` Definitions of CSS text transform options.
TooltipOptions	`data class TooltipOptions` Tooltip options.
Trigger	`enum class Trigger` Tooltip / Popover triggers.
UnicodeBidi	`enum class UnicodeBidi` Definitions of CSS unicode-bidi options.
UNIT	`enum class UNIT` Definitions of CSS units.
VerticalAlign	`enum class VerticalAlign` Definitions of CSS vertical align options.
WhiteSpace	`enum class WhiteSpace` Definitions of CSS white space options.
Widget	`open class Widget : StyledComponent, Component` Base widget class. The parent of all component classes.
WidgetWrapper	`open class WidgetWrapper : SimplePanel` This class allows to wrap a component into separately styled DIV element.
WordBreak	`enum class WordBreak` Definitions of CSS word-break options.

Type Aliases

CssSize	`typealias CssSize = Pair<Number, UNIT>` This type is used for defining CSS dimensions (width, heights, margins, paddings, etc.).
ResString	`typealias ResString = String` This type is used for accessing resources with CommonJS require function.
StringBoolPair	`typealias StringBoolPair = Pair<String, Boolean>` Helper type used to define CSS classes.
StringPair	`typealias StringPair = Pair<String, String>` Helper type used to define CSS style attributes.

Functions

addBsBgColor	`fun Component.addBsBgColor(bsBgColor: BsBgColor): Unit`
addBsBorder	`fun Component.addBsBorder(vararg bsBorder: BsBorder): Unit`
addBsClearfix	`fun Component.addBsClearfix(): Unit`
addBsColor	`fun Component.addBsColor(bsColor: BsColor): Unit`
addBsRounded	`fun Component.addBsRounded(vararg bsRounded: BsRounded): Unit`
onEvent	`fun <T : Widget> T.onEvent(block: SnOn<T>.() -> Unit): Widget`
removeBsBgColor	`fun Component.removeBsBgColor(bsBgColor: BsBgColor): Unit`
removeBsBorder	`fun Component.removeBsBorder(vararg bsBorder: BsBorder): Unit`
removeBsClearfix	`fun Component.removeBsClearfix(): Unit`
removeBsColor	`fun Component.removeBsColor(bsColor: BsColor): Unit`
removeBsRounded	`fun Component.removeBsRounded(vararg bsRounded: BsRounded): Unit`
style	`fun Widget.style(className: String? = null, init: (Style.() -> Unit)? = null): Style` DSL builder extension function. `fun Style.style(className: String? = null, init: (Style.() -> Unit)? = null): Style` DSL builder extension function for cascading styles.
toJs	`fun TooltipOptions.toJs(): dynamic` Convert TooltipOptions to JavaScript JSON object. `fun PopoverOptions.toJs(): dynamic` Convert PopoverOptions to JavaScript JSON object.
widget	`fun Container.widget(classes: Set<String> = setOf(), init: (Widget.() -> Unit)? = null): Widget` DSL builder extension function.
widgetWrapper	`fun Container.widgetWrapper(wrapped: Component?, classes: Set<String> = setOf(), init: (WidgetWrapper.() -> Unit)? = null): WidgetWrapper` DSL builder extension function.