CheckList
import { CheckList } from '@app/forms/CheckList.styled'
Component Props
disabled
boolean
hasError
boolean
className
string
checkboxClassName
string
indicatorClassName
string
labelClassName
string
hitSlop
number
options *
object
value
string[]
Show Props Schema
const CheckListProps = z.object({
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),
options: z
.record(z.string(), z.string()),
value: z
.array(z.string())
.default([]),
})
💡 Could be handy to copy-paste into an AI chat?
Show Props Types
{
disabled?: boolean;
hasError?: boolean;
className?: string | undefined;
checkboxClassName?: string | undefined;
indicatorClassName?: string | undefined;
labelClassName?: string | undefined;
hitSlop?: number;
options: {
[x: string]: string;
};
value?: string[];
}
💡 Could be handy to copy-paste into an AI chat?
File Location
You can find the source of the CheckList
component in the following location:
- CheckList.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:
CheckList.styled.tsx
/* --- Docs ---------------------- */
export const getDocumentationProps = CheckListProps.documentationProps('CheckList')