@shopify/polaris
Version:
Shopify’s admin product component library
33 lines • 1.49 kB
TypeScript
import React from 'react';
declare type Enctype = 'application/x-www-form-urlencoded' | 'multipart/form-data' | 'text/plain';
declare type Method = 'post' | 'get' | 'action';
declare type Target = '_blank' | '_self' | '_parent' | '_top' | string;
export interface FormProps {
/** Space separated list of character encodings */
acceptCharset?: string;
/** Where to send form-data on submittal */
action?: string;
/** Grants the browser the ability to autocomplete input elements */
autoComplete?: boolean;
/** The content to display inside the form. */
children?: React.ReactNode;
/** Media type when submitting content to server */
encType?: Enctype;
/** Toggles if form submits on Enter keypress. Defaults to true. */
implicitSubmit?: boolean;
/** Method used to submit form */
method?: Method;
/** A unique name for the form */
name?: string;
/** Whether or not form is validated when submitting */
noValidate?: boolean;
/** Blocks the default form action */
preventDefault?: boolean;
/** Where to display response after form submittal */
target?: Target;
/** Callback when form is submitted */
onSubmit(event: React.FormEvent<HTMLFormElement>): void;
}
export declare function Form({ acceptCharset, action, autoComplete, children, encType, implicitSubmit, method, name, noValidate, preventDefault, target, onSubmit, }: FormProps): JSX.Element;
export {};
//# sourceMappingURL=Form.d.ts.map