Hex Core JS
    Preparing search index...

    Type Alias BooleanFieldProps<FV>

    BooleanFieldProps: FieldProps<FV, BooleanFieldValue> & {
        format?: FieldFormatFunction<BooleanFieldValue>;
        Input?: (props: BooleanFieldInputProps) => JSX.Element | null;
        oneLine?: boolean;
        type?: BooleanInputType;
    } & Partial<ClassNameProps & StyleProps>

    Type Parameters

    Type Declaration

    • Optionalformat?: FieldFormatFunction<BooleanFieldValue>

      Format function for the value. Controls how the value should be formatted when displayed in smaller contexts where only strings are allowed.

    • OptionalInput?: (props: BooleanFieldInputProps) => JSX.Element | null

      The input component to use when editing.

    • OptionaloneLine?: boolean

      Displays the field in one line (checkbox to the left of label) when editing.

      Default behavior is to display as one line in write-only forms but as multiple lines in read-write forms. Setting a value of true results in one line display for all form types and setting a value of false results in multiple line display for all form types.

    • Optionaltype?: BooleanInputType

      The type of text field.