SubmitOptions

sealed external interface SubmitOptions : FetcherSubmitOptions(source)

Submit options available to navigations

Properties

Link copied to clipboard
abstract var action: String?

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

Link copied to clipboard
abstract var encType: FormEncType?

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

Link copied to clipboard
abstract var fetcherKey: String?

Indicate a specific fetcherKey to use when using navigate=false

Link copied to clipboard
abstract var flushSync: Boolean?

Enable flushSync for this submission's state updates

Link copied to clipboard
abstract var method: HTMLFormMethod?

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

Link copied to clipboard
abstract var navigate: Boolean?

navigate=false will use a fetcher instead of a navigation

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
abstract var replace: Boolean?

Set true to replace the current entry in the browser's history stack instead of creating a new one (i.e. stay on "the same page"). Defaults to false.

Link copied to clipboard
abstract var state: Any?

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

Link copied to clipboard
abstract var viewTransition: Boolean?

Enable view transitions on this submission navigation