open class Widget : StyledComponent
Base widget class. The parent of all component classes.
A simple widget is rendered as HTML DIV element.
Widget(classes: Set<String> = setOf())
Creates basic Widget with given CSS class names. |
var draggable: Boolean?
Determines if the current widget is draggable. |
|
var eventTarget: Widget? |
|
var id: String?
An ID attribute of generated HTML element. |
|
var lastLanguage: String? |
|
open var parent: Container?
Parent of the current component. |
|
var popoverOptions: PopoverOptions? |
|
var role: String?
A role attribute of generated HTML element. |
|
var surroundingSpan: Boolean |
|
var title: String?
A title attribute of generated HTML element. |
|
var tooltipOptions: TooltipOptions? |
|
open var visible: Boolean
Visibility state of the current component. |
open var background: Background?
Background of the current component. |
|
open var border: Border?
Border of the current component. |
|
open var borderBottom: Border?
Bottom border of the current component. |
|
open var borderLeft: Border?
Left border of the current component. |
|
open var borderRight: Border?
Right border of the current component. |
|
open var borderTop: Border?
Top border of the current component. |
|
open var bottom: CssSize?
Bottom edge of the current component. |
|
open var clear: Clear?
CSS clear float of the current component. |
|
open var color: Color?
Text color for the current component. |
|
open var colorHex: Int?
Text color for the current component given in hex format (write only). |
|
open var colorName: Col?
Text color for the current component given with named constant (write only). |
|
open var display: Display?
CSS display of the current component. |
|
open var float: PosFloat?
CSS position float of the current component. |
|
open var fontFamily: String?
CSS font family of the current component. |
|
open var fontSize: CssSize?
CSS font size of the current component. |
|
open var fontStyle: FontStyle?
CSS font style of the current component. |
|
open var fontVariant: FontVariant?
CSS font variant of the current component. |
|
open var fontWeight: FontWeight?
CSS font weight of the current component. |
|
open var height: CssSize?
Height of the current component. |
|
open var left: CssSize?
Left edge of the current component. |
|
open var letterSpacing: CssSize?
CSS Text letter spacing of the current component. |
|
open var lineBreak: LineBreak?
CSS line break of the current component. |
|
open var lineHeight: CssSize?
CSS Text line height of the current component. |
|
open var margin: CssSize?
Margin of the current component. |
|
open var marginBottom: CssSize?
Bottom margin of the current component. |
|
open var marginLeft: CssSize?
Left margin of the current component. |
|
open var marginRight: CssSize?
Right margin of the current component. |
|
open var marginTop: CssSize?
Top margin of the current component. |
|
open var maxHeight: CssSize?
Maximal height of the current component. |
|
open var maxWidth: CssSize?
Maximal width of the current component. |
|
open var minHeight: CssSize?
Minimal height of the current component. |
|
open var minWidth: CssSize?
Minimal width of the current component. |
|
open var opacity: Double?
Opacity of the current component. |
|
open var overflow: Overflow?
CSS overflow of the current component. |
|
open var overflowWrap: OverflowWrap?
CSS overflow-wrap of the current component. |
|
open var padding: CssSize?
Padding of the current component. |
|
open var paddingBottom: CssSize?
Bottom padding of the current component. |
|
open var paddingLeft: CssSize?
Left padding of the current component. |
|
open var paddingRight: CssSize?
Right padding of the current component. |
|
open var paddingTop: CssSize?
Top padding of the current component. |
|
open var position: Position?
CSS position of the current component. |
|
open var resize: Resize?
CSS resize of the current component. |
|
open var right: CssSize?
Right edge of the current component. |
|
open var textAlign: TextAlign?
CSS Text align of the current component. |
|
open var textDecoration: TextDecoration?
CSS Text decoration of the current component. |
|
open var textDirection: Direction?
CSS Text direction of the current component. |
|
open var textIndent: CssSize?
CSS Text indent of the current component. |
|
open var textOverflow: TextOverflow?
CSS Text overflow of the current component. |
|
open var textShadow: TextShadow?
CSS Text shadow of the current component. |
|
open var textTransform: TextTransform?
CSS Text transform of the current component. |
|
open var top: CssSize?
Top edge of the current component. |
|
open var unicodeBidi: UnicodeBidi?
CSS Text unicode-bidi of the current component. |
|
open var verticalAlign: VerticalAlign?
CSS Text vertical align of the current component. |
|
open var whiteSpace: WhiteSpace?
CSS Text white space of the current component. |
|
open var width: CssSize?
Width of the current component. |
|
open var wordBreak: WordBreak?
CSS word break of the current component. |
|
open var wordSpacing: CssSize?
CSS Text word spacing of the current component. |
|
open var zIndex: Int?
Z-index of the current component. |
open fun addCssClass(css: String): Widget
Adds given value to the set of CSS classes generated in html code of current component. open fun addCssClass(css: Style): Widget
Adds given style object to the set of CSS classes generated in html code of current component. |
|
open fun addSurroundingCssClass(css: String): Widget
Adds given value to the set of CSS classes generated in html code of parent component. open fun addSurroundingCssClass(css: Style): Widget
Adds given style object to the set of CSS classes generated in html code of parent component. |
|
open fun afterCreate(node: VNode): Unit
Method called after creating Snabbdom vnode. |
|
open fun afterDestroy(): Unit
Method called after destroying Snabbdom vnode. |
|
open fun afterInsert(node: VNode): Unit
Method called after inserting Snabbdom vnode into the DOM. |
|
open fun afterPostpatch(node: VNode): Unit
Method called after updating Snabbdom vnode. |
|
open fun clearDragDropData(): Unit
Clears D&D data for the current widget. It also makes it not draggable. |
|
open fun disablePopover(): Widget
Disables popover for the current widget. |
|
open fun disableTooltip(): Widget
Disables tooltip for the current widget. |
|
open fun dispatchEvent(type: String, eventInitDict: CustomEventInit): Boolean? |
|
open fun enablePopover(options: PopoverOptions = PopoverOptions()): Widget
Enables popover for the current widget. |
|
open fun enableTooltip(options: TooltipOptions = TooltipOptions()): Widget
Enables tooltip for the current widget. |
|
open fun getElement(): Node?
Returns DOM element bound to the current component. |
|
open fun getElementJQuery(): JQuery?
Returns JQuery element bound to the current component. |
|
open fun getElementJQueryD(): dynamic
Returns JQuery element bound to the current component as a dynamic type. |
|
open fun getSnAttrs(): List<StringPair>
Returns list of element attributes in the form of a List. |
|
open fun getSnClass(): List<StringBoolPair>
Returns list of CSS class names for current widget in the form of a List. |
|
open fun getSnHooks(): Hooks?
Returns list of hooks in the form of a Snabbdom Hooks object. |
|
open fun getSnOn(): On?
Returns list of event handlers in the form of a Snabbdom On object. |
|
open fun hide(): Widget
Makes current widget invisible. |
|
open fun hidePopover(): Widget
Hides popover for the current widget. |
|
open fun hideTooltip(): Widget
Hides tooltip for the current widget. |
|
open fun removeCssClass(css: String): Widget
Removes given value from the set of CSS classes generated in html code of current component. open fun removeCssClass(css: Style): Widget
Removes given style object from the set of CSS classes generated in html code of current component. |
|
open fun removeEventListeners(): Widget
Removes all event listeners from current widget. |
|
open fun removeSurroundingCssClass(css: String): Widget
Removes given value from the set of CSS classes generated in html code of parent component. open fun removeSurroundingCssClass(css: Style): Widget
Removes given style object from the set of CSS classes generated in html code of parent component. |
|
open fun render(): VNodeopen fun render(elementName: String): VNodeopen fun render(elementName: String, children: Array<dynamic>): VNode
Renders current component as a Snabbdom vnode. |
|
open fun setContextMenu(contextMenu: ContextMenu): Widget
Sets context menu for the current widget. |
|
open fun setDragDropData(format: String, data: String): Unit
Sets D&D data for the current widget. It also makes it draggable. |
|
open fun setDropTarget(format: String, callback: (DragEvent) -> Unit): Unitopen fun setDropTarget(formats: Set<String>? = null, callback: (DragEvent) -> Unit): Unit
Sets the current widget as a D&D drop target. |
|
open fun setDropTargetData(format: String, callback: (String?) -> Unit): Unit
Sets the current widget as a D&D drop target with helper callback accepting String data. |
|
open fun <T : Widget> setEventListener(block: SnOn<T>.() -> Unit): Widget
Sets an event listener for current widget, keeping the actual type of component. open fun setEventListener(block: SnOn<Widget>.() -> Unit): Widget
Sets an event listener for current widget. |
|
open fun show(): Widget
Makes current widget visible. |
|
open fun showPopover(): Widget
Shows popover for the current widget. |
|
open fun showTooltip(): Widget
Shows tooltip for the current widget. |
|
fun <T> singleRender(block: () -> T): T |
|
open fun toggleVisible(): Widget
Toggles visibility of current widget. |
|
fun translate(text: String): String
Translates given text with I18n trans function and sets lastLanguage marker. fun translate(text: String?): String? |
open fun getSnStyle(): List<StringPair>
Returns the list of String pairs defining CSS style attributes and their values. |
|
fun <T> refreshOnUpdate(refreshFunction: (T) -> Unit = { this.refresh() }): RefreshDelegateProvider<T>fun <T> refreshOnUpdate(initialValue: T, refreshFunction: (T) -> Unit = { this.refresh() }): RefreshDelegateProvider<T> |
fun Container.widget(classes: Set<String> = setOf(), init: Widget.() -> Unit = null): Widget
DSL builder extension function. |
fun <T> Any?.createInstance(vararg args: dynamic): T
Helper function for creating JavaScript objects from dynamic constructors. |
abstract class AbstractTextInput : Widget, FormInput
Base class for basic text components. |
|
open class Button : Widget
Button component. |
|
open class Canvas : Widget
Canvas component. |
|
open class Chart : Widget
Chart component. |
|
abstract class CheckInput : Widget, FormInput
The basic input component rendered as HTML input type="checkbox" or input type="radio". |
|
open class CloseIcon : Widget
Helper class for close icon component. |
|
class DataContainer<M, C : Component, CONT : Container> : Widget, Container, DataUpdatable
A container class with support for observable data model. |
|
open class DateTimeInput : Widget, FormInput
Basic date/time chooser component. |
|
open class Iframe : Widget
Iframe component. |
|
open class Image : Widget
Image component. |
|
open class SelectOption : Widget
The helper component for adding options to Select or SelectOptGroup. |
|
open class SimplePanel : Widget, Container
Basic container class, rendered as a DIV element with all children directly within. |
|
open class SpinnerInput : Widget, FormInput
The basic component for spinner control. |
|
class StateBinding<S : Any, A, CONT : Container, CONTENT> : Widget
A class which binds the redux store with the given container. |
|
open class UploadInput : Widget, FormInput
The file upload component. |