React Router API Reference
    Preparing search index...

    Interface FetcherSubmitOptions

    Submit options available to fetchers

    interface FetcherSubmitOptions {
        action?: string;
        encType?: FormEncType;
        flushSync?: boolean;
        method?: HTMLFormMethod;
        preventScrollReset?: boolean;
        relative?: RelativeRoutingType;
        unstable_defaultShouldRevalidate?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    action?: string

    The action URL path used to submit the form. Overrides <form action>. Defaults to the path of the current route.

    encType?: FormEncType

    The encoding used to submit the form. Overrides <form encType>. Defaults to "application/x-www-form-urlencoded".

    flushSync?: boolean

    Enable flushSync for this submission's state updates

    The HTTP method used to submit the form. Overrides <form method>. Defaults to "GET".

    preventScrollReset?: boolean

    In browser-based environments, prevent resetting scroll after this navigation when using the component

    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

    unstable_defaultShouldRevalidate?: boolean

    Specify the default revalidation behavior after this submission

    If no shouldRevalidate functions are present on the active routes, then this value will be used directly. Otherwise it will be passed into shouldRevalidate so the route can make the final determination on revalidation. This can be useful when updating search params and you don't want to trigger a revalidation.

    By default (when not specified), loaders will revalidate according to the routers standard revalidation behavior.