kvision-material/io.kvision.material.switch/MdSwitch

MdSwitch

open class MdSwitch(selected: Boolean = false, disabled: Boolean = false, icons: Boolean = false, showOnlySelectedIcon: Boolean = false, required: Boolean = false, value: String = "on", name: String? = null, validationMessage: String? = null, className: String? = null, init: MdSwitch.() -> Unit? = null) : MdFormToggleInputWidget(source)

Switches toggle the state of an item on or off.

See https://material-web.dev/components/switch/

Author

Maanrifa Bacar Ali

Constructors

MdSwitch

constructor(selected: Boolean = false, disabled: Boolean = false, icons: Boolean = false, showOnlySelectedIcon: Boolean = false, required: Boolean = false, value: String = "on", name: String? = null, validationMessage: String? = null, className: String? = null, init: MdSwitch.() -> Unit? = null)

Properties

alignContent

open var alignContent: AlignContent?

alignItems

open var alignItems: AlignItems?

alignSelf

open var alignSelf: AlignItems?

background

open var background: Background?

border

open var border: Border?

borderBottom

open var borderBottom: Border?

borderLeft

open var borderLeft: Border?

borderRadius

open var borderRadius: CssSize?

borderRadiusList

open var borderRadiusList: List<CssSize>?

borderRight

open var borderRight: Border?

borderTop

open var borderTop: Border?

bottom

open var bottom: CssSize?

boxShadow

open var boxShadow: BoxShadow?

boxShadowList

open var boxShadowList: List<BoxShadow>?

clear

open var clear: Clear?

color

open var color: Color?

colorHex

open var colorHex: Int?

colorName

open var colorName: Col?

cursor

open var cursor: Cursor?

disabled

var disabled: Boolean

Whether or not the widget is disabled.

display

open var display: Display?

draggable

var draggable: Boolean?

eventTarget

var eventTarget: Widget?

flexBasis

open var flexBasis: CssSize?

flexDirection

open var flexDirection: FlexDirection?

flexGrow

open var flexGrow: Int?

flexShrink

open var flexShrink: Int?

flexWrap

open var flexWrap: FlexWrap?

float

open var float: PosFloat?

fontFamily

open var fontFamily: String?

fontSize

open var fontSize: CssSize?

fontStyle

open var fontStyle: FontStyle?

fontVariant

open var fontVariant: FontVariant?

fontWeight

open var fontWeight: FontWeight?

form

val form: HTMLFormElement?

The associated form element with which this element's value will submit.

gridArea

open var gridArea: String?

gridAutoColumns

open var gridAutoColumns: String?

gridAutoFlow

open var gridAutoFlow: GridAutoFlow?

gridAutoRows

open var gridAutoRows: String?

gridColumnEnd

open var gridColumnEnd: String?

gridColumnGap

open var gridColumnGap: Int?

gridColumnStart

open var gridColumnStart: Int?

gridRowEnd

open var gridRowEnd: String?

gridRowGap

open var gridRowGap: Int?

gridRowStart

open var gridRowStart: Int?

gridTemplateAreas

open var gridTemplateAreas: List<String>?

gridTemplateColumns

open var gridTemplateColumns: String?

gridTemplateRows

open var gridTemplateRows: String?

height

open var height: CssSize?

icons

var icons: Boolean

Shows both the selected and deselected icons.

var id: String?

justifyContent

open var justifyContent: JustifyContent?

justifyItems

open var justifyItems: JustifyItems?

justifySelf

open var justifySelf: JustifyItems?

kvscope

var kvscope: dynamic

labels

val labels: NodeList?

The labels this element is associated with.

left

open var left: CssSize?

letterSpacing

open var letterSpacing: CssSize?

lineBreak

open var lineBreak: LineBreak?

lineHeight

open var lineHeight: CssSize?

listStyle

open var listStyle: ListStyle?

margin

open var margin: CssSize?

marginBottom

open var marginBottom: CssSize?

marginLeft

open var marginLeft: CssSize?

marginRight

open var marginRight: CssSize?

marginTop

open var marginTop: CssSize?

maxHeight

open var maxHeight: CssSize?

maxWidth

open var maxWidth: CssSize?

minHeight

open var minHeight: CssSize?

minWidth

open var minWidth: CssSize?

name

var name: String?

The name to use in form submission.

opacity

open var opacity: Double?

order

open var order: Int?

outline

open var outline: Outline?

overflow

open var overflow: Overflow?

overflowWrap

open var overflowWrap: OverflowWrap?

overflowX

open var overflowX: Overflow?

overflowY

open var overflowY: Overflow?

padding

open var padding: CssSize?

paddingBottom

open var paddingBottom: CssSize?

paddingLeft

open var paddingLeft: CssSize?

paddingRight

open var paddingRight: CssSize?

paddingTop

open var paddingTop: CssSize?

parent

open override var parent: Container?

popoverHooksActive

var popoverHooksActive: Boolean

popoverOptions

var popoverOptions: dynamic

position

open var position: Position?

required

var required: Boolean

Indicates that the component must provides a valid value when participating in form submission.

resize

open var resize: Resize?

right

open var right: CssSize?

role

var role: String?

selected

var selected: Boolean

Puts the switch in the selected state and sets the form submission value to the value property.

showOnlySelectedIcon

var showOnlySelectedIcon: Boolean

Shows only the selected icon, and not the deselected icon. If true, overrides the behavior of the icons property.

tabindex

var tabindex: Int?

textAlign

open var textAlign: TextAlign?

textDecoration

open var textDecoration: TextDecoration?

textDirection

open var textDirection: Direction?

textIndent

open var textIndent: CssSize?

textOverflow

open var textOverflow: TextOverflow?

textShadow

open var textShadow: TextShadow?

textTransform

open var textTransform: TextTransform?

title

var title: String?

tooltipHooksActive

var tooltipHooksActive: Boolean

tooltipOptions

var tooltipOptions: dynamic

top

open var top: CssSize?

transition

open var transition: Transition?

transitionList

open var transitionList: List<Transition>?

unicodeBidi

open var unicodeBidi: UnicodeBidi?

validationMessage

val validationMessage: String?

Message to display when the component value is not valid.

validity

val validity: ValidityState?

Gets the element's current validity state.

value

var value: String

The value that is submitted to the form.

verticalAlign

open var verticalAlign: VerticalAlign?

visible

open override var visible: Boolean

whiteSpace

open var whiteSpace: WhiteSpace?

width

open var width: CssSize?

willValidate

val willValidate: Boolean

Indicates that the element is a candidate for constraint validation.

wordBreak

open var wordBreak: WordBreak?

wordSpacing

open var wordSpacing: CssSize?

zIndex

open var zIndex: Int?

Functions

addAfterCreateHook

open override fun addAfterCreateHook(hook: (VNode) -> Unit): Boolean

addAfterDestroyHook

open override fun addAfterDestroyHook(hook: () -> Unit): Boolean

addAfterInsertHook

open override fun addAfterInsertHook(hook: (VNode) -> Unit): Boolean

addBeforeDisposeHook

open override fun addBeforeDisposeHook(hook: () -> Unit): Boolean

addCssClass

open override fun addCssClass(css: String)

addCssStyle

open override fun addCssStyle(css: Style)

addSurroundingCssClass

open override fun addSurroundingCssClass(css: String)

addSurroundingCssStyle

open override fun addSurroundingCssStyle(css: Style)

blur

open fun blur()

checkValidity

fun checkValidity(): Boolean

Indicates the validity of the value of the element. If the value is invalid, this method also fires the invalid event on the element.

clearAfterCreateHooks

open override fun clearAfterCreateHooks()

clearAfterDestroyHooks

open override fun clearAfterDestroyHooks()

clearAfterInsertHooks

open override fun clearAfterInsertHooks()

clearBeforeDisposeHooks

open override fun clearBeforeDisposeHooks()

clearDragDropData

open fun clearDragDropData()

clearParent

open override fun clearParent()

dispatchEvent

open fun dispatchEvent(type: String, eventInitDict: CustomEventInit): Boolean?

dispose

open override fun dispose()

focus

open fun focus()

getAttribute

open override fun getAttribute(name: String): String?

getElement

open override fun getElement(): HTMLElement?

getElementD

open override fun getElementD(): dynamic

getRoot

open override fun getRoot(): Root?

getSnStyle

open fun getSnStyle(): dynamic

getStyle

fun getStyle(name: String): String?

hasCssClass

open override fun hasCssClass(css: String): Boolean

hide

open fun hide()

refresh

open override fun refresh()

removeAfterCreateHook

open override fun removeAfterCreateHook(hook: (VNode) -> Unit): Boolean

removeAfterDestroyHook

open override fun removeAfterDestroyHook(hook: () -> Unit): Boolean

removeAfterInsertHook

open override fun removeAfterInsertHook(hook: (VNode) -> Unit): Boolean

removeAttribute

open override fun removeAttribute(name: String)

removeBeforeDisposeHook

open override fun removeBeforeDisposeHook(hook: () -> Unit): Boolean

removeCssClass

open override fun removeCssClass(css: String)

removeCssStyle

open override fun removeCssStyle(css: Style)

removeEventListener

open fun removeEventListener(id: Int)

removeEventListeners

open fun removeEventListeners()

removeStyle

fun removeStyle(name: String)

removeSurroundingCssClass

open override fun removeSurroundingCssClass(css: String)

removeSurroundingCssStyle

open override fun removeSurroundingCssStyle(css: Style)

renderVNode

open override fun renderVNode(): VNode

reportValidity

fun reportValidity(): Boolean

Performs the same validity checking steps as the checkValidity method. If the value is invalid, this method also fires the invalid event on the element, and (if the event isn't canceled) reports the problem to the user.

setAttribute