## API Report File for "@atlaskit/form" > Do not edit this file. This report is auto-generated using > [API Extractor](https://api-extractor.com/). > [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports) ### Table of contents - [Main Entry Types](#main-entry-types) - [Peer Dependencies](#peer-dependencies) ### Main Entry Types ```ts import { FC } from 'react'; import { FormApi as FormApi_2 } from 'final-form'; import { FormEvent } from 'react'; import { FormState } from 'final-form'; import { jsx } from '@emotion/react'; import { default as React_2 } from 'react'; import { ReactNode } from 'react'; // @public (undocumented) type Align = 'end' | 'start'; // @public export const CheckboxField: FC; // @public (undocumented) export interface CheckboxFieldProps extends FieldProps { // (undocumented) isChecked: boolean; } // @public (undocumented) interface CheckboxProps { children: (args: { fieldProps: CheckboxFieldProps; error?: string; valid: boolean; meta: Meta; }) => ReactNode; defaultIsChecked?: boolean; isDisabled?: boolean; isRequired?: boolean; label?: ReactNode; name: string; value?: string; } // @public export const ErrorMessage: ({ children, testId }: MessageProps) => jsx.JSX.Element; // @public (undocumented) export function Field( props: FieldComponentProps, ): jsx.JSX.Element; // @public (undocumented) interface FieldComponentProps { children: (args: { fieldProps: FieldProps; error?: string; valid: boolean; meta: Meta; }) => ReactNode; defaultValue?: ((currentDefaultValue?: FieldValue) => FieldValue) | FieldValue; elementAfterLabel?: ReactNode; id?: string; isDisabled?: boolean; isRequired?: boolean; label?: ReactNode; name: string; testId?: string; transform?: (event: FieldValue | FormEvent, current: FieldValue) => FieldValue; validate?: ( value: FieldValue | undefined, formState: Object, fieldState: Meta, ) => Promise | string | void; } // @public (undocumented) export interface FieldProps { // (undocumented) 'aria-invalid': 'false' | 'true'; // (undocumented) 'aria-labelledby': string; // (undocumented) id: string; // (undocumented) isDisabled: boolean; // (undocumented) isInvalid: boolean; // (undocumented) isRequired: boolean; // (undocumented) name: string; // (undocumented) onBlur: () => void; // (undocumented) onChange: (value: FieldValue | FormEvent) => void; // (undocumented) onFocus: () => void; // (undocumented) value: FieldValue; } // @public export const Fieldset: ({ children, legend }: FieldsetProps) => jsx.JSX.Element; // @public (undocumented) interface FieldsetProps { children: ReactNode; legend?: ReactNode; } // @public (undocumented) function Form = {}>( props: FormProps, ): JSX.Element; export default Form; // @public (undocumented) export type FormApi = FormApi_2; // @public (undocumented) interface FormChildrenProps { // (undocumented) onKeyDown: (event: React_2.KeyboardEvent) => void; // (undocumented) onSubmit: ( event?: React_2.FormEvent | React_2.SyntheticEvent, ) => void; // (undocumented) ref: React_2.RefObject; } // @public export function FormFooter({ align, children }: FormFooterProps): jsx.JSX.Element; // @public (undocumented) interface FormFooterProps { align?: Align; children?: ReactNode; } // @public export const FormHeader: ({ children, description, title }: FormHeaderProps) => jsx.JSX.Element; // @public (undocumented) interface FormHeaderProps { children?: ReactNode; description?: ReactNode; title?: ReactNode; } // @public (undocumented) export interface FormProps { children: (args: { formProps: FormChildrenProps; disabled: boolean; dirty: boolean; submitting: boolean; getState: () => FormState; getValues: () => FormValues; setFieldValue: (name: string, value: any) => void; reset: (initialValues?: FormValues) => void; }) => ReactNode; isDisabled?: boolean; onSubmit: OnSubmitHandler; } // @public export const FormSection: ({ children, description, title }: FormSectionProps) => jsx.JSX.Element; // @public (undocumented) interface FormSectionProps { children?: ReactNode; description?: ReactNode; title?: ReactNode; } // @public export const HelperMessage: ({ children, testId }: MessageProps) => jsx.JSX.Element; // @public interface InternalMessageProps { appearance?: MessageAppearance; children: ReactNode; // (undocumented) fieldId?: string; testId?: string; } // @public export const Label: FC; // @public (undocumented) export interface LabelProps { // (undocumented) children: ReactNode; // (undocumented) htmlFor: string; // (undocumented) id?: string; // (undocumented) testId?: string; } // @public export const Legend: FC; // @public (undocumented) export interface LegendProps { // (undocumented) children: ReactNode; } // @public (undocumented) type MessageAppearance = 'default' | 'error' | 'valid'; // @public type MessageProps = Pick; // @public (undocumented) interface Meta { // (undocumented) dirty: boolean; // (undocumented) dirtySinceLastSubmit: boolean; // (undocumented) error?: string; // (undocumented) submitError?: boolean; // (undocumented) submitFailed: boolean; // (undocumented) submitting: boolean; // (undocumented) touched: boolean; // (undocumented) valid: boolean; // (undocumented) validating?: boolean; } // @public (undocumented) export type OnSubmitHandler = ( values: FormData, form: FormApi, callback?: (errors?: Record) => void, ) => Object | Promise