kvision / pl.treksoft.kvision.html / Button

Button

open class Button : Widget

Button component.

Constructors

Button(text: String, icon: String? = null, style: ButtonStyle = ButtonStyle.DEFAULT, type: ButtonType = ButtonType.BUTTON, disabled: Boolean = false, classes: Set<String> = setOf())

Properties

block	`var block: Boolean` Determines if the button takes all the space horizontally.
disabled	`var disabled: Boolean` Determines if button is disabled.
icon	`var icon: String?` Button icon.
image	`var image: ResString?` Button image.
size	`var size: ButtonSize?` Button size.
style	`var style: ButtonStyle` Button style.
text	`var text: String` Button label.
type	`var type: ButtonType` Button types.

Inherited Properties

draggable	`var draggable: Boolean?` Determines if the current widget is draggable.
eventTarget	`var eventTarget: Widget?`
id	`var id: String?` An ID attribute of generated HTML element.
lastLanguage	`var lastLanguage: String?`
parent	`open var parent: Container?` Parent of the current component.
popoverOptions	`var popoverOptions: PopoverOptions?`
role	`var role: String?` A role attribute of generated HTML element.
surroundingSpan	`var surroundingSpan: Boolean`
title	`var title: String?` A title attribute of generated HTML element.
tooltipOptions	`var tooltipOptions: TooltipOptions?`
visible	`open var visible: Boolean` Visibility state of the current component.
vnode	`var vnode: VNode?`

Functions

getSnAttrs	`open fun getSnAttrs(): List<StringPair>` Returns list of element attributes in the form of a List.
getSnClass	`open fun getSnClass(): List<StringBoolPair>` Returns list of CSS class names for current widget in the form of a List.
onClick	`open fun onClick(handler: Button.(MouseEvent) -> Unit): Button` A convenient helper for easy setting onClick event handler.
render	`open fun render(): VNode` Renders current component as a Snabbdom vnode.

Inherited Functions

addCssClass	`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.
addSurroundingCssClass	`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.
afterCreate	`open fun afterCreate(node: VNode): Unit` Method called after creating Snabbdom vnode.
afterDestroy	`open fun afterDestroy(): Unit` Method called after destroying Snabbdom vnode.
afterInsert	`open fun afterInsert(node: VNode): Unit` Method called after inserting Snabbdom vnode into the DOM.
clearDragDropData	`open fun clearDragDropData(): Unit` Clears D&D data for the current widget. It also makes it not draggable.
disablePopover	`open fun disablePopover(): Widget` Disables popover for the current widget.
disableTooltip	`open fun disableTooltip(): Widget` Disables tooltip for the current widget.
dispatchEvent	`open fun dispatchEvent(type: String, eventInitDict: CustomEventInit): Boolean?`
enablePopover	`open fun enablePopover(options: PopoverOptions = PopoverOptions()): Widget` Enables popover for the current widget.
enableTooltip	`open fun enableTooltip(options: TooltipOptions = TooltipOptions()): Widget` Enables tooltip for the current widget.
getAttribute	`open fun getAttribute(name: String): String?` Returns the value of an additional attribute.
getElement	`open fun getElement(): Node?` Returns DOM element bound to the current component.
getElementJQuery	`open fun getElementJQuery(): JQuery?` Returns JQuery element bound to the current component.
getElementJQueryD	`open fun getElementJQueryD(): dynamic` Returns JQuery element bound to the current component as a dynamic type.
getSnHooks	`open fun getSnHooks(): Hooks?` Returns list of hooks in the form of a Snabbdom Hooks object.
getSnOn	`open fun getSnOn(): On?` Returns list of event handlers in the form of a Snabbdom On object.
hide	`open fun hide(): Widget` Makes current widget invisible.
hidePopover	`open fun hidePopover(): Widget` Hides popover for the current widget.
hideTooltip	`open fun hideTooltip(): Widget` Hides tooltip for the current widget.
refreshOnUpdate	`fun <T> refreshOnUpdate(refreshFunction: (T) -> Unit = { this.refresh() }): Widget.RefreshDelegateProvider<T>` `fun <T> refreshOnUpdate(initialValue: T, refreshFunction: (T) -> Unit = { this.refresh() }): Widget.RefreshDelegateProvider<T>`
removeAttribute	`open fun removeAttribute(name: String): Widget` Removes the value of additional attribute.
removeCssClass	`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.
removeEventListeners	`open fun removeEventListeners(): Widget` Removes all event listeners from current widget.
removeSurroundingCssClass	`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.
render	`open fun render(elementName: String): VNode` `open fun render(elementName: String, children: Array<dynamic>): VNode` Renders current component as a Snabbdom vnode.
setAttribute	`open fun setAttribute(name: String, value: String): Widget` Sets the value of additional attribute.
setContextMenu	`open fun setContextMenu(contextMenu: ContextMenu): Widget` Sets context menu for the current widget.
setDragDropData	`open fun setDragDropData(format: String, data: String): Unit` Sets D&D data for the current widget. It also makes it draggable.
setDropTarget	`open fun setDropTarget(format: String, callback: (DragEvent) -> Unit): Unit` `open fun setDropTarget(formats: Set<String>? = null, callback: (DragEvent) -> Unit): Unit` Sets the current widget as a D&D drop target.
setDropTargetData	`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.
setEventListener	`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.
show	`open fun show(): Widget` Makes current widget visible.
showPopover	`open fun showPopover(): Widget` Shows popover for the current widget.
showTooltip	`open fun showTooltip(): Widget` Shows tooltip for the current widget.
singleRender	`fun <T> singleRender(block: () -> T): T`
toggleVisible	`open fun toggleVisible(): Widget` Toggles visibility of current widget.
translate	`fun translate(text: String?): String?`

Companion Object Functions

button

fun Container.button(text: String, icon: String? = null, style: ButtonStyle = ButtonStyle.DEFAULT, type: ButtonType = ButtonType.BUTTON, disabled: Boolean = false, classes: Set<String> = setOf(), init: (Button.() -> Unit)? = null): Button

DSL builder extension function.

Extension Functions

createInstance

fun <T> Any?.createInstance(vararg args: dynamic): T

Helper function for creating JavaScript objects from dynamic constructors.