TanStackFieldLike
interface exported by @mwillbanks/tuil-form.
interface
Public interface exported by @mwillbanks/tuil-form.
export interface TanStackFieldLike<T> {
readonly name: string;
readonly state: {
readonly value: T;
readonly meta: {
readonly errors: readonly unknown[];
readonly isTouched: boolean;
readonly isDirty: boolean;
readonly isValidating: boolean;
};
};
readonly handleChange: (value: T) => void;
readonly handleBlur: () => void;
readonly validate?: (
cause: "change" | "blur" | "submit",
) => unknown | Promise<unknown>;
readonly reset?: () => void;
readonly store?: {
readonly subscribe: (
observer: () => void,
) => (() => void) | { readonly unsubscribe: () => void };
};
}Members
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
name | string | Yes | The name member uses the string contract. | — |
state | { readonly value: T; readonly meta: { readonly errors: readonly unknown[]; readonly isTouched: boolean; readonly isDirty: boolean; readonly isValidating: boolean; }; } | Yes | The state member uses the { readonly value: T; readonly meta: { readonly errors: readonly unknown[]; readonly isTouched: boolean; readonly isDirty: boolean; readonly isValidating: boolean; }; } contract. | — |
handleChange | (value: T) => void | Yes | The handleChange member uses the (value: T) => void contract. | — |
handleBlur | () => void | Yes | The handleBlur member uses the () => void contract. | — |
validate | ((cause: "change" | "blur" | "submit") => unknown | Promise<unknown>) | undefined | No | The validate member uses the ((cause: "change" | "blur" | "submit") => unknown | Promise<unknown>) | undefined contract. | — |
reset | (() => void) | undefined | No | The reset member uses the (() => void) | undefined contract. | — |
store | { readonly subscribe: (observer: () => void) => (() => void) | { readonly unsubscribe: () => void; }; } | undefined | No | The store member uses the { readonly subscribe: (observer: () => void) => (() => void) | { readonly unsubscribe: () => void; }; } | undefined contract. | — |
Parameters
This declaration has no public members.
Returns
This declaration does not return a value.
Throws
No thrown errors are documented for this declaration.
Related types
No package-local related types.
Source
View the secondary source reference