OrionCheckbox

<o-checkbox> displays a checkbox which can be used to select different choices or it can be an alternative to the <o-toggle> component.

Usage

CheckboxStyle CheckboxValue CheckboxPlayground

Props

Name
autofocusboolean = false
clearableboolean = false
clearToNullboolean = false
colorOrion.Color = 'default'
disabledboolean = false
donetypingnumber = 0
forceLabelFloatingboolean = false
iconCheckOrion.Icon = undefined
inheritValidationStateboolean = undefined
inlineboolean = false
inputValuestring | boolean | number | Object | any[] | Date | undefined = undefined
labelstring = undefined
modelValueT = undefined
multipleboolean = false
placeholderstring = undefined
prefixFontIconstring = undefined
prefixIconOrion.Icon = undefined
readonlyboolean = false
requiredboolean = false
reverseboolean = false
selectOnFocusboolean = false
sizeOrion.Size = 'md'
suffixFontIconstring = undefined
suffixIconOrion.Icon = undefined
typestring = 'checkbox'
validationstring | ((val: any) => boolean) | Orion.Validator.Rule | Orion.Validation.Rule | boolean = undefined
validationErrorMessagestring = undefined

Events

Name
Payload type
focus
FocusEvent
blur
FocusEvent
input
VModelType
change
VModelType
update:modelValue
VModelType
clear
No payload

Slots

Name
Bindings
default
No bindings

PublicInstance

Name
Type
hasBeenFocus
() => boolean
isFocus
() => boolean
focus
() => void
blur
Lodash.debounce
clear
() => void
setHasBeenFocus
(value: boolean) => void
isValid
() => boolean
_input
() => HTMLInputElement | undefined
MIT Licensed | Copyright © 2023-present Orion UI