CheckBoxBinding
Defined in: CheckBoxBinding.ts:5, CheckBoxBinding.ts:35
Binding for checkbox input elements
Key features:
- Handles boolean states
- Manages error states and ARIA attributes
Implements
Section titled “Implements”FormBinding
Config
Section titled “Config”Config =
object
Defined in: CheckBoxBinding.ts:11
aria-describedby?
Section titled “aria-describedby?”
optionalaria-describedby?:Attrs["aria-describedby"]
Defined in: CheckBoxBinding.ts:24
[Extend] IDs of the elements describing the checkbox; the ID of the error text is added while errors are reported
getter
Section titled “getter”getter: () =>
boolean
Defined in: CheckBoxBinding.ts:13
Get the value from the model
Returns
Section titled “Returns”boolean
optionalid?:Attrs["id"]
Defined in: CheckBoxBinding.ts:18
[Override] ID of the input element
onChange?
Section titled “onChange?”
optionalonChange?:Attrs["onChange"]
Defined in: CheckBoxBinding.ts:20
[Extend] Change handler
onFocus?
Section titled “onFocus?”
optionalonFocus?:Attrs["onFocus"]
Defined in: CheckBoxBinding.ts:22
[Extend] Focus handler
setter
Section titled “setter”setter: (
value:boolean) =>void
Defined in: CheckBoxBinding.ts:15
@action
Set the value to the model
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”void
Constructor
Section titled “Constructor”new CheckBoxBinding(
field,config):CheckBoxBinding
Defined in: CheckBoxBinding.ts:36
Parameters
Section titled “Parameters”FormField
config
Section titled “config”Returns
Section titled “Returns”CheckBoxBinding
Members
Section titled “Members”config
Section titled “config”config:
CheckBoxBinding.Config
Defined in: CheckBoxBinding.ts:38
Implementation of
Section titled “Implementation of”FormBinding.config
onChange
Section titled “onChange”onChange:
ChangeEventHandler<HTMLInputElement,HTMLInputElement>
Defined in: CheckBoxBinding.ts:48
@action
onFocus
Section titled “onFocus”onFocus:
FocusEventHandler<HTMLInputElement>
Defined in: CheckBoxBinding.ts:54
checked
Section titled “checked”Get Signature
Section titled “Get Signature”get checked():
boolean
Defined in: CheckBoxBinding.ts:43
Returns
Section titled “Returns”boolean
errorMessages
Section titled “errorMessages”Get Signature
Section titled “Get Signature”get errorMessages():
string|null
Defined in: CheckBoxBinding.ts:60
Returns
Section titled “Returns”string | null
@computed
Get Signature
Section titled “Get Signature”get props():
object
Defined in: CheckBoxBinding.ts:65
Binding properties which passed to the view component
Returns
Section titled “Returns”object
aria-describedby
Section titled “aria-describedby”aria-describedby:
string|undefined
aria-errormessage
Section titled “aria-errormessage”aria-errormessage:
string|undefined
aria-invalid
Section titled “aria-invalid”aria-invalid:
boolean|undefined
checked
Section titled “checked”checked:
boolean
id:
string
onChange
Section titled “onChange”onChange:
ChangeEventHandler<HTMLInputElement,HTMLInputElement>
onFocus
Section titled “onFocus”onFocus:
FocusEventHandler<HTMLInputElement>
type:
"checkbox"="checkbox"
Implementation of
Section titled “Implementation of”FormBinding.props