FormField
The Form field type used in Statamic.
Type Definition
Form selector.
type FormField<
T extends string = string,
F extends Record<string, any> = Record<string, any>,
> = (ObjectValue<FormReference<T>> & F) | null;
Single form handle
type ContactForm = FormField<"contact">;
// Result: {
// handle: "contact";
// title: string;
// api_url: string;
// } | null
Multiple form handles
type AllowedForms = FormField<"contact" | "newsletter">;
// Result: {
// handle: "contact" | "newsletter";
// title: string;
// api_url: string;
// } | null
Extended form properties
type NewsletterForm = FormField<"newsletter", { email: string }>;
// Result: {
// handle: "newsletter";
// title: string;
// api_url: string;
// email: string;
// } | null