kvision-material/io.kvision.material.checkbox/MdCheckbox

MdCheckbox

open class MdCheckbox(checked: Boolean = false, disabled: Boolean = false, indeterminate: Boolean = false, required: Boolean = false, value: String = "on", name: String? = null, touchTarget: TouchTarget? = TouchTarget.Wrapper, validationMessage: String? = null, className: String? = null, init: MdCheckbox.() -> Unit? = null) : MdFormToggleInputWidget

Checkboxes allow users to select one or more items from a set. Checkboxes can turn an option on or off.

There's one type of checkbox in Material. Use this selection control when the user needs to select one or more options from a list.

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

Author

Maanrifa Bacar Ali

Constructors

MdCheckbox

constructor(checked: Boolean = false, disabled: Boolean = false, indeterminate: Boolean = false, required: Boolean = false, value: String = "on", name: String? = null, touchTarget: TouchTarget? = TouchTarget.Wrapper, validationMessage: String? = null, className: String? = null, init: MdCheckbox.() -> Unit? = null)

Properties

checked

var checked: <Error class: unknown class>

Whether or not the checkbox is selected.

disabled

var disabled: <Error class: unknown class>

Whether or not the widget is disabled.

form

val form: <Error class: unknown class>?

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

indeterminate

var indeterminate: <Error class: unknown class>

Whether or not the checkbox is indeterminate.

labels

val labels: <Error class: unknown class>?

The labels this element is associated with.

name

var name: <Error class: unknown class>

The name to use in form submission.

parent

open var parent: <Error class: unknown class>?

required

var required: <Error class: unknown class>

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

touchTarget

var touchTarget: <Error class: unknown class>

Checkbox touch target.

validationMessage

val validationMessage: String?

Message to display when the component value is not valid.

validity

val validity: <Error class: unknown class>?

Gets the element's current validity state.

value

var value: <Error class: unknown class>

The value that is submitted to the form.

willValidate

val willValidate: Boolean

Indicates that the element is a candidate for constraint validation.

Functions

afterCreate

open fun afterCreate(node: <Error class: unknown class>)

buildAttributeSet

open override fun buildAttributeSet(attributeSetBuilder: <Error class: unknown class>)

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.

dispose

open fun dispose()

render

open fun render(): <Error class: unknown class>

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.