@app/coreformsCheckbox

Checkbox

import { Checkbox } from '@app/forms/Checkbox.styled'
Component Props
checked
boolean
label
string
disabled
boolean
hasError
boolean
className
string
checkboxClassName
string
indicatorClassName
string
labelClassName
string
hitSlop
number
Show Props Schema
const CheckboxProps = z.object({
    checked: z
        .boolean()
        .optional(),
    label: z
        .string()
        .optional()
        .example("Label"),
    disabled: z
        .boolean()
        .optional(),
    hasError: z
        .boolean()
        .optional(),
    className: z
        .string()
        .optional(),
    checkboxClassName: z
        .string()
        .optional(),
    indicatorClassName: z
        .string()
        .optional(),
    labelClassName: z
        .string()
        .optional(),
    hitSlop: z
        .number()
        .default(6),
})

💡 Could be handy to copy-paste into an AI chat?

Show Props Types
{
    checked?: boolean;
    label?: string | undefined;
    disabled?: boolean;
    hasError?: boolean;
    className?: string | undefined;
    checkboxClassName?: string | undefined;
    indicatorClassName?: string | undefined;
    labelClassName?: string | undefined;
    hitSlop?: number;
}

💡 Could be handy to copy-paste into an AI chat?

File Location

You can find the source of the Checkbox component in the following location:

        • Checkbox.styled.tsx

Other

Disclaimer - Automatic Docgen

🤖

These dynamic component docs were auto-generated with npm run regenerate-docs. You can hook into automatic docgen by exporting getDocumentationProps from a component file. You’ll want to provide example props from the ComponentProps zod schema, e.g:

Checkbox.styled.tsx
/* --- Docs ---------------------- */
 
export const getDocumentationProps = CheckboxProps.documentationProps('Checkbox')
NumberStepperCheckList