Add Data Mutation Guide #994
Draft
+278
−1
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
✅ Deploy Preview for solid-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
👷 Deploy Preview for solid-docs processing.
|
amirhhashemi
force-pushed
the
add-data-mutation-guide
branch
from
ad657f8 to
6bb8293
Compare
amirhhashemi
force-pushed
the
add-data-mutation-guide
branch
from
e51f764 to
9ad48e6
Compare
devagrawal09
suggested changes
Jan 1, 2025
Comment on lines
+44
to
+62
| const addPost = action(async (title: string) => { | ||
| await fetch("https://my-api.com/posts", { | ||
| method: "POST", | ||
| body: JSON.stringify({ title }), | ||
| }); | ||
| }, "addPost"); | ||
|
|
||
| export default function Page() { | ||
| const [title, setTitle] = createSignal(""); | ||
| return ( | ||
| <form action={addPost.with(title())} method="post"> | ||
| <input value={title()} onChange={(e) => setTitle(e.target.value)} /> | ||
| <button>Add Post</button> | ||
| </form> | ||
| ); | ||
| } | ||
| ``` | ||
|
|
||
| Note that the action takes a `string` as its parameter rather than a `FormData`. |
There was a problem hiding this comment.
Suggested change
| const addPost = action(async (title: string) => { | |
| await fetch("https://my-api.com/posts", { | |
| method: "POST", | |
| body: JSON.stringify({ title }), | |
| }); | |
| }, "addPost"); | |
| export default function Page() { | |
| const [title, setTitle] = createSignal(""); | |
| return ( | |
| <form action={addPost.with(title())} method="post"> | |
| <input value={title()} onChange={(e) => setTitle(e.target.value)} /> | |
| <button>Add Post</button> | |
| </form> | |
| ); | |
| } | |
| ``` | |
| Note that the action takes a `string` as its parameter rather than a `FormData`. | |
| const addPost = action(async (title: string, formData: FormData) => { | |
| await fetch("https://my-api.com/posts", { | |
| method: "POST", | |
| body: JSON.stringify({ title }), | |
| }); | |
| }, "addPost"); | |
| export default function Page() { | |
| const [title, setTitle] = createSignal(""); | |
| return ( | |
| <form action={addPost.with(title())} method="post"> | |
| <input value={title()} onChange={(e) => setTitle(e.target.value)} /> | |
| <button>Add Post</button> | |
| </form> | |
| ); | |
| } |
Note that the action now takes a string as its first parameter and the FormData as its second.
There was a problem hiding this comment.
I tried not to go into details of APIs in this guide. I believe that this content is better suited for the API Reference.
| return ( | ||
| <div> | ||
| <input value={title()} onInput={(e) => setTitle(e.target.value)} /> | ||
| <button onClick={() => addPostAction(title())}>Add Post</button> |
There was a problem hiding this comment.
I would recommend adding a callout at the bottom of this section that explains why form actions are preferred over useAction in terms of accessibility and progressive enhancement.
There was a problem hiding this comment.
This is better suited for a tutorial.
Like the Data Fetching guide, this guide is geared toward people who want to know "how to" do things, and not why and when.
Co-authored-by: Dev Agrawal <[email protected]>
Co-authored-by: Dev Agrawal <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description(required)
This is a follow up to #991.
This PR adds a data mutation guide
Related issues & labels