Interface CheckboxFieldProps

interface CheckboxFieldProps {
    className?: string;
    cols?: 1 | 2 | 4;
    errorText?: string;
    fill: "fill" | "outline";
    items: CheckboxFieldItemProps[];
    label?: string;
    labelWeight?: "bold" | "regular";
    name?: string;
    onChange?: ((value, name?) => void);
    value: string[];
}

Properties

className? cols? errorText? fill items label? labelWeight? name? onChange? value

Properties

Optional className

className?: string

Custom class to give the html component

Optional cols

cols?: 1 | 2 | 4

number of cols to render

Optional errorText

errorText?: string

error text to show below the component

fill

fill: "fill" | "outline"

fill checkbox when checked

items

items: CheckboxFieldItemProps[]

checkbox items to render

Optional label

label?: string

Label to show for the input

Optional labelWeight

labelWeight?: "bold" | "regular"

Configurable label weight

Optional name

name?: string

field name

Optional onChange

onChange?: ((value, name?) => void)

onChange event for field

Type declaration

    • (value, name?): void

    • onChange event for field

      Parameters

      • value: string[]
      • Optional name: string

      Returns void

value

value: string[]

checkbox field values

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc