Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add enhance update options to documentation. #13020

Open
russ3llc opened this issue Nov 17, 2024 · 2 comments · May be fixed by #13022
Open

Add enhance update options to documentation. #13020

russ3llc opened this issue Nov 17, 2024 · 2 comments · May be fixed by #13022
Labels
documentation Improvements or additions to documentation

Comments

@russ3llc
Copy link

Describe the problem

When using form enhancement you can return a callback function. The callback function has access to an update function which invokes the default form response behavior. The update function accepts options, but this doesn't seem to be in the Svelte documentation anywhere.

In order to know that you can, e.g. invoke update but not reset the form values (update({ reset: false })), you would have to check out the type hints in your code editor, or find out via 3rd party site. I personally discovered this very useful feature by way of StackOverflow.

Describe the proposed solution

Update the progressive enhancement or enhance reference pages to include a brief description of the update function options.

Importance

nice to have

@Conduitry Conduitry transferred this issue from sveltejs/svelte Nov 17, 2024
@russ3llc russ3llc linked a pull request Nov 18, 2024 that will close this issue
6 tasks
@eltigerchino eltigerchino added the documentation Improvements or additions to documentation label Nov 18, 2024
@eltigerchino
Copy link
Member

It's mentioned here https://svelte.dev/docs/kit/@sveltejs-kit#SubmitFunction but it is very hidden.

@russ3llc
Copy link
Author

Never noticed it there, thanks for that and for the PR fixes!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants