UNPKG

finform-react-builder

Version:

A powerful, flexible React form builder with dynamic field rendering, custom validation, multi-step forms, Material-UI integration, image component support, toggle/radio buttons, switches, autocomplete, and advanced button positioning

35 lines (34 loc) 1.22 kB
import { default as React } from 'react'; export interface FinCheckboxOption { label: string; value: string | number; } export interface FinCheckboxGroupProps { /** Optional section heading above the group */ labelText?: string; /** The inner label for the checkbox group itself (accessible) */ label?: string; /** The currently selected values (array) */ value: (string | number)[]; /** The list of options */ options: FinCheckboxOption[]; /** Layout: 'row' | 'column' | number (for grid columns, e.g., 2, 3, 4) */ row?: boolean | number; /** Handles change */ onChange: (values: (string | number)[]) => void; /** Top heading or none */ labelPosition?: 'top' | 'none'; /** Typography variant for the heading */ labelVariant?: 'caption' | 'body2' | 'subtitle2' | 'h6'; /** Optional helper text under the group */ helperText?: string; /** Optional error state */ error?: boolean; /** Group padding multiplier */ groupPadding?: number; /** Gap between checkbox options */ itemGap?: number; /** Disabled state */ disabled?: boolean; } export declare const FinCheckboxGroup: React.FC<FinCheckboxGroupProps>;