@ariakit/react-core/cjs/form/form-provider.d.ts

Ariakit React core

import type { FormStoreValues } from "@ariakit/core/form/form-store";
import type { PickRequired } from "@ariakit/core/utils/types";
import type { ReactElement, ReactNode } from "react";
import type { FormStoreProps } from "./form-store.ts";
type Values = FormStoreValues;
/**
 * Provides a form store to [Form](https://ariakit.org/components/form)
 * components.
 * @see https://ariakit.org/components/form
 * @example
 * ```jsx
 * <FormProvider defaultValues={{ email: "" }}>
 *   <Form>
 *     <FormInput />
 *   </Form>
 * </FormProvider>
 * ```
 */
export declare function FormProvider<T extends Values = Values>(props: PickRequired<FormProviderProps<T>, "values" | "defaultValues" | "errors" | "defaultErrors" | "touched" | "defaultTouched">): ReactElement;
export declare function FormProvider(props: FormProviderProps): ReactElement;
export interface FormProviderProps<T extends Values = Values> extends FormStoreProps<T> {
    children?: ReactNode;
}
export {};