kvision/io.kvision.core

Package-level declarations

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

AlignContent

enum AlignContent : Enum<AlignContent>

CSS flexbox/grid content alignment options.

AlignItems

enum AlignItems : Enum<AlignItems>

CSS flexbox/grid items alignments options.

AttributeDelegate

class AttributeDelegate(attributeName: String)

AttributeSetBuilder

interface AttributeSetBuilder

Background

class Background(color: Color? = null, image: ResString? = null, positionX: <Error class: unknown class><Number, UNIT>? = null, positionY: <Error class: unknown class><Number, UNIT>? = null, sizeX: <Error class: unknown class><Number, UNIT>? = null, sizeY: <Error class: unknown class><Number, UNIT>? = null, size: BgSize? = null, repeat: BgRepeat? = null, origin: BgOrigin? = null, clip: BgClip? = null, attachment: BgAttach? = null)

Type-safe definition of CSS background.

BgAttach

enum BgAttach : Enum<BgAttach>

Definitions of CSS background attachment options.

BgClip

enum BgClip : Enum<BgClip>

Definitions of CSS background clipping options.

BgOrigin

enum BgOrigin : Enum<BgOrigin>

Definitions of CSS background origin options.

BgRepeat

enum BgRepeat : Enum<BgRepeat>

Definitions of CSS background repeat options.

BgSize

enum BgSize : Enum<BgSize>

Definitions of CSS background size.

Border

class Border(width: <Error class: unknown class><Number, UNIT>? = null, style: BorderStyle? = null, color: Color? = null)

Type-safe definition of CSS border.

BorderStyle

enum BorderStyle : Enum<BorderStyle>

Definitions of CSS border styles.

BoxShadow

class BoxShadow(hOffset: <Error class: unknown class><Number, UNIT>? = null, vOffset: <Error class: unknown class><Number, UNIT>? = null, blurRadius: <Error class: unknown class><Number, UNIT>? = null, spreadRadius: <Error class: unknown class><Number, UNIT>? = null, color: Color? = null, inset: Boolean = false)

Type-safe definition of CSS box shadow.

BsBgColor

enum BsBgColor : Enum<BsBgColor> , CssClass

BsBorder

enum BsBorder : Enum<BsBorder> , CssClass

BsColor

enum BsColor : Enum<BsColor> , CssClass

BsRounded

enum BsRounded : Enum<BsRounded> , CssClass

ClassSetBuilder

interface ClassSetBuilder

A builder in order to create a set of CSS-classes

Clear

enum Clear : Enum<Clear>

Definitions of CSS clear options.

Col

enum Col : Enum<Col>

Definitions of CSS color names.

Color

class Color(val color: String? = null)

Type-safe definition of CSS color.

Component

interface Component

Base interface for all components.

Container

interface Container : Component

Base interface for all containers.

CssClass

interface CssClass

CssSize

typealias CssSize = <Error class: unknown class><Number, UNIT>

This type is used for defining CSS dimensions (width, heights, margins, paddings, etc.).

Cursor

enum Cursor : Enum<Cursor>

Direction

enum Direction : Enum<Direction>

Definitions of CSS text direction options.

Display

enum Display : Enum<Display>

Definitions of CSS display options.

DomAttribute

interface DomAttribute

Easing

enum Easing : Enum<Easing>

FlexDirection

enum FlexDirection : Enum<FlexDirection>

CSS flexbox directions.

FlexWrap

enum FlexWrap : Enum<FlexWrap>

CSS flexbox wrap modes.

FontStyle

enum FontStyle : Enum<FontStyle>

Definitions of CSS font style options.

FontVariant

enum FontVariant : Enum<FontVariant>

Definitions of CSS font variant options.

FontWeight

enum FontWeight : Enum<FontWeight>

Definitions of CSS font weight options.

GridAutoFlow

enum GridAutoFlow : Enum<GridAutoFlow>

CSS grid flow options.

InheritingStyle

open class InheritingStyle(selector: String? = null, pClass: PClass? = null, pElement: PElement? = null, mediaQuery: String? = null, val parentStyle: Style? = null, init: InheritingStyle.() -> Unit? = null) : Style

CSS style object that inherits all properties from its parent.

JustifyContent

enum JustifyContent : Enum<JustifyContent>

CSS flexbox/grid content justification options.

JustifyItems

enum JustifyItems : Enum<JustifyItems>

CSS grid items justification options.

LazyCache

class LazyCache<T : Any>(val initializer: () -> T) : SingleObjectCache<T>

A cache that behaves like a resettable Lazy: It generates a value from a given initializer lazily, however that cache can be cleared, so that the value will be regenerated when queried next

LineBreak

enum LineBreak : Enum<LineBreak>

Definitions of CSS line-break options.

Outline

class Outline(width: <Error class: unknown class><Number, UNIT>? = null, style: OutlineStyle? = null, color: Color? = null)

Type-safe definition of CSS outline.

OutlineStyle

enum OutlineStyle : Enum<OutlineStyle>

Definitions of CSS outline styles.

Overflow

enum Overflow : Enum<Overflow>

Definitions of CSS overflow options.

OverflowWrap

enum OverflowWrap : Enum<OverflowWrap>

Definitions of CSS overflow-wrap options.

PClass

enum PClass : Enum<PClass>

CSS pseudo classes.

PElement

enum PElement : Enum<PElement>

CSS pseudo elements.

Placement

enum Placement : Enum<Placement>

Tooltip / Popover placements.

PopoverOptions

data class PopoverOptions(val content: String? = null, val title: String? = null, val rich: Boolean? = null, val animation: Boolean? = null, val delay: Int? = null, val hideDelay: Int? = null, val placement: Placement? = null, val triggers: List<Trigger>? = null, val sanitize: Boolean? = null)

Popover options.

PosFloat

enum PosFloat : Enum<PosFloat>

Definitions of CSS float options.

Position

enum Position : Enum<Position>

Definitions of CSS position options.

Resize

enum Resize : Enum<Resize>

Definitions of CSS resize options.

ResString

typealias ResString = String

This type is used for accessing resources with CommonJS require function.

e.g. require("./img/picture.png")

SingleObjectCache

interface SingleObjectCache<T : Any>

StringBoolPair

typealias StringBoolPair = <Error class: unknown class><String, Boolean>

Helper type used to define CSS classes.

StringPair

typealias StringPair = <Error class: unknown class><String, String>

Helper type used to define CSS style attributes.

Style

open class Style(selector: String? = null, pClass: PClass? = null, pElement: PElement? = null, mediaQuery: String? = null, val parentStyle: Style? = null, init: Style.() -> Unit? = null) : StyledComponent

CSS style object.

StyledComponent

abstract class StyledComponent

Base class for components supporting CSS styling.

TextAlign

enum TextAlign : Enum<TextAlign>

Definitions of CSS text align options.

TextDecoration

class TextDecoration(line: TextDecorationLine? = null, style: TextDecorationStyle? = null, color: Color? = null)

Type-safe definition of CSS text decoration.

TextDecorationLine

enum TextDecorationLine : Enum<TextDecorationLine>

Definitions of CSS text decoration line options.

TextDecorationStyle

enum TextDecorationStyle : Enum<TextDecorationStyle>

Definitions of CSS text decoration style options.

TextOverflow

enum TextOverflow : Enum<TextOverflow>

Definitions of CSS text overflow options.

TextShadow

class TextShadow(hShadow: <Error class: unknown class><Number, UNIT>? = null, vShadow: <Error class: unknown class><Number, UNIT>? = null, blurRadius: <Error class: unknown class><Number, UNIT>? = null, color: Color? = null)

Type-safe definition of CSS text shadow.

TextTransform

enum TextTransform : Enum<TextTransform>

Definitions of CSS text transform options.

TooltipOptions

data class TooltipOptions(val title: String? = null, val rich: Boolean? = null, val animation: Boolean? = null, val delay: Int? = null, val hideDelay: Int? = null, val placement: Placement? = null, val triggers: List<Trigger>? = null, val sanitize: Boolean? = null)

Tooltip options.

Transition

class Transition(property: String, duration: Double, timingFunction: String? = null, delay: Double? = null)

Type-safe definition of CSS transition.

Trigger

enum Trigger : Enum<Trigger>

Tooltip / Popover triggers.

UnicodeBidi

enum UnicodeBidi : Enum<UnicodeBidi>

Definitions of CSS unicode-bidi options.

UNIT

enum UNIT : Enum<UNIT>

Definitions of CSS units.

VerticalAlign

enum VerticalAlign : Enum<VerticalAlign>

Definitions of CSS vertical align options.

WhiteSpace

enum WhiteSpace : Enum<WhiteSpace>

Definitions of CSS white space options.

Widget

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

Base widget class. The parent of all component classes.

WidgetWrapper

class WidgetWrapper(wrapped: Component?, className: String? = null) : SimplePanel

This class allows to wrap a component into separately styled DIV element.

WordBreak

enum WordBreak : Enum<WordBreak>

Definitions of CSS word-break options.

Functions

addBsBgColor

fun Component.addBsBgColor(bsBgColor: BsBgColor)

addBsBorder

fun Component.addBsBorder(vararg bsBorder: BsBorder)

addBsClearfix

fun Component.addBsClearfix()

addBsColor

fun Component.addBsColor(bsColor: BsColor)

addBsRounded

fun Component.addBsRounded(vararg bsRounded: BsRounded)

animate

fun Widget.animate(duration: Int = 400, easing: Easing = Easing.SWING, complete: () -> Unit? = null, styles: StyledComponent.() -> Unit)

Animate the widget changing CSS properties.

buildAttributeSet

fun buildAttributeSet(delegate: (builder: AttributeSetBuilder) -> Unit): Attrs

buildClassSet

fun buildClassSet(delegate: (builder: ClassSetBuilder) -> Unit): Classes

disablePopover

fun Widget.disablePopover(): Widget

Disables popover for the current widget.

disableTooltip

fun Widget.disableTooltip(): Widget

Disables tooltip for the current widget.

enablePopover

fun Widget.enablePopover(options: PopoverOptions = PopoverOptions()): Widget

Enables popover for the current widget.

enableTooltip

fun Widget.enableTooltip(options: TooltipOptions = TooltipOptions()): Widget

Enables tooltip for the current widget.

fadeIn

fun Widget.fadeIn(duration: Int = 400, easing: Easing = Easing.SWING, complete: () -> Unit? = null): Widget

Shows current widget with fade in effect.

fadeOut

fun Widget.fadeOut(duration: Int = 400, easing: Easing = Easing.SWING, complete: () -> Unit? = null): Widget

Hides current widget with fade out effect.

getElementJQuery

fun Component.getElementJQuery(): <Error class: unknown class>?

Returns JQuery element bound to the current component.

getElementJQueryD

fun Component.getElementJQueryD(): dynamic

Returns JQuery element bound to the current component as a dynamic type.

hideAnim

fun Widget.hideAnim(duration: Int = 400, easing: Easing = Easing.SWING, complete: () -> Unit? = null): Widget

Hides current widget with animation effect.

hidePopover

fun Widget.hidePopover(): Widget

Hides popover for the current widget.

hideTooltip

fun Widget.hideTooltip(): Widget

Hides tooltip for the current widget.

inheritingStyle

fun Style.inheritingStyle(selector: String? = null, pClass: PClass? = null, pElement: PElement? = null, mediaQuery: String? = null, init: InheritingStyle.() -> Unit? = null): Style

DSL builder extension function for cascading styles.

fun inheritingStyle(selector: String? = null, pClass: PClass? = null, pElement: PElement? = null, mediaQuery: String? = null, parentStyle: Style? = null, init: InheritingStyle.() -> Unit? = null): InheritingStyle

fun Widget.inheritingStyle(selector: String? = null, pClass: PClass? = null, pElement: PElement? = null, mediaQuery: String? = null, parentStyle: Style? = null, init: InheritingStyle.() -> Unit? = null): InheritingStyle

DSL builder extension function.

jqueryEvent

inline fun <T> SnOn<T>.jqueryEvent(name: String, noinline handler: (<Error class: unknown class>) -> dynamic)

Helper function for defining jquery event types.

inline fun <T> SnOn<T>.jqueryEvent(name: String, noinline handler: (<Error class: unknown class>, dynamic) -> dynamic)

Helper function for defining jquery event types with additional argument.

inline fun <T> SnOn<T>.jqueryEvent(name: String, noinline handler: (<Error class: unknown class>, dynamic, dynamic) -> dynamic)

inline fun <T> SnOn<T>.jqueryEvent(name: String, noinline handler: (<Error class: unknown class>, dynamic, dynamic, dynamic) -> dynamic)

inline fun <T> SnOn<T>.jqueryEvent(name: String, noinline handler: (<Error class: unknown class>, dynamic, dynamic, dynamic, dynamic) -> dynamic)

inline fun <T> SnOn<T>.jqueryEvent(name: String, noinline handler: (<Error class: unknown class>, dynamic, dynamic, dynamic, dynamic, dynamic) -> dynamic)

inline fun <T> SnOn<T>.jqueryEvent(name: String, noinline handler: (<Error class: unknown class>, dynamic, dynamic, dynamic, dynamic, dynamic, dynamic) -> dynamic)

Helper function for defining jquery event types with additional arguments.

onChangeLaunch

inline fun <T : Widget> T.onChangeLaunch(coroutineScope: <Error class: unknown class> = KVScope, noinline handler: suspend T.(<Error class: unknown class>) -> Unit): Int

An extension function for defining on change suspending event handlers.

onClick

inline fun <T : Widget> T.onClick(noinline handler: T.(<Error class: unknown class>) -> Unit): Int

An extension function for defining on click event handlers.

onClickLaunch

inline fun <T : Widget> T.onClickLaunch(coroutineScope: <Error class: unknown class> = KVScope, noinline handler: suspend T.(<Error class: unknown class>) -> Unit): Int

An extension function for defining on click suspending event handlers.

inline fun <T : Button> T.onClickLaunch(coroutineScope: <Error class: unknown class> = KVScope, noinline handler: suspend T.(<Error class: unknown class>) -> Unit): T

An extension function for defining on click suspending event handlers for Buttons.

onEvent

inline fun <T : Widget> T.onEvent(noinline block: SnOn<T>.() -> Unit): Int

An extension function for defining event handlers.

onEventLaunch

inline fun <T : Widget> T.onEventLaunch(event: String, coroutineScope: <Error class: unknown class> = KVScope, noinline handler: suspend T.(<Error class: unknown class>) -> Unit): Int

An extension function for defining on change suspending event handlers.

onInputLaunch

inline fun <T : Widget> T.onInputLaunch(coroutineScope: <Error class: unknown class> = KVScope, noinline handler: suspend T.(<Error class: unknown class>) -> Unit): Int

An extension function for defining on change suspending event handlers.

removeBsBgColor

fun Component.removeBsBgColor(bsBgColor: BsBgColor)

removeBsBorder

fun Component.removeBsBorder(vararg bsBorder: BsBorder)

removeBsClearfix

fun Component.removeBsClearfix()

removeBsColor

fun Component.removeBsColor(bsColor: BsColor)

removeBsRounded

fun Component.removeBsRounded(vararg bsRounded: BsRounded)

showAnim

fun Widget.showAnim(duration: Int = 400, easing: Easing = Easing.SWING, complete: () -> Unit? = null): Widget

Shows current widget with animation effect.

showPopover

fun Widget.showPopover(): Widget

Shows popover for the current widget.

showTooltip

fun Widget.showTooltip(): Widget

Shows tooltip for the current widget.

slideDown

fun Widget.slideDown(duration: Int = 400, easing: Easing = Easing.SWING, complete: () -> Unit? = null): Widget

Shows current widget with slide down effect.

slideUp

fun Widget.slideUp(duration: Int = 400, easing: Easing = Easing.SWING, complete: () -> Unit? = null): Widget

Hides current widget with slide up effect.

style

fun style(selector: String? = null, pClass: PClass? = null, pElement: PElement? = null, mediaQuery: String? = null, init: Style.() -> Unit? = null): Style

fun Widget.style(selector: String? = null, pClass: PClass? = null, pElement: PElement? = null, mediaQuery: String? = null, init: Style.() -> Unit? = null): Style

DSL builder extension function.

fun Style.style(selector: String? = null, pClass: PClass? = null, pElement: PElement? = null, mediaQuery: String? = null, init: Style.() -> Unit? = null): Style

DSL builder extension function for cascading styles.

toJs

fun PopoverOptions.toJs(): dynamic

Convert PopoverOptions to JavaScript JSON object.

fun TooltipOptions.toJs(): dynamic

Convert TooltipOptions to JavaScript JSON object.

widget

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

DSL builder extension function.

Properties

KVScope

val KVScope: <Error class: unknown class>