FormProps

import type { FormProps } from "@shadow-js/dusk/client";

interface FormProps {
  /** A URL (a GET to it navigates; a POST goes to it as a plain request) or a server function (a POST to its endpoint). */
  readonly action?: string | FormTarget;
  /** `"get"` or `"post"`. Default: `"post"` for a server function, `"get"` for a URL. */
  readonly method?: "get" | "post";
  /** Replace the history entry of a GET navigation. Default `false`. */
  readonly replace?: boolean;
  /** Do not intercept the submit: the browser submits the form itself. Default `false`. */
  readonly reloadDocument?: boolean;
  /** `false` leaves a GET to the browser (no client navigation). Default `true`. */
  readonly navigate?: boolean;
  /** After a GET navigation: `"reset"` (the router scrolls to the top, the default) or `"keep"` the scroll position. */
  readonly scroll?: "reset" | "keep";
  /** After a successful server function call, refresh the loader data of the page. Default `true`. */
  readonly revalidate?: boolean;
  /** Reset the fields after a success (not after a failure). Default `false`. */
  readonly resetOnSuccess?: boolean;
  /** Move focus to the first field with a problem (or to `[data-dusk-form-errors]`) after a failure. Default `true`. */
  readonly focusOnError?: boolean;
  /** Called with the result of a successful call (a `fail()` result included), before the form is reset. */
  readonly onResult?: (result: unknown, form: HTMLFormElement) => void;
  /** Called with the error of a failed call. */
  readonly onError?: (error: unknown, form: HTMLFormElement) => void;
  /** Called before the submit is intercepted; `preventDefault()` leaves the submit to the browser. */
  readonly onSubmit?: (event: Event) => void;
  readonly children?: unknown;
  readonly [attribute: string]: unknown;
}