Skip to content
Source
Sign inSign up
TanStack/form
Open History to see the last commit

solidformapi.md

110 lines3.0 KB

Interface: SolidFormApi<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TSubmitMeta>

Defined in: packages/solid-form/src/createForm.tsx:14

Type Parameters

• TParentData

• TFormOnMount extends undefined | FormValidateOrFn<TParentData>

• TFormOnChange extends undefined | FormValidateOrFn<TParentData>

• TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>

• TFormOnBlur extends undefined | FormValidateOrFn<TParentData>

• TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>

• TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>

• TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>

• TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>

• TSubmitMeta

Properties

createField

createField: CreateField<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TSubmitMeta>;

Defined in: packages/solid-form/src/createForm.tsx:38


Field

Field: FieldComponent<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TSubmitMeta>;

Defined in: packages/solid-form/src/createForm.tsx:26


Subscribe()

Subscribe: <TSelected>(props) => Element;

Defined in: packages/solid-form/src/createForm.tsx:81

Type Parameters

• TSelected = NoInfer<FormState<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer>>

Parameters

props
children

Element | (state) => Element

selector?

(state) => TSelected

Returns

Element


useStore()

useStore: <TSelected>(selector?) => () => TSelected;

Defined in: packages/solid-form/src/createForm.tsx:50

Type Parameters

• TSelected = NoInfer<FormState<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer>>

Parameters

selector?

(state) => TSelected

Returns

Function

Returns

TSelected