Form props available to navigations

interface FormProps {
    about?: string;
    acceptCharset?: string;
    accessKey?: string;
    action?: string;
    aria-activedescendant?: string;
    aria-atomic?: Booleanish;
    aria-autocomplete?:
        | "none"
        | "list"
        | "inline"
        | "both";
    aria-braillelabel?: string;
    aria-brailleroledescription?: string;
    aria-busy?: Booleanish;
    aria-checked?:
        | boolean
        | "true"
        | "false"
        | "mixed";
    aria-colcount?: number;
    aria-colindex?: number;
    aria-colindextext?: string;
    aria-colspan?: number;
    aria-controls?: string;
    aria-current?:
        | boolean
        | "time"
        | "true"
        | "location"
        | "page"
        | "step"
        | "false"
        | "date";
    aria-describedby?: string;
    aria-description?: string;
    aria-details?: string;
    aria-disabled?: Booleanish;
    aria-dropeffect?:
        | "link"
        | "copy"
        | "none"
        | "execute"
        | "move"
        | "popup";
    aria-errormessage?: string;
    aria-expanded?: Booleanish;
    aria-flowto?: string;
    aria-grabbed?: Booleanish;
    aria-haspopup?:
        | boolean
        | "dialog"
        | "menu"
        | "true"
        | "false"
        | "grid"
        | "listbox"
        | "tree";
    aria-hidden?: Booleanish;
    aria-invalid?:
        | boolean
        | "true"
        | "false"
        | "grammar"
        | "spelling";
    aria-keyshortcuts?: string;
    aria-label?: string;
    aria-labelledby?: string;
    aria-level?: number;
    aria-live?: "off" | "assertive" | "polite";
    aria-modal?: Booleanish;
    aria-multiline?: Booleanish;
    aria-multiselectable?: Booleanish;
    aria-orientation?: "horizontal" | "vertical";
    aria-owns?: string;
    aria-placeholder?: string;
    aria-posinset?: number;
    aria-pressed?:
        | boolean
        | "true"
        | "false"
        | "mixed";
    aria-readonly?: Booleanish;
    aria-relevant?:
        | "text"
        | "additions"
        | "additions removals"
        | "additions text"
        | "all"
        | "removals"
        | "removals additions"
        | "removals text"
        | "text additions"
        | "text removals";
    aria-required?: Booleanish;
    aria-roledescription?: string;
    aria-rowcount?: number;
    aria-rowindex?: number;
    aria-rowindextext?: string;
    aria-rowspan?: number;
    aria-selected?: Booleanish;
    aria-setsize?: number;
    aria-sort?:
        | "none"
        | "ascending"
        | "descending"
        | "other";
    aria-valuemax?: number;
    aria-valuemin?: number;
    aria-valuenow?: number;
    aria-valuetext?: string;
    autoCapitalize?: string;
    autoComplete?: string;
    autoCorrect?: string;
    autoFocus?: boolean;
    autoSave?: string;
    children?: ReactNode;
    className?: string;
    color?: string;
    content?: string;
    contentEditable?: Booleanish | "inherit";
    contextMenu?: string;
    dangerouslySetInnerHTML?: {
        __html: string | TrustedHTML;
    };
    datatype?: string;
    defaultChecked?: boolean;
    defaultValue?: string | number | readonly string[];
    dir?: string;
    discover?: DiscoverBehavior;
    draggable?: Booleanish;
    encType?: "application/x-www-form-urlencoded" | "multipart/form-data" | "text/plain";
    fetcherKey?: string;
    hidden?: boolean;
    id?: string;
    inlist?: any;
    inputMode?:
        | "search"
        | "text"
        | "url"
        | "none"
        | "tel"
        | "email"
        | "numeric"
        | "decimal";
    is?: string;
    itemID?: string;
    itemProp?: string;
    itemRef?: string;
    itemScope?: boolean;
    itemType?: string;
    lang?: string;
    method?: HTMLFormMethod;
    name?: string;
    navigate?: boolean;
    nonce?: string;
    noValidate?: boolean;
    onAbort?: ReactEventHandler<HTMLFormElement>;
    onAbortCapture?: ReactEventHandler<HTMLFormElement>;
    onAnimationEnd?: AnimationEventHandler<HTMLFormElement>;
    onAnimationEndCapture?: AnimationEventHandler<HTMLFormElement>;
    onAnimationIteration?: AnimationEventHandler<HTMLFormElement>;
    onAnimationIterationCapture?: AnimationEventHandler<HTMLFormElement>;
    onAnimationStart?: AnimationEventHandler<HTMLFormElement>;
    onAnimationStartCapture?: AnimationEventHandler<HTMLFormElement>;
    onAuxClick?: MouseEventHandler<HTMLFormElement>;
    onAuxClickCapture?: MouseEventHandler<HTMLFormElement>;
    onBeforeInput?: FormEventHandler<HTMLFormElement>;
    onBeforeInputCapture?: FormEventHandler<HTMLFormElement>;
    onBlur?: FocusEventHandler<HTMLFormElement>;
    onBlurCapture?: FocusEventHandler<HTMLFormElement>;
    onCanPlay?: ReactEventHandler<HTMLFormElement>;
    onCanPlayCapture?: ReactEventHandler<HTMLFormElement>;
    onCanPlayThrough?: ReactEventHandler<HTMLFormElement>;
    onCanPlayThroughCapture?: ReactEventHandler<HTMLFormElement>;
    onChange?: FormEventHandler<HTMLFormElement>;
    onChangeCapture?: FormEventHandler<HTMLFormElement>;
    onClick?: MouseEventHandler<HTMLFormElement>;
    onClickCapture?: MouseEventHandler<HTMLFormElement>;
    onCompositionEnd?: CompositionEventHandler<HTMLFormElement>;
    onCompositionEndCapture?: CompositionEventHandler<HTMLFormElement>;
    onCompositionStart?: CompositionEventHandler<HTMLFormElement>;
    onCompositionStartCapture?: CompositionEventHandler<HTMLFormElement>;
    onCompositionUpdate?: CompositionEventHandler<HTMLFormElement>;
    onCompositionUpdateCapture?: CompositionEventHandler<HTMLFormElement>;
    onContextMenu?: MouseEventHandler<HTMLFormElement>;
    onContextMenuCapture?: MouseEventHandler<HTMLFormElement>;
    onCopy?: ClipboardEventHandler<HTMLFormElement>;
    onCopyCapture?: ClipboardEventHandler<HTMLFormElement>;
    onCut?: ClipboardEventHandler<HTMLFormElement>;
    onCutCapture?: ClipboardEventHandler<HTMLFormElement>;
    onDoubleClick?: MouseEventHandler<HTMLFormElement>;
    onDoubleClickCapture?: MouseEventHandler<HTMLFormElement>;
    onDrag?: DragEventHandler<HTMLFormElement>;
    onDragCapture?: DragEventHandler<HTMLFormElement>;
    onDragEnd?: DragEventHandler<HTMLFormElement>;
    onDragEndCapture?: DragEventHandler<HTMLFormElement>;
    onDragEnter?: DragEventHandler<HTMLFormElement>;
    onDragEnterCapture?: DragEventHandler<HTMLFormElement>;
    onDragExit?: DragEventHandler<HTMLFormElement>;
    onDragExitCapture?: DragEventHandler<HTMLFormElement>;
    onDragLeave?: DragEventHandler<HTMLFormElement>;
    onDragLeaveCapture?: DragEventHandler<HTMLFormElement>;
    onDragOver?: DragEventHandler<HTMLFormElement>;
    onDragOverCapture?: DragEventHandler<HTMLFormElement>;
    onDragStart?: DragEventHandler<HTMLFormElement>;
    onDragStartCapture?: DragEventHandler<HTMLFormElement>;
    onDrop?: DragEventHandler<HTMLFormElement>;
    onDropCapture?: DragEventHandler<HTMLFormElement>;
    onDurationChange?: ReactEventHandler<HTMLFormElement>;
    onDurationChangeCapture?: ReactEventHandler<HTMLFormElement>;
    onEmptied?: ReactEventHandler<HTMLFormElement>;
    onEmptiedCapture?: ReactEventHandler<HTMLFormElement>;
    onEncrypted?: ReactEventHandler<HTMLFormElement>;
    onEncryptedCapture?: ReactEventHandler<HTMLFormElement>;
    onEnded?: ReactEventHandler<HTMLFormElement>;
    onEndedCapture?: ReactEventHandler<HTMLFormElement>;
    onError?: ReactEventHandler<HTMLFormElement>;
    onErrorCapture?: ReactEventHandler<HTMLFormElement>;
    onFocus?: FocusEventHandler<HTMLFormElement>;
    onFocusCapture?: FocusEventHandler<HTMLFormElement>;
    onGotPointerCapture?: PointerEventHandler<HTMLFormElement>;
    onGotPointerCaptureCapture?: PointerEventHandler<HTMLFormElement>;
    onInput?: FormEventHandler<HTMLFormElement>;
    onInputCapture?: FormEventHandler<HTMLFormElement>;
    onInvalid?: FormEventHandler<HTMLFormElement>;
    onInvalidCapture?: FormEventHandler<HTMLFormElement>;
    onKeyDown?: KeyboardEventHandler<HTMLFormElement>;
    onKeyDownCapture?: KeyboardEventHandler<HTMLFormElement>;
    onKeyPress?: KeyboardEventHandler<HTMLFormElement>;
    onKeyPressCapture?: KeyboardEventHandler<HTMLFormElement>;
    onKeyUp?: KeyboardEventHandler<HTMLFormElement>;
    onKeyUpCapture?: KeyboardEventHandler<HTMLFormElement>;
    onLoad?: ReactEventHandler<HTMLFormElement>;
    onLoadCapture?: ReactEventHandler<HTMLFormElement>;
    onLoadedData?: ReactEventHandler<HTMLFormElement>;
    onLoadedDataCapture?: ReactEventHandler<HTMLFormElement>;
    onLoadedMetadata?: ReactEventHandler<HTMLFormElement>;
    onLoadedMetadataCapture?: ReactEventHandler<HTMLFormElement>;
    onLoadStart?: ReactEventHandler<HTMLFormElement>;
    onLoadStartCapture?: ReactEventHandler<HTMLFormElement>;
    onLostPointerCapture?: PointerEventHandler<HTMLFormElement>;
    onLostPointerCaptureCapture?: PointerEventHandler<HTMLFormElement>;
    onMouseDown?: MouseEventHandler<HTMLFormElement>;
    onMouseDownCapture?: MouseEventHandler<HTMLFormElement>;
    onMouseEnter?: MouseEventHandler<HTMLFormElement>;
    onMouseLeave?: MouseEventHandler<HTMLFormElement>;
    onMouseMove?: MouseEventHandler<HTMLFormElement>;
    onMouseMoveCapture?: MouseEventHandler<HTMLFormElement>;
    onMouseOut?: MouseEventHandler<HTMLFormElement>;
    onMouseOutCapture?: MouseEventHandler<HTMLFormElement>;
    onMouseOver?: MouseEventHandler<HTMLFormElement>;
    onMouseOverCapture?: MouseEventHandler<HTMLFormElement>;
    onMouseUp?: MouseEventHandler<HTMLFormElement>;
    onMouseUpCapture?: MouseEventHandler<HTMLFormElement>;
    onPaste?: ClipboardEventHandler<HTMLFormElement>;
    onPasteCapture?: ClipboardEventHandler<HTMLFormElement>;
    onPause?: ReactEventHandler<HTMLFormElement>;
    onPauseCapture?: ReactEventHandler<HTMLFormElement>;
    onPlay?: ReactEventHandler<HTMLFormElement>;
    onPlayCapture?: ReactEventHandler<HTMLFormElement>;
    onPlaying?: ReactEventHandler<HTMLFormElement>;
    onPlayingCapture?: ReactEventHandler<HTMLFormElement>;
    onPointerCancel?: PointerEventHandler<HTMLFormElement>;
    onPointerCancelCapture?: PointerEventHandler<HTMLFormElement>;
    onPointerDown?: PointerEventHandler<HTMLFormElement>;
    onPointerDownCapture?: PointerEventHandler<HTMLFormElement>;
    onPointerEnter?: PointerEventHandler<HTMLFormElement>;
    onPointerEnterCapture?: PointerEventHandler<HTMLFormElement>;
    onPointerLeave?: PointerEventHandler<HTMLFormElement>;
    onPointerLeaveCapture?: PointerEventHandler<HTMLFormElement>;
    onPointerMove?: PointerEventHandler<HTMLFormElement>;
    onPointerMoveCapture?: PointerEventHandler<HTMLFormElement>;
    onPointerOut?: PointerEventHandler<HTMLFormElement>;
    onPointerOutCapture?: PointerEventHandler<HTMLFormElement>;
    onPointerOver?: PointerEventHandler<HTMLFormElement>;
    onPointerOverCapture?: PointerEventHandler<HTMLFormElement>;
    onPointerUp?: PointerEventHandler<HTMLFormElement>;
    onPointerUpCapture?: PointerEventHandler<HTMLFormElement>;
    onProgress?: ReactEventHandler<HTMLFormElement>;
    onProgressCapture?: ReactEventHandler<HTMLFormElement>;
    onRateChange?: ReactEventHandler<HTMLFormElement>;
    onRateChangeCapture?: ReactEventHandler<HTMLFormElement>;
    onReset?: FormEventHandler<HTMLFormElement>;
    onResetCapture?: FormEventHandler<HTMLFormElement>;
    onResize?: ReactEventHandler<HTMLFormElement>;
    onResizeCapture?: ReactEventHandler<HTMLFormElement>;
    onScroll?: UIEventHandler<HTMLFormElement>;
    onScrollCapture?: UIEventHandler<HTMLFormElement>;
    onSeeked?: ReactEventHandler<HTMLFormElement>;
    onSeekedCapture?: ReactEventHandler<HTMLFormElement>;
    onSeeking?: ReactEventHandler<HTMLFormElement>;
    onSeekingCapture?: ReactEventHandler<HTMLFormElement>;
    onSelect?: ReactEventHandler<HTMLFormElement>;
    onSelectCapture?: ReactEventHandler<HTMLFormElement>;
    onStalled?: ReactEventHandler<HTMLFormElement>;
    onStalledCapture?: ReactEventHandler<HTMLFormElement>;
    onSubmit?: FormEventHandler<HTMLFormElement>;
    onSubmitCapture?: FormEventHandler<HTMLFormElement>;
    onSuspend?: ReactEventHandler<HTMLFormElement>;
    onSuspendCapture?: ReactEventHandler<HTMLFormElement>;
    onTimeUpdate?: ReactEventHandler<HTMLFormElement>;
    onTimeUpdateCapture?: ReactEventHandler<HTMLFormElement>;
    onTouchCancel?: TouchEventHandler<HTMLFormElement>;
    onTouchCancelCapture?: TouchEventHandler<HTMLFormElement>;
    onTouchEnd?: TouchEventHandler<HTMLFormElement>;
    onTouchEndCapture?: TouchEventHandler<HTMLFormElement>;
    onTouchMove?: TouchEventHandler<HTMLFormElement>;
    onTouchMoveCapture?: TouchEventHandler<HTMLFormElement>;
    onTouchStart?: TouchEventHandler<HTMLFormElement>;
    onTouchStartCapture?: TouchEventHandler<HTMLFormElement>;
    onTransitionEnd?: TransitionEventHandler<HTMLFormElement>;
    onTransitionEndCapture?: TransitionEventHandler<HTMLFormElement>;
    onVolumeChange?: ReactEventHandler<HTMLFormElement>;
    onVolumeChangeCapture?: ReactEventHandler<HTMLFormElement>;
    onWaiting?: ReactEventHandler<HTMLFormElement>;
    onWaitingCapture?: ReactEventHandler<HTMLFormElement>;
    onWheel?: WheelEventHandler<HTMLFormElement>;
    onWheelCapture?: WheelEventHandler<HTMLFormElement>;
    placeholder?: string;
    prefix?: string;
    preventScrollReset?: boolean;
    property?: string;
    radioGroup?: string;
    rel?: string;
    relative?: RelativeRoutingType;
    reloadDocument?: boolean;
    replace?: boolean;
    resource?: string;
    results?: number;
    rev?: string;
    role?: AriaRole;
    security?: string;
    slot?: string;
    spellCheck?: Booleanish;
    state?: any;
    style?: CSSProperties;
    suppressContentEditableWarning?: boolean;
    suppressHydrationWarning?: boolean;
    tabIndex?: number;
    target?: string;
    title?: string;
    translate?: "yes" | "no";
    typeof?: string;
    unselectable?: "on" | "off";
    viewTransition?: boolean;
    vocab?: string;
}

Hierarchy

  • SharedFormProps
    • FormProps

Properties

about? acceptCharset? accessKey? action? aria-activedescendant? aria-atomic? aria-autocomplete? aria-braillelabel? aria-brailleroledescription? aria-busy? aria-checked? aria-colcount? aria-colindex? aria-colindextext? aria-colspan? aria-controls? aria-current? aria-describedby? aria-description? aria-details? aria-disabled? aria-dropeffect? aria-errormessage? aria-expanded? aria-flowto? aria-grabbed? aria-haspopup? aria-hidden? aria-invalid? aria-keyshortcuts? aria-label? aria-labelledby? aria-level? aria-live? aria-modal? aria-multiline? aria-multiselectable? aria-orientation? aria-owns? aria-placeholder? aria-posinset? aria-pressed? aria-readonly? aria-relevant? aria-required? aria-roledescription? aria-rowcount? aria-rowindex? aria-rowindextext? aria-rowspan? aria-selected? aria-setsize? aria-sort? aria-valuemax? aria-valuemin? aria-valuenow? aria-valuetext? autoCapitalize? autoComplete? autoCorrect? autoFocus? autoSave? children? className? color? content? contentEditable? contextMenu? dangerouslySetInnerHTML? datatype? defaultChecked? defaultValue? dir? discover? draggable? encType? fetcherKey? hidden? id? inlist? inputMode? is? itemID? itemProp? itemRef? itemScope? itemType? lang? method? name? navigate? nonce? noValidate? onAbort? onAbortCapture? onAnimationEnd? onAnimationEndCapture? onAnimationIteration? onAnimationIterationCapture? onAnimationStart? onAnimationStartCapture? onAuxClick? onAuxClickCapture? onBeforeInput? onBeforeInputCapture? onBlur? onBlurCapture? onCanPlay? onCanPlayCapture? onCanPlayThrough? onCanPlayThroughCapture? onChange? onChangeCapture? onClick? onClickCapture? onCompositionEnd? onCompositionEndCapture? onCompositionStart? onCompositionStartCapture? onCompositionUpdate? onCompositionUpdateCapture? onContextMenu? onContextMenuCapture? onCopy? onCopyCapture? onCut? onCutCapture? onDoubleClick? onDoubleClickCapture? onDrag? onDragCapture? onDragEnd? onDragEndCapture? onDragEnter? onDragEnterCapture? onDragExit? onDragExitCapture? onDragLeave? onDragLeaveCapture? onDragOver? onDragOverCapture? onDragStart? onDragStartCapture? onDrop? onDropCapture? onDurationChange? onDurationChangeCapture? onEmptied? onEmptiedCapture? onEncrypted? onEncryptedCapture? onEnded? onEndedCapture? onError? onErrorCapture? onFocus? onFocusCapture? onGotPointerCapture? onGotPointerCaptureCapture? onInput? onInputCapture? onInvalid? onInvalidCapture? onKeyDown? onKeyDownCapture? onKeyPress? onKeyPressCapture? onKeyUp? onKeyUpCapture? onLoad? onLoadCapture? onLoadedData? onLoadedDataCapture? onLoadedMetadata? onLoadedMetadataCapture? onLoadStart? onLoadStartCapture? onLostPointerCapture? onLostPointerCaptureCapture? onMouseDown? onMouseDownCapture? onMouseEnter? onMouseLeave? onMouseMove? onMouseMoveCapture? onMouseOut? onMouseOutCapture? onMouseOver? onMouseOverCapture? onMouseUp? onMouseUpCapture? onPaste? onPasteCapture? onPause? onPauseCapture? onPlay? onPlayCapture? onPlaying? onPlayingCapture? onPointerCancel? onPointerCancelCapture? onPointerDown? onPointerDownCapture? onPointerEnter? onPointerEnterCapture? onPointerLeave? onPointerLeaveCapture? onPointerMove? onPointerMoveCapture? onPointerOut? onPointerOutCapture? onPointerOver? onPointerOverCapture? onPointerUp? onPointerUpCapture? onProgress? onProgressCapture? onRateChange? onRateChangeCapture? onReset? onResetCapture? onResize? onResizeCapture? onScroll? onScrollCapture? onSeeked? onSeekedCapture? onSeeking? onSeekingCapture? onSelect? onSelectCapture? onStalled? onStalledCapture? onSubmit? onSubmitCapture? onSuspend? onSuspendCapture? onTimeUpdate? onTimeUpdateCapture? onTouchCancel? onTouchCancelCapture? onTouchEnd? onTouchEndCapture? onTouchMove? onTouchMoveCapture? onTouchStart? onTouchStartCapture? onTransitionEnd? onTransitionEndCapture? onVolumeChange? onVolumeChangeCapture? onWaiting? onWaitingCapture? onWheel? onWheelCapture? placeholder? prefix? preventScrollReset? property? radioGroup? rel? relative? reloadDocument? replace? resource? results? rev? role? security? slot? spellCheck? state? style? suppressContentEditableWarning? suppressHydrationWarning? tabIndex? target? title? translate? typeof? unselectable? viewTransition? vocab?

Properties

about?: string
acceptCharset?: string
accessKey?: string
action?: string

The URL to submit the form data to. If undefined, this defaults to the closest route in context.

aria-activedescendant?: string

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

aria-atomic?: Booleanish

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

aria-autocomplete?:
    | "none"
    | "list"
    | "inline"
    | "both"

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

aria-braillelabel?: string

Defines a string value that labels the current element, which is intended to be converted into Braille.

aria-label.

aria-brailleroledescription?: string

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

aria-roledescription.

aria-busy?: Booleanish
aria-checked?:
    | boolean
    | "true"
    | "false"
    | "mixed"

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

  • aria-pressed
  • aria-selected.
aria-colcount?: number

Defines the total number of columns in a table, grid, or treegrid.

aria-colindex.

aria-colindex?: number

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

  • aria-colcount
  • aria-colspan.
aria-colindextext?: string

Defines a human readable text alternative of aria-colindex.

aria-rowindextext.

aria-colspan?: number

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

  • aria-colindex
  • aria-rowspan.
aria-controls?: string

Identifies the element (or elements) whose contents or presence are controlled by the current element.

aria-owns.

aria-current?:
    | boolean
    | "time"
    | "true"
    | "location"
    | "page"
    | "step"
    | "false"
    | "date"

Indicates the element that represents the current item within a container or set of related elements.

aria-describedby?: string

Identifies the element (or elements) that describes the object.

aria-labelledby

aria-description?: string

Defines a string value that describes or annotates the current element.

related aria-describedby.

aria-details?: string

Identifies the element that provides a detailed, extended description for the object.

aria-describedby.

aria-disabled?: Booleanish

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

  • aria-hidden
  • aria-readonly.
aria-dropeffect?:
    | "link"
    | "copy"
    | "none"
    | "execute"
    | "move"
    | "popup"

Indicates what functions can be performed when a dragged object is released on the drop target.

in ARIA 1.1

aria-errormessage?: string

Identifies the element that provides an error message for the object.

  • aria-invalid
  • aria-describedby.
aria-expanded?: Booleanish

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

aria-flowto?: string

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

aria-grabbed?: Booleanish

Indicates an element's "grabbed" state in a drag-and-drop operation.

in ARIA 1.1

aria-haspopup?:
    | boolean
    | "dialog"
    | "menu"
    | "true"
    | "false"
    | "grid"
    | "listbox"
    | "tree"

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

aria-hidden?: Booleanish

Indicates whether the element is exposed to an accessibility API.

aria-disabled.

aria-invalid?:
    | boolean
    | "true"
    | "false"
    | "grammar"
    | "spelling"

Indicates the entered value does not conform to the format expected by the application.

aria-errormessage.

aria-keyshortcuts?: string

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

aria-label?: string

Defines a string value that labels the current element.

aria-labelledby.

aria-labelledby?: string

Identifies the element (or elements) that labels the current element.

aria-describedby.

aria-level?: number

Defines the hierarchical level of an element within a structure.

aria-live?: "off" | "assertive" | "polite"

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

aria-modal?: Booleanish

Indicates whether an element is modal when displayed.

aria-multiline?: Booleanish

Indicates whether a text box accepts multiple lines of input or only a single line.

aria-multiselectable?: Booleanish

Indicates that the user may select more than one item from the current selectable descendants.

aria-orientation?: "horizontal" | "vertical"

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

aria-owns?: string

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

aria-controls.

aria-placeholder?: string

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

aria-posinset?: number

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

aria-setsize.

aria-pressed?:
    | boolean
    | "true"
    | "false"
    | "mixed"

Indicates the current "pressed" state of toggle buttons.

  • aria-checked
  • aria-selected.
aria-readonly?: Booleanish

Indicates that the element is not editable, but is otherwise operable.

aria-disabled.

aria-relevant?:
    | "text"
    | "additions"
    | "additions removals"
    | "additions text"
    | "all"
    | "removals"
    | "removals additions"
    | "removals text"
    | "text additions"
    | "text removals"

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

aria-atomic.

aria-required?: Booleanish

Indicates that user input is required on the element before a form may be submitted.

aria-roledescription?: string

Defines a human-readable, author-localized description for the role of an element.

aria-rowcount?: number

Defines the total number of rows in a table, grid, or treegrid.

aria-rowindex.

aria-rowindex?: number

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

  • aria-rowcount
  • aria-rowspan.
aria-rowindextext?: string

Defines a human readable text alternative of aria-rowindex.

aria-colindextext.

aria-rowspan?: number

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

  • aria-rowindex
  • aria-colspan.
aria-selected?: Booleanish

Indicates the current "selected" state of various widgets.

  • aria-checked
  • aria-pressed.
aria-setsize?: number

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

aria-posinset.

aria-sort?:
    | "none"
    | "ascending"
    | "descending"
    | "other"

Indicates if items in a table or grid are sorted in ascending or descending order.

aria-valuemax?: number

Defines the maximum allowed value for a range widget.

aria-valuemin?: number

Defines the minimum allowed value for a range widget.

aria-valuenow?: number

Defines the current value for a range widget.

aria-valuetext.

aria-valuetext?: string

Defines the human readable text alternative of aria-valuenow for a range widget.

autoCapitalize?: string
autoComplete?: string
autoCorrect?: string
autoFocus?: boolean
autoSave?: string
children?: ReactNode
className?: string
color?: string
content?: string
contentEditable?: Booleanish | "inherit"
contextMenu?: string
dangerouslySetInnerHTML?: {
    __html: string | TrustedHTML;
}
datatype?: string
defaultChecked?: boolean
defaultValue?: string | number | readonly string[]
dir?: string
discover?: DiscoverBehavior
draggable?: Booleanish
encType?: "application/x-www-form-urlencoded" | "multipart/form-data" | "text/plain"

The encoding type to use for the form submission.

fetcherKey?: string

Indicates a specific fetcherKey to use when using navigate={false} so you can pick up the fetcher's state in a different component in a useFetcher.

hidden?: boolean
id?: string
inlist?: any
inputMode?:
    | "search"
    | "text"
    | "url"
    | "none"
    | "tel"
    | "email"
    | "numeric"
    | "decimal"

Hints at the type of data that might be entered by the user while editing the element or its contents

is?: string

Specify that a standard HTML element should behave like a defined custom built-in element

itemID?: string
itemProp?: string
itemRef?: string
itemScope?: boolean
itemType?: string
lang?: string

The HTTP verb to use when the form is submitted. Supports "get", "post", "put", "delete", and "patch".

Native <form> only supports get and post, avoid the other verbs if you'd like to support progressive enhancement

name?: string
navigate?: boolean

Skips the navigation and uses a fetcher internally when false. This is essentially a shorthand for useFetcher() + <fetcher.Form> where you don't care about the resulting data in this component.

nonce?: string
noValidate?: boolean
onAbort?: ReactEventHandler<HTMLFormElement>
onAbortCapture?: ReactEventHandler<HTMLFormElement>
onAnimationEnd?: AnimationEventHandler<HTMLFormElement>
onAnimationEndCapture?: AnimationEventHandler<HTMLFormElement>
onAnimationIteration?: AnimationEventHandler<HTMLFormElement>
onAnimationIterationCapture?: AnimationEventHandler<HTMLFormElement>
onAnimationStart?: AnimationEventHandler<HTMLFormElement>
onAnimationStartCapture?: AnimationEventHandler<HTMLFormElement>
onAuxClick?: MouseEventHandler<HTMLFormElement>
onAuxClickCapture?: MouseEventHandler<HTMLFormElement>
onBeforeInput?: FormEventHandler<HTMLFormElement>
onBeforeInputCapture?: FormEventHandler<HTMLFormElement>
onBlur?: FocusEventHandler<HTMLFormElement>
onBlurCapture?: FocusEventHandler<HTMLFormElement>
onCanPlay?: ReactEventHandler<HTMLFormElement>
onCanPlayCapture?: ReactEventHandler<HTMLFormElement>
onCanPlayThrough?: ReactEventHandler<HTMLFormElement>
onCanPlayThroughCapture?: ReactEventHandler<HTMLFormElement>
onChange?: FormEventHandler<HTMLFormElement>
onChangeCapture?: FormEventHandler<HTMLFormElement>
onClick?: MouseEventHandler<HTMLFormElement>
onClickCapture?: MouseEventHandler<HTMLFormElement>
onCompositionEnd?: CompositionEventHandler<HTMLFormElement>
onCompositionEndCapture?: CompositionEventHandler<HTMLFormElement>
onCompositionStart?: CompositionEventHandler<HTMLFormElement>
onCompositionStartCapture?: CompositionEventHandler<HTMLFormElement>
onCompositionUpdate?: CompositionEventHandler<HTMLFormElement>
onCompositionUpdateCapture?: CompositionEventHandler<HTMLFormElement>
onContextMenu?: MouseEventHandler<HTMLFormElement>
onContextMenuCapture?: MouseEventHandler<HTMLFormElement>
onCopy?: ClipboardEventHandler<HTMLFormElement>
onCopyCapture?: ClipboardEventHandler<HTMLFormElement>
onCut?: ClipboardEventHandler<HTMLFormElement>
onCutCapture?: ClipboardEventHandler<HTMLFormElement>
onDoubleClick?: MouseEventHandler<HTMLFormElement>
onDoubleClickCapture?: MouseEventHandler<HTMLFormElement>
onDrag?: DragEventHandler<HTMLFormElement>
onDragCapture?: DragEventHandler<HTMLFormElement>
onDragEnd?: DragEventHandler<HTMLFormElement>
onDragEndCapture?: DragEventHandler<HTMLFormElement>
onDragEnter?: DragEventHandler<HTMLFormElement>
onDragEnterCapture?: DragEventHandler<HTMLFormElement>
onDragExit?: DragEventHandler<HTMLFormElement>
onDragExitCapture?: DragEventHandler<HTMLFormElement>
onDragLeave?: DragEventHandler<HTMLFormElement>
onDragLeaveCapture?: DragEventHandler<HTMLFormElement>
onDragOver?: DragEventHandler<HTMLFormElement>
onDragOverCapture?: DragEventHandler<HTMLFormElement>
onDragStart?: DragEventHandler<HTMLFormElement>
onDragStartCapture?: DragEventHandler<HTMLFormElement>
onDrop?: DragEventHandler<HTMLFormElement>
onDropCapture?: DragEventHandler<HTMLFormElement>
onDurationChange?: ReactEventHandler<HTMLFormElement>
onDurationChangeCapture?: ReactEventHandler<HTMLFormElement>
onEmptied?: ReactEventHandler<HTMLFormElement>
onEmptiedCapture?: ReactEventHandler<HTMLFormElement>
onEncrypted?: ReactEventHandler<HTMLFormElement>
onEncryptedCapture?: ReactEventHandler<HTMLFormElement>
onEnded?: ReactEventHandler<HTMLFormElement>
onEndedCapture?: ReactEventHandler<HTMLFormElement>
onError?: ReactEventHandler<HTMLFormElement>
onErrorCapture?: ReactEventHandler<HTMLFormElement>
onFocus?: FocusEventHandler<HTMLFormElement>
onFocusCapture?: FocusEventHandler<HTMLFormElement>
onGotPointerCapture?: PointerEventHandler<HTMLFormElement>
onGotPointerCaptureCapture?: PointerEventHandler<HTMLFormElement>
onInput?: FormEventHandler<HTMLFormElement>
onInputCapture?: FormEventHandler<HTMLFormElement>
onInvalid?: FormEventHandler<HTMLFormElement>
onInvalidCapture?: FormEventHandler<HTMLFormElement>
onKeyDown?: KeyboardEventHandler<HTMLFormElement>
onKeyDownCapture?: KeyboardEventHandler<HTMLFormElement>
onKeyPress?: KeyboardEventHandler<HTMLFormElement>
onKeyPressCapture?: KeyboardEventHandler<HTMLFormElement>
onKeyUp?: KeyboardEventHandler<HTMLFormElement>
onKeyUpCapture?: KeyboardEventHandler<HTMLFormElement>
onLoad?: ReactEventHandler<HTMLFormElement>
onLoadCapture?: ReactEventHandler<HTMLFormElement>
onLoadedData?: ReactEventHandler<HTMLFormElement>
onLoadedDataCapture?: ReactEventHandler<HTMLFormElement>
onLoadedMetadata?: ReactEventHandler<HTMLFormElement>
onLoadedMetadataCapture?: ReactEventHandler<HTMLFormElement>
onLoadStart?: ReactEventHandler<HTMLFormElement>
onLoadStartCapture?: ReactEventHandler<HTMLFormElement>
onLostPointerCapture?: PointerEventHandler<HTMLFormElement>
onLostPointerCaptureCapture?: PointerEventHandler<HTMLFormElement>
onMouseDown?: MouseEventHandler<HTMLFormElement>
onMouseDownCapture?: MouseEventHandler<HTMLFormElement>
onMouseEnter?: MouseEventHandler<HTMLFormElement>
onMouseLeave?: MouseEventHandler<HTMLFormElement>
onMouseMove?: MouseEventHandler<HTMLFormElement>
onMouseMoveCapture?: MouseEventHandler<HTMLFormElement>
onMouseOut?: MouseEventHandler<HTMLFormElement>
onMouseOutCapture?: MouseEventHandler<HTMLFormElement>
onMouseOver?: MouseEventHandler<HTMLFormElement>
onMouseOverCapture?: MouseEventHandler<HTMLFormElement>
onMouseUp?: MouseEventHandler<HTMLFormElement>
onMouseUpCapture?: MouseEventHandler<HTMLFormElement>
onPaste?: ClipboardEventHandler<HTMLFormElement>
onPasteCapture?: ClipboardEventHandler<HTMLFormElement>
onPause?: ReactEventHandler<HTMLFormElement>
onPauseCapture?: ReactEventHandler<HTMLFormElement>
onPlay?: ReactEventHandler<HTMLFormElement>
onPlayCapture?: ReactEventHandler<HTMLFormElement>
onPlaying?: ReactEventHandler<HTMLFormElement>
onPlayingCapture?: ReactEventHandler<HTMLFormElement>
onPointerCancel?: PointerEventHandler<HTMLFormElement>
onPointerCancelCapture?: PointerEventHandler<HTMLFormElement>
onPointerDown?: PointerEventHandler<HTMLFormElement>
onPointerDownCapture?: PointerEventHandler<HTMLFormElement>
onPointerEnter?: PointerEventHandler<HTMLFormElement>
onPointerEnterCapture?: PointerEventHandler<HTMLFormElement>
onPointerLeave?: PointerEventHandler<HTMLFormElement>
onPointerLeaveCapture?: PointerEventHandler<HTMLFormElement>
onPointerMove?: PointerEventHandler<HTMLFormElement>
onPointerMoveCapture?: PointerEventHandler<HTMLFormElement>
onPointerOut?: PointerEventHandler<HTMLFormElement>
onPointerOutCapture?: PointerEventHandler<HTMLFormElement>
onPointerOver?: PointerEventHandler<HTMLFormElement>
onPointerOverCapture?: PointerEventHandler<HTMLFormElement>
onPointerUp?: PointerEventHandler<HTMLFormElement>
onPointerUpCapture?: PointerEventHandler<HTMLFormElement>
onProgress?: ReactEventHandler<HTMLFormElement>
onProgressCapture?: ReactEventHandler<HTMLFormElement>
onRateChange?: ReactEventHandler<HTMLFormElement>
onRateChangeCapture?: ReactEventHandler<HTMLFormElement>
onReset?: FormEventHandler<HTMLFormElement>
onResetCapture?: FormEventHandler<HTMLFormElement>
onResize?: ReactEventHandler<HTMLFormElement>
onResizeCapture?: ReactEventHandler<HTMLFormElement>
onScroll?: UIEventHandler<HTMLFormElement>
onScrollCapture?: UIEventHandler<HTMLFormElement>
onSeeked?: ReactEventHandler<HTMLFormElement>
onSeekedCapture?: ReactEventHandler<HTMLFormElement>
onSeeking?: ReactEventHandler<HTMLFormElement>
onSeekingCapture?: ReactEventHandler<HTMLFormElement>
onSelect?: ReactEventHandler<HTMLFormElement>
onSelectCapture?: ReactEventHandler<HTMLFormElement>
onStalled?: ReactEventHandler<HTMLFormElement>
onStalledCapture?: ReactEventHandler<HTMLFormElement>
onSubmit?: FormEventHandler<HTMLFormElement>

A function to call when the form is submitted. If you call event.preventDefault() then this form will not do anything.

onSubmitCapture?: FormEventHandler<HTMLFormElement>
onSuspend?: ReactEventHandler<HTMLFormElement>
onSuspendCapture?: ReactEventHandler<HTMLFormElement>
onTimeUpdate?: ReactEventHandler<HTMLFormElement>
onTimeUpdateCapture?: ReactEventHandler<HTMLFormElement>
onTouchCancel?: TouchEventHandler<HTMLFormElement>
onTouchCancelCapture?: TouchEventHandler<HTMLFormElement>
onTouchEnd?: TouchEventHandler<HTMLFormElement>
onTouchEndCapture?: TouchEventHandler<HTMLFormElement>
onTouchMove?: TouchEventHandler<HTMLFormElement>
onTouchMoveCapture?: TouchEventHandler<HTMLFormElement>
onTouchStart?: TouchEventHandler<HTMLFormElement>
onTouchStartCapture?: TouchEventHandler<HTMLFormElement>
onTransitionEnd?: TransitionEventHandler<HTMLFormElement>
onTransitionEndCapture?: TransitionEventHandler<HTMLFormElement>
onVolumeChange?: ReactEventHandler<HTMLFormElement>
onVolumeChangeCapture?: ReactEventHandler<HTMLFormElement>
onWaiting?: ReactEventHandler<HTMLFormElement>
onWaitingCapture?: ReactEventHandler<HTMLFormElement>
onWheel?: WheelEventHandler<HTMLFormElement>
onWheelCapture?: WheelEventHandler<HTMLFormElement>
placeholder?: string
prefix?: string
preventScrollReset?: boolean

Prevent the scroll position from resetting to the top of the viewport on completion of the navigation when using the component

property?: string
radioGroup?: string
rel?: string

Determines whether the form action is relative to the route hierarchy or the pathname. Use this if you want to opt out of navigating the route hierarchy and want to instead route based on /-delimited URL segments

reloadDocument?: boolean

Forces a full document navigation instead of client side routing + data fetch.

replace?: boolean

Replaces the current entry in the browser history stack when the form navigates. Use this if you don't want the user to be able to click "back" to the page with the form on it.

resource?: string
results?: number
rev?: string
role?: AriaRole
security?: string
slot?: string
spellCheck?: Booleanish
state?: any

State object to add to the history stack entry for this navigation

style?: CSSProperties
suppressContentEditableWarning?: boolean
suppressHydrationWarning?: boolean
tabIndex?: number
target?: string
title?: string
translate?: "yes" | "no"
typeof?: string
unselectable?: "on" | "off"
viewTransition?: boolean

Enables a View Transition for this navigation. To apply specific styles during the transition see useViewTransitionState.

vocab?: string