Home Reference Source
import CheckBoxComponent from 'formiojs/src/components/checkbox/Checkbox.js'
public class | source

CheckBoxComponent

Extends:

src/components/_classes/component/Component.js~ComponentField → CheckBoxComponent

Static Member Summary

Static Public Members
public static get

builderInfo: {"title": string, "group": string, "icon": string, "documentation": string, "weight": number, "schema": *}

Static Method Summary

Static Public Methods
public static

schema(extend: ...*): *

Member Summary

Public Members
public get

checked: *

public get
public get
public get
public get
public

input: *

public get
public get

key: *

public get
public get

labelInfo: {"hidden": boolean}

Method Summary

Public Methods
public

attach(element: *): *

public

detach(element: *)

public

getValue(): *

public

getValueAsString(value: *): *

public

getValueAt(index: *): *

public

isEmpty(value: *): *

public

render(): *

public

setCheckedState(value: *): *

public

setValue(value: *, flags: {}): boolean

public

updateValue(value: *, flags: *): *

Inherited Summary

From class Field
public

render(element: *): *

Static Public Members

public static get builderInfo: {"title": string, "group": string, "icon": string, "documentation": string, "weight": number, "schema": *} source

Static Public Methods

public static schema(extend: ...*): * source

Params:

NameTypeAttributeDescription
extend ...*

Return:

*

Public Members

public get checked: * source

public get defaultSchema: * source

public get defaultValue: * source

public get emptyValue: * source

public get hasSetValue: * source

public input: * source

public get inputInfo: * source

public get key: * source

public get labelClass: string source

public get labelInfo: {"hidden": boolean} source

Public Methods

public attach(element: *): * source

Params:

NameTypeAttributeDescription
element *

Return:

*

public detach(element: *) source

Params:

NameTypeAttributeDescription
element *

public getValue(): * source

Return:

*

public getValueAsString(value: *): * source

Params:

NameTypeAttributeDescription
value *

Return:

*

public getValueAt(index: *): * source

Params:

NameTypeAttributeDescription
index *

Return:

*

public isEmpty(value: *): * source

Params:

NameTypeAttributeDescription
value *
  • optional

Return:

*

public render(): * source

Override:

Field#render

Return:

*

public setCheckedState(value: *): * source

Params:

NameTypeAttributeDescription
value *

Return:

*

public setValue(value: *, flags: {}): boolean source

Params:

NameTypeAttributeDescription
value *
flags {}
  • optional
  • default: {}

Return:

boolean

public updateValue(value: *, flags: *): * source

Params:

NameTypeAttributeDescription
value *
flags *

Return:

*