$app/forms
import { function applyAction<Success extends Record<string, unknown> | undefined, Failure extends Record<string, unknown> | undefined>(result: import("@sveltejs/kit").ActionResult<Success, Failure>): Promise<void>This action updates the form property of the current page with the given data and updates page.status.
In case of an error, it redirects to the nearest error page.
applyAction, function deserialize<Success extends Record<string, unknown> | undefined, Failure extends Record<string, unknown> | undefined>(result: string): import("@sveltejs/kit").ActionResult<Success, Failure>Use this function to deserialize the response from a form submission.
Usage:
import { deserialize } from '$app/forms';
async function handleSubmit(event) {
const response = await fetch('/form?/action', {
method: 'POST',
body: new FormData(event.target)
});
const result = deserialize(await response.text());
// ...
}
deserialize, function enhance<Success extends Record<string, unknown> | undefined, Failure extends Record<string, unknown> | undefined>(form_element: HTMLFormElement, submit?: import("@sveltejs/kit").SubmitFunction<Success, Failure>): {
destroy(): void;
}
This action enhances a <form> element that otherwise would work without JavaScript.
The submit function is called upon submission with the given FormData and the action that should be triggered.
If cancel is called, the form will not be submitted.
You can use the abort controller to cancel the submission in case another one starts.
If a function is returned, that function is called with the response from the server.
If nothing is returned, the fallback will be used.
If this function or its return value isn't set, it
- falls back to updating the
form prop with the returned data if the action is on the same page as the form
- updates
page.status
- resets the
<form> element and invalidates all data in case of successful submission with no redirect response
- redirects in case of a redirect response
- redirects to the nearest error page in case of an unexpected error
If you provide a custom function with a callback and want to use the default behavior, invoke update in your callback.
It accepts an options object
reset: false if you don't want the <form> values to be reset after a successful submission
invalidateAll: false if you don't want the action to call invalidateAll after submission
enhance } from '$app/forms';applyAction
Updates the form property of the current page with the given data and updates page.status.
In case of an error, it renders the nearest error page. In case of a redirect, it navigates to
the redirect location.
function applyAction<
Success extends Record<string, unknown> | undefined,
Failure extends Record<string, unknown> | undefined
>(
result: import('@sveltejs/kit').ActionResult<
Success,
Failure
>
): Promise<void>;deserialize
Use this function to deserialize the response from a form submission. Usage:
import { function deserialize<Success extends Record<string, unknown> | undefined, Failure extends Record<string, unknown> | undefined>(result: string): import("@sveltejs/kit").ActionResult<Success, Failure>Use this function to deserialize the response from a form submission.
Usage:
import { deserialize } from '$app/forms';
async function handleSubmit(event) {
const response = await fetch('/form?/action', {
method: 'POST',
body: new FormData(event.target)
});
const result = deserialize(await response.text());
// ...
}
deserialize } from '$app/forms';
async function function handleSubmit(event: any): Promise<void>handleSubmit(event: anyevent) {
const const response: Responseresponse = await function fetch(input: string | URL | Request, init?: RequestInit): Promise<Response> (+1 overload)fetch('/form?/action', {
RequestInit.method?: string | undefinedA string to set request's method.
method: 'POST',
RequestInit.body?: BodyInit | null | undefinedA BodyInit object or null to set request's body.
body: new var FormData: new (form?: HTMLFormElement, submitter?: HTMLElement | null) => FormDataThe FormData interface provides a way to construct a set of key/value pairs representing form fields and their values, which can be sent using the fetch(), XMLHttpRequest.send() or navigator.sendBeacon() methods. It uses the same format a form would use if the encoding type were set to "multipart/form-data".
FormData(event: anyevent.target)
});
const const result: ActionResult<Record<string, unknown> | undefined, Record<string, unknown> | undefined>result = deserialize<Record<string, unknown> | undefined, Record<string, unknown> | undefined>(result: string): ActionResult<Record<string, unknown> | undefined, Record<string, unknown> | undefined>Use this function to deserialize the response from a form submission.
Usage:
import { deserialize } from '$app/forms';
async function handleSubmit(event) {
const response = await fetch('/form?/action', {
method: 'POST',
body: new FormData(event.target)
});
const result = deserialize(await response.text());
// ...
}
deserialize(await const response: Responseresponse.Body.text(): Promise<string>text());
// ...
}function deserialize<
Success extends Record<string, unknown> | undefined,
Failure extends Record<string, unknown> | undefined
>(
result: string
): import('@sveltejs/kit').ActionResult<Success, Failure>;enhance
This action enhances a <form> element that otherwise would work without JavaScript.
The submit function is called upon submission with the given FormData and the action that should be triggered.
If cancel is called, the form will not be submitted.
You can use the abort controller to cancel the submission in case another one starts.
If a function is returned, that function is called with the response from the server.
If nothing is returned, the fallback will be used.
If this function or its return value isn't set, it emulates the browser-native behaviour, just without the full-page reload. It
- resets the
<form>element and refreshes all data in case of a successful submission with no redirect response - updates the
formprop,page.formandpage.statusif the action is on the same page as the form - navigates to the page the submission lands on — populating that page's
formprop andpage.status— on success and failure if that isn't the current page, just as a native form submission would, but with the?/actionNameparam stripped from the destination URL - redirects in case of a redirect response
- renders the nearest error page in case of an unexpected error — the one nearest the action's route, if the action is on a different page
If you provide a custom function with a callback and want to use the default behavior, invoke update in your callback.
It accepts an options object
reset: falseif you don't want the<form>values to be reset after a successful submissionrefreshAllto control whether all data is refreshed after submission; it defaults totruefor successes andfalsefor failuresnavigate: falseto apply non-redirect results to the current page rather than navigating toresult.location; redirects are always followed
function enhance<
Success extends Record<string, unknown> | undefined,
Failure extends Record<string, unknown> | undefined
>(
form_element: HTMLFormElement,
submit?: import('@sveltejs/kit').SubmitFunction<
Success,
Failure
>
): {
destroy(): void;
};Edit this page on GitHub llms.txt