@kform/react
Version:
React integration for KForm.
22 lines (21 loc) • 1.01 kB
TypeScript
import { Schema, SchemaKt } from "@kform/core";
import * as React from "react";
import { FormOptions } from "../hooks/useForm";
/**
* Properties of the {@link Form} component.
*/
export type FormProps<T = unknown, TSubmitResult = unknown> = FormOptions<T, TSubmitResult> & FormOwnProps<T> & React.ComponentPropsWithoutRef<"form">;
/**
* Own properties of the {@link Form} component.
*/
export interface FormOwnProps<T = unknown> {
/**
* Schema of the form.
*/
schema: Schema<T> | SchemaKt;
}
/**
* Component exposing a form managed by a [form manager]{@link FormManager},
* initialised with the provided schema.
*/
export declare const Form: React.ForwardRefExoticComponent<Omit<import("..").ControllerOptions<unknown, import("..").FormControllerState<unknown>>, "formManager"> & import("..").FormOwnOptions<unknown, unknown> & FormOwnProps<unknown> & Omit<React.DetailedHTMLProps<React.FormHTMLAttributes<HTMLFormElement>, HTMLFormElement>, "ref"> & React.RefAttributes<HTMLFormElement>>;