@karmaniverous/hook-form-semantic
    Preparing search index...

    Interface HookFormCheckboxProps<TFieldValues, TName>

    interface HookFormCheckboxProps<
        TFieldValues extends FieldValues = FieldValues,
        TName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>,
    > {
        as?: any;
        checkboxAs?: any;
        checkboxChecked?: boolean;
        checkboxClassName?: string;
        checkboxDefaultChecked?: boolean;
        checkboxDefaultIndeterminate?: boolean;
        checkboxDisabled?: boolean;
        checkboxFitted?: boolean;
        checkboxId?: string | number;
        checkboxIndeterminate?: boolean;
        checkboxLabel?: SemanticShorthandItem<HtmlLabelProps>;
        checkboxName?: string;
        checkboxOnChange?: (
            event: FormEvent<HTMLInputElement>,
            data: CheckboxProps,
        ) => void;
        checkboxOnClick?: (
            event: MouseEvent<HTMLInputElement>,
            data: CheckboxProps,
        ) => void;
        checkboxOnMouseDown?: (
            event: MouseEvent<HTMLInputElement>,
            data: CheckboxProps,
        ) => void;
        checkboxOnMouseUp?: (
            event: MouseEvent<HTMLInputElement>,
            data: CheckboxProps,
        ) => void;
        checkboxRadio?: boolean;
        checkboxReadOnly?: boolean;
        checkboxSlider?: boolean;
        checkboxTabIndex?: string | number;
        checkboxToggle?: boolean;
        checkboxType?: "checkbox" | "radio";
        checkboxValue?: string | number;
        checkLabel?: string;
        className?: string;
        content?: ReactNode;
        control?: any;
        hookControl?: Control<TFieldValues, any, TFieldValues>;
        hookDefaultValue?: PathValueImpl<TFieldValues, TName>;
        hookDisabled?: boolean;
        hookName: TName;
        hookRules?: Omit<
            RegisterOptions<TFieldValues, TName>,
            "disabled" | "valueAsNumber" | "valueAsDate" | "setValueAs",
        >;
        hookShouldUnregister?: boolean;
        id?: string | number;
        inline?: boolean;
        label?: SemanticShorthandItem<HtmlLabelProps>;
        leftLabel?: string;
        logger?: Logger;
        required?: any;
        rightLabel?: string;
        type?: string;
        uncheckLabel?: string;
        width?: SemanticWIDTHS;
    }

    Type Parameters

    Hierarchy

    • HookFormProps<TFieldValues, TName>
    • Omit<
          StrictFormFieldProps,
          | "children"
          | "checked"
          | "disabled"
          | "error"
          | "name"
          | "onBlur"
          | "onChange"
          | "ref"
          | "value",
      >
    • PrefixProps<StrictCheckboxProps, "checkbox">
      • HookFormCheckboxProps
    Index

    Properties

    as? checkboxAs? checkboxChecked? checkboxClassName? checkboxDefaultChecked? checkboxDefaultIndeterminate? checkboxDisabled? checkboxFitted? checkboxId? checkboxIndeterminate? checkboxLabel? checkboxName? checkboxOnChange? checkboxOnClick? checkboxOnMouseDown? checkboxOnMouseUp? checkboxRadio? checkboxReadOnly? checkboxSlider? checkboxTabIndex? checkboxToggle? checkboxType? checkboxValue? checkLabel? className? content? control? hookControl? hookDefaultValue? hookDisabled? hookName hookRules? hookShouldUnregister? id? inline? label? leftLabel? logger? required? rightLabel? type? uncheckLabel? width?

    Properties

    as?: any

    An element type to render as (string or function).

    checkboxAs?: any
    checkboxChecked?: boolean
    checkboxClassName?: string
    checkboxDefaultChecked?: boolean
    checkboxDefaultIndeterminate?: boolean
    checkboxDisabled?: boolean
    checkboxFitted?: boolean
    checkboxId?: string | number
    checkboxIndeterminate?: boolean
    checkboxLabel?: SemanticShorthandItem<HtmlLabelProps>
    checkboxName?: string
    checkboxOnChange?: (
        event: FormEvent<HTMLInputElement>,
        data: CheckboxProps,
    ) => void
    checkboxOnClick?: (
        event: MouseEvent<HTMLInputElement>,
        data: CheckboxProps,
    ) => void
    checkboxOnMouseDown?: (
        event: MouseEvent<HTMLInputElement>,
        data: CheckboxProps,
    ) => void
    checkboxOnMouseUp?: (
        event: MouseEvent<HTMLInputElement>,
        data: CheckboxProps,
    ) => void
    checkboxRadio?: boolean
    checkboxReadOnly?: boolean
    checkboxSlider?: boolean
    checkboxTabIndex?: string | number
    checkboxToggle?: boolean
    checkboxType?: "checkbox" | "radio"
    checkboxValue?: string | number
    checkLabel?: string
    className?: string

    Additional classes.

    Optionalcontent

    content?: ReactNode

    Shorthand for primary content.

    control?: any

    A form control component (i.e. Dropdown) or HTML tagName (i.e. 'input'). Extra FormField props are passed to the control component. Mutually exclusive with children.

    hookControl?: Control<TFieldValues, any, TFieldValues>
    hookDefaultValue?: PathValueImpl<TFieldValues, TName>
    hookDisabled?: boolean
    hookName: TName
    hookRules?: Omit<
        RegisterOptions<TFieldValues, TName>,
        "disabled" | "valueAsNumber" | "valueAsDate" | "setValueAs",
    >
    hookShouldUnregister?: boolean
    id?: string | number

    The id of the control

    inline?: boolean

    A field can have its label next to instead of above it.

    label?: SemanticShorthandItem<HtmlLabelProps>

    Mutually exclusive with children.

    leftLabel?: string
    logger?: Logger
    required?: any

    A field can show that input is mandatory. Requires a label.

    rightLabel?: string
    type?: string

    Passed to the control component (i.e. )

    uncheckLabel?: string
    width?: SemanticWIDTHS

    A field can specify its width in grid columns

    Settings

    Member Visibility

    On This Page

    Properties