kvision-onsenui/io.kvision.onsenui.form/OnsCheckBox

OnsCheckBox

open class OnsCheckBox(value: Boolean = false, name: String? = null, label: String? = null, rich: Boolean = false, className: String? = null, init: OnsCheckBox.() -> Unit? = null) : SimplePanel, BoolFormControl, MutableState<Boolean> (source)

Onsen UI form field checkbox component.

Parameters

value

checkbox input value

name

the name attribute of the generated HTML input element

label

label text bound to the input element

rich

determines if label can contain HTML code

className

CSS class names

init

an initializer extension function

Constructors

OnsCheckBox

constructor(value: Boolean = false, name: String? = null, label: String? = null, rich: Boolean = false, className: String? = null, init: OnsCheckBox.() -> Unit? = null)

Creates a form field checkbox component.

Types

Companion

object Companion

Properties

_archivedState

var _archivedState: dynamic

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

open var disabled: Boolean

display

open var display: Display?

draggable

var draggable: Boolean?

eventTarget

var eventTarget: Widget?

flabel

override val flabel: FieldLabel

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?

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?

var id: String?

input

override val input: OnsCheckBoxInput

invalidFeedback

override val invalidFeedback: InvalidFeedback

justifyContent

open var justifyContent: JustifyContent?

justifyItems

open var justifyItems: JustifyItems?

justifySelf

open var justifySelf: JustifyItems?

kvscope

var kvscope: dynamic

label

var label: String?

The label text bound to the checkbox input element.

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?

modifier

var modifier: String?

A modifier attribute to specify custom styles.

name

open var name: String?

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?

resize

open var resize: Resize?

rich

var rich: Boolean

Determines if label can contain HTML code.

right

open var right: CssSize?

role

var role: String?

size

open var size: InputSize?

startValue

var startValue: Boolean

The value attribute of the generated HTML input element.

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?

validationStatus

open var validationStatus: ValidationStatus?

validatorError

open var validatorError: String?

value

open override var value: Boolean

Checkbox input value.

verticalAlign

open var verticalAlign: VerticalAlign?

visible

open override var visible: Boolean

whiteSpace

open var whiteSpace: WhiteSpace?

width

open var width: CssSize?

wordBreak

open var wordBreak: WordBreak?

wordSpacing

open var wordSpacing: CssSize?

zIndex

open var zIndex: Int?

Functions

actionSheet

fun Container.actionSheet(actionSheetTitle: String? = null, cancelable: Boolean? = null, animation: Boolean? = null, className: String? = null, init: ActionSheet.() -> Unit? = null): ActionSheet

DSL builder extension function.

add

open override fun add(child: Component)

open override fun add(position: Int, child: Component)

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

addAll

open override fun addAll(children: List<Component>)

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)

alertDialog

fun Container.alertDialog(dialogTitle: String? = null, cancelable: Boolean? = null, animation: Boolean? = null, rowfooter: Boolean? = null, className: String? = null, init: AlertDialog.() -> Unit? = null): AlertDialog

DSL builder extension function.

blur

open override fun blur()

card

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

DSL builder extension function.

carousel

fun Container.carousel(direction: CarouselDirection? = null, fullscreen: Boolean? = null, overscrollable: Boolean? = null, autoScroll: Boolean? = null, animation: Boolean? = null, swipeable: Boolean? = null, initialIndex: Int? = null, className: String? = null, init: Carousel.() -> Unit? = null): Carousel

DSL builder extension function.

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()

dialog

fun Container.dialog(cancelable: Boolean? = null, animation: Boolean? = null, className: String? = null, init: Dialog.() -> Unit? = null): Dialog

DSL builder extension function.

dispatchEvent

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

dispose

open override fun dispose()

disposeAll

open override fun disposeAll()

enableGestureDetector

fun Widget.enableGestureDetector()

Enable gesture detector for a given Widget.

fab

fun Container.fab(icon: String? = null, floatPosition: FloatPosition? = null, content: String? = null, rich: Boolean = false, className: String? = null, init: Fab.() -> Unit? = null): Fab

DSL builder extension function.

focus

open override fun focus()

getAttribute

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

getChildren

open override fun getChildren(): List<Component>

getElement

open override fun getElement(): HTMLElement?

getElementD

open override fun getElementD(): dynamic

getRoot

open override fun getRoot(): Root?

getSnStyle

open fun getSnStyle(): dynamic

getState

open override fun getState(): Boolean

getStyle

fun getStyle(name: String): String?

getValue

open override fun getValue(): Boolean

getValueAsString

open override fun getValueAsString(): String?

hasCssClass

open override fun hasCssClass(css: String): Boolean

hide

open fun hide()

icon

fun Container.icon(icon: String, size: String? = null, rotate: Number? = null, fixedWidth: Boolean? = null, spin: Boolean? = null, className: String? = null, init: Icon.() -> Unit? = null): Icon

DSL builder extension function.

invoke

open operator fun invoke(vararg children: Component)

modal

fun Container.modal(animation: ModalAnimation? = null, className: String? = null, init: Modal.() -> Unit? = null): Modal

DSL builder extension function.

onsButton

fun Container.onsButton(content: String? = null, rich: Boolean = false, align: Align? = null, icon: String? = null, buttonType: OnsButtonType? = null, large: Boolean? = null, ripple: Boolean? = null, disabled: Boolean? = null, className: String? = null, init: OnsButton.() -> Unit? = null): OnsButton

DSL builder extension function.

onsCheckBox

fun Container.onsCheckBox(value: Boolean = false, name: String? = null, label: String? = null, rich: Boolean = false, className: String? = null, init: OnsCheckBox.() -> Unit? = null): OnsCheckBox

DSL builder extension function.

onsCheckBoxInput

fun Container.onsCheckBoxInput(value: Boolean = false, inputId: String? = null, className: String? = null, init: OnsCheckBoxInput.() -> Unit? = null): OnsCheckBoxInput

DSL builder extension function.

onsDateTime

fun Container.onsDateTime(value: Date? = null, mode: DateTimeMode = DateTimeMode.DATETIME, min: Date? = null, max: Date? = null, step: Number? = null, name: String? = null, label: String? = null, rich: Boolean = false, className: String? = null, init: OnsDateTime.() -> Unit? = null): OnsDateTime

DSL builder extension function.

onsDateTimeInput

fun Container.onsDateTimeInput(value: Date? = null, mode: DateTimeMode = DateTimeMode.DATETIME, min: Date? = null, max: Date? = null, step: Number? = null, inputId: String? = null, className: String? = null, init: OnsDateTimeInput.() -> Unit? = null): OnsDateTimeInput

DSL builder extension function.

onsList

fun Container.onsList(inset: Boolean = false, noborder: Boolean = false, className: String? = null, init: OnsList.() -> Unit? = null): OnsList

DSL builder extension function.

onsListTitle

fun Container.onsListTitle(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: OnsListTitle.() -> Unit? = null): OnsListTitle

DSL builder extension function.

onsNumber

fun Container.onsNumber(value: Number? = null, min: Number? = null, max: Number? = null, step: Number = DEFAULT_STEP, placeholder: String? = null, floatLabel: Boolean? = null, name: String? = null, label: String? = null, rich: Boolean = false, className: String? = null, init: OnsNumber.() -> Unit? = null): OnsNumber

DSL builder extension function.

onsNumberInput

fun Container.onsNumberInput(value: Number? = null, min: Number? = null, max: Number? = null, step: Number = DEFAULT_STEP, placeholder: String? = null, floatLabel: Boolean? = null, inputId: String? = null, className: String? = null, init: OnsNumberInput.() -> Unit? = null): OnsNumberInput

DSL builder extension function.

onsRadio

fun Container.onsRadio(value: Boolean = false, extraValue: String? = null, name: String? = null, label: String? = null, rich: Boolean = false, className: String? = null, init: OnsRadio.() -> Unit? = null): OnsRadio

DSL builder extension function.

onsRadioGroup

fun Container.onsRadioGroup(options: List<StringPair>? = null, value: String? = null, name: String? = null, label: String? = null, rich: Boolean = false, className: String? = null, init: OnsRadioGroup.() -> Unit? = null): OnsRadioGroup

DSL builder extension function.

onsRadioGroupInput

fun Container.onsRadioGroupInput(options: List<StringPair>? = null, value: String? = null, name: String? = null, className: String? = null, init: OnsRadioGroupInput.() -> Unit? = null): OnsRadioGroupInput

DSL builder extension function.

onsRadioInput

fun Container.onsRadioInput(value: Boolean = false, inputId: String? = null, className: String? = null, init: OnsRadioInput.() -> Unit? = null): OnsRadioInput

DSL builder extension function.

onsRange

fun Container.onsRange(value: Number? = null, min: Number = 0, max: Number = 100, step: Number = DEFAULT_STEP, name: String? = null, label: String? = null, rich: Boolean = false, className: String? = null, init: OnsRange.() -> Unit? = null): OnsRange

DSL builder extension function.

onsRangeInput

fun Container.onsRangeInput(value: Number? = null, min: Number = 0, max: Number = 100, step: Number = DEFAULT_STEP, inputId: String? = null, className: String? = null, init: OnsRangeInput.() -> Unit? = null): OnsRangeInput

DSL builder extension function.

onsSelect

fun Container.onsSelect(options: List<StringPair>? = null, value: String? = null, emptyOption: Boolean = false, multiple: Boolean = false, selectSize: Int? = null, name: String? = null, label: String? = null, rich: Boolean = false, className: String? = null, init: OnsSelect.() -> Unit? = null): OnsSelect

DSL builder extension function.

onsSelectInput

fun Container.onsSelectInput(options: List<StringPair>? = null, value: String? = null, emptyOption: Boolean = false, multiple: Boolean = false, selectSize: Int? = null, inputId: String? = null, className: String? = null, init: OnsSelectInput.() -> Unit? = null): OnsSelectInput

DSL builder extension function.

onsSwitch

fun Container.onsSwitch(value: Boolean = false, name: String? = null, label: String? = null, rich: Boolean = false, className: String? = null, init: OnsSwitch.() -> Unit? = null): OnsSwitch

DSL builder extension function.

onsSwitchInput

fun Container.onsSwitchInput(value: Boolean = false, inputId: String? = null, className: String? = null, init: OnsSwitchInput.() -> Unit? = null): OnsSwitchInput

DSL builder extension function.

onsText

fun Container.onsText(type: InputType = InputType.TEXT, value: String? = null, placeholder: String? = null, floatLabel: Boolean? = null, name: String? = null, maxlength: Int? = null, label: String? = null, rich: Boolean = false, className: String? = null, init: OnsText.() -> Unit? = null): OnsText

DSL builder extension function.

onsTextInput

fun Container.onsTextInput(type: InputType = InputType.TEXT, value: String? = null, placeholder: String? = null, floatLabel: Boolean? = null, inputId: String? = null, maxlength: Int? = null, className: String? = null, init: OnsTextInput.() -> Unit? = null): OnsTextInput

DSL builder extension function.

popover

fun Container.popover(direction: FloatDirection? = null, cancelable: Boolean? = null, animation: Boolean? = null, className: String? = null, init: Popover.() -> Unit? = null): Popover

DSL builder extension function.

progressBar

fun Container.progressBar(value: Number? = null, secondaryValue: Number? = null, indeterminate: Boolean? = null, className: String? = null, init: ProgressBar.() -> Unit? = null): ProgressBar

DSL builder extension function.

progressCircular

fun Container.progressCircular(value: Number? = null, secondaryValue: Number? = null, indeterminate: Boolean? = null, className: String? = null, init: ProgressCircular.() -> Unit? = null): ProgressCircular

DSL builder extension function.

refresh

open override fun refresh()

remove

open override fun remove(child: Component)

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

removeAll

open override fun removeAll()

removeAt

open override fun removeAt(position: Int)

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 override fun removeEventListener(id: Int)

removeEventListeners

open override 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

ripple

fun Container.ripple(rippleColor: Color? = null, rippleBackground: Color? = null, size: RippleSize? = null, center: Boolean? = null, className: String? = null, init: Ripple.() -> Unit? = null): Ripple

DSL builder extension function.

row

fun Container.row(rowVerticalAlign: GridVerticalAlign? = null, className: String? = null, init: Row.() -> Unit? = null): Row

DSL builder extension function.

segment

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

DSL builder extension function.

setAttribute

open override fun setAttribute(name: String, value: String)

setDragDropData

open fun setDragDropData(format: String, data: String)

setDropTarget

open fun setDropTarget(format: String, callback: (DragEvent) -> Unit)

open fun setDropTarget(formats: Set<String>?, callback: (DragEvent) -> Unit)

setDropTargetData

open fun setDropTargetData(format: String, callback: (String?) -> Unit)

setEventListener

open override fun <T : Widget> setEventListener(block: SnOn<T>.() -> Unit): Int

setState

open override fun setState(state: Boolean)

setStyle

fun setStyle(name: String, value: String)

setValue

open override fun setValue(v: Any?)

show

open fun show()

singleRender

open override fun <T> singleRender(block: () -> T): T

singleRenderAsync

open override fun singleRenderAsync(block: () -> Unit)

speedDial

fun Container.speedDial(icon: String? = null, floatPosition: FloatPosition? = null, floatDirection: FloatDirection? = null, content: String? = null, rich: Boolean = false, className: String? = null, init: SpeedDial.() -> Unit? = null): SpeedDial

DSL builder extension function.

styleForHorizontalFormPanel

open fun styleForHorizontalFormPanel(horizontalRatio: FormHorizontalRatio)

styleForInlineFormPanel

open fun styleForInlineFormPanel()

styleForVerticalFormPanel

open fun styleForVerticalFormPanel()