react-hook-form-generator/dist/types.d.ts

A [React](https://reactjs.org/) component to quickly and easily generate forms from object schema. Built with [React Hook Form](https://react-hook-form.com/) and [Chakra UI](https://chakra-ui.com/).

import { FC } from 'react';
import { FormControlProps, InputProps, BoxProps, HeadingProps, ButtonGroupProps, ButtonProps, InputAddonProps, IconButtonProps, StackProps, FlexProps, PseudoBoxProps, SwitchProps, CheckboxProps, SelectProps, InputGroupProps } from '@chakra-ui/core';
import { FormLabelProps } from '@chakra-ui/core/dist/FormLabel';
export declare type Schema = Record<string, Field>;
export declare type Field = TextFieldSchema | TextAreaFieldSchema | NumberFieldSchema | ArrayFieldSchema | ObjectFieldSchema | SwitchFieldSchema | CheckboxFieldSchema | SelectFieldSchema | CustomFieldSchema;
export interface FieldProps<T extends FieldSchema> {
    id?: string;
    name: string;
    field: T;
    defaultValue?: any;
}
interface FieldSchema {
    type: 'text' | 'textArea' | 'number' | 'switch' | 'array' | 'object' | 'checkbox' | 'select' | 'custom';
    styles?: FieldStyles | ArrayFieldStyles | ObjectFieldStyles | CheckboxFieldStyles | SelectFieldStyles;
    shouldDisplay?: (values?: any) => boolean;
}
export interface CustomFieldSchema extends Pick<FieldSchema, 'type'> {
    type: 'custom';
    component: FC<Record<string, any>>;
    props?: Record<string, any>;
}
interface FormController {
    label?: string;
    placeholder?: string;
    helperText?: string;
    isRequired?: boolean;
}
export interface TextFieldSchema extends FieldSchema, FormController {
    type: 'text';
    htmlInputType?: string;
    leftInputAddon?: InputAddonProps;
    rightInputAddon?: InputAddonProps;
}
export interface TextAreaFieldSchema extends FieldSchema, FormController {
    type: 'textArea';
}
export interface NumberFieldSchema extends FieldSchema, FormController {
    type: 'number';
}
export interface ArrayFieldSchema extends FieldSchema, Pick<FormController, 'label' | 'helperText' | 'isRequired'> {
    type: 'array';
    isCollapsable?: boolean;
    itemField: Field;
}
export interface ObjectFieldSchema extends FieldSchema, Pick<FormController, 'label' | 'helperText' | 'isRequired'> {
    type: 'object';
    isCollapsable?: boolean;
    properties: Record<string, Field>;
}
export interface SwitchFieldSchema extends FieldSchema, Pick<FormController, 'label' | 'helperText' | 'isRequired'> {
    type: 'switch';
}
export interface CheckboxFieldSchema extends FieldSchema, Pick<FormController, 'label' | 'helperText' | 'isRequired'> {
    type: 'checkbox';
    checkboxes: {
        name: string;
        label?: string;
    }[];
}
export interface SelectFieldSchema extends FieldSchema, Pick<FormController, 'label' | 'helperText' | 'isRequired'> {
    type: 'select';
    options: {
        label?: string;
        value: string;
    }[];
}
export interface FormStyles {
    form?: {
        container?: BoxProps;
        title?: HeadingProps;
        fieldSpacing?: number;
        buttonGroup?: ButtonGroupProps;
        submitButton?: Omit<ButtonProps, 'children' | 'type'>;
        resetButton?: Omit<ButtonProps, 'children' | 'type'>;
    };
    textField?: FieldStyles;
    textAreaField?: FieldStyles;
    numberField?: FieldStyles;
    arrayField?: ArrayFieldStyles;
    objectField?: ObjectFieldStyles;
    switchField?: SwitchFieldStyles;
    checkboxField?: CheckboxFieldStyles;
    selectField?: SelectFieldStyles;
}
export interface FieldStyles {
    control?: FormControlProps;
    label?: Omit<FormLabelProps, 'children'>;
    input?: InputProps<HTMLInputElement>;
    helperText?: BoxProps;
    errorMessage?: BoxProps;
    inputGroup?: Omit<InputGroupProps, 'children'>;
}
export interface ArrayFieldStyles extends Pick<FieldStyles, 'control' | 'label' | 'helperText' | 'errorMessage'>, CollapsableStyles {
    arrayContainer?: StackProps;
    itemContainer?: BoxProps;
    buttonGroup?: ButtonGroupProps;
    addButton?: Partial<IconButtonProps>;
    deleteButton?: Partial<IconButtonProps>;
    clearButton?: Partial<IconButtonProps>;
    deleteItemContainer?: BoxProps;
    countText?: PseudoBoxProps;
}
export interface ObjectFieldStyles extends Pick<FieldStyles, 'control' | 'label' | 'helperText' | 'errorMessage'>, CollapsableStyles {
    objectContainer?: StackProps;
    propertyContainer?: BoxProps;
}
export interface CollapsableStyles {
    toolbar?: FlexProps;
    collapseButton?: Partial<IconButtonProps>;
}
export interface SwitchFieldStyles extends Pick<FieldStyles, 'control' | 'label' | 'helperText' | 'errorMessage'> {
    switch?: SwitchProps;
}
export interface CheckboxFieldStyles extends Pick<FieldStyles, 'control' | 'label' | 'helperText' | 'errorMessage'> {
    checkboxGroup?: StackProps;
    checkbox?: CheckboxProps;
}
export interface SelectFieldStyles extends Pick<FieldStyles, 'control' | 'label' | 'helperText' | 'errorMessage'> {
    select?: SelectProps;
}
export {};