add documentations for useSWRMutation #348
Merged
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
|
@koba04 is attempting to deploy a commit to the Vercel Team on Vercel. A member of the Team first needs to authorize it. |
|
I'll write documentation for other languages after the review for the English documentation has been approved. |
koba04
changed the title
huozhi
reviewed
Sep 8, 2022
| - `data`: data to update the client cache, or an async function for the remote mutation | ||
| - `options`: accepts the following options | ||
| - `optimisticData(currentData)`: data to immediately update the client cache, or a function that receives current data and returns the new client cache data, usually used in optimistic UI. | ||
| - `revalidate = true`: should the cache revalidate once the asynchronous update resolves. |
There was a problem hiding this comment.
We can still keep the name here instead of showing an assignment expression, and give the default value in the description
Suggested change
| - `revalidate = true`: should the cache revalidate once the asynchronous update resolves. | |
| - `revalidate`: should the cache revalidate once the asynchronous update resolves (default is `true`). |
There was a problem hiding this comment.
@huozhi
The API documentation of useSWR uses this assignment expression style, so I've used the same style because of the consistency.
https://swr.vercel.app/docs/options#options
Should we use this style in other places?
There was a problem hiding this comment.
I see, we can leave it as this now
Co-authored-by: Jiachi Liu <inbox@huozhi.im>
huozhi
approved these changes
Sep 12, 2022
huozhi
added a commit
that referenced
this pull request
Dec 9, 2022
* Empty commit for v2 branch * docs: optimisticData can accept a function in v2 (#333) * docs: add mutate filter functions documentation in v2 (#340) * Empty commit for v2 branch * docs: add mutate filter functions documentation in v2 * remove the usage of cache.clear() and use mutate instead * docs: add preload API documentation in v2 (#336) * Empty commit for v2 branch * docs: add preload API documentation in v2 * Apply suggestions from code review Co-authored-by: Jiachi Liu <inbox@huozhi.im> * Update pages/docs/prefetching.en-US.md Co-authored-by: Jiachi Liu <inbox@huozhi.im> * apply suggestions to other languages Co-authored-by: Jiachi Liu <inbox@huozhi.im> * docs: add DevTools page in v2 (#337) * Empty commit for v2 branch * docs: add DevTools documentation in v2 * Apply suggestions from code review Co-authored-by: Jiachi Liu <inbox@huozhi.im> * apply suggestions to other languages Co-authored-by: Jiachi Liu <inbox@huozhi.im> * docs: SWRConfig value as a function (#335) * Empty commit for v2 branch * docs: Nesting configurations with SWRConfig * Apply suggestions from code review Co-authored-by: Jiachi Liu <inbox@huozhi.im> * Update pages/docs/global-configuration.en-US.md Co-authored-by: Jiachi Liu <inbox@huozhi.im> * apply suggestions to other languages Co-authored-by: Jiachi Liu <inbox@huozhi.im> * Fetcher no longer accepts multiple arguments in v2 (#326) * Fetcher no longer accepts multiple arguments in v2 * Empty commit for v2 branch * Apply suggestions from code review Co-authored-by: Jiachi Liu <inbox@huozhi.im> * Update pages/docs/arguments.en-US.md Co-authored-by: Jiachi Liu <inbox@huozhi.im> * apply suggestions to other languages Co-authored-by: Jiachi Liu <inbox@huozhi.im> * docs: add an example for preload in effect (#345) * docs: add an example for preload in effects * Update pages/docs/prefetching.en-US.md Co-authored-by: Jiachi Liu <inbox@huozhi.im> * merge examples for inside React * Update pages/docs/prefetching.en-US.md Co-authored-by: Jiachi Liu <inbox@huozhi.im> * apply a suggestion Co-authored-by: Jiachi Liu <inbox@huozhi.im> * docs: add isLoading and keepPreviousData pages in v2 (#343) * docs: add the Return Values page * docs: add isLoading and keepPreviousData option * docs: fix header levels * docs: add a video for keepPreviousData * docs: move arguments page to next to return values page * docs: update diagrams for returning values * docs: update the performance document to add isLoading * docs: keep the list of return values in the options document * use isLoading instead of !data * translate options.md into Japanese * docs: add a detail link for keepPreviousData * tweak the description of isLoading * revert to move the arguments page * move the return values page into the advanced section * rename the Options page to API Options * fix links to the return values * fix a typo * add an excalidraw file for the state machine diagrams * rename the page from Return Values to Understanding SWR * rename the Options page to API * translate Understanding SWR into Japanese * tweak * change /docs/options links to /docs/api * Update pages/docs/advanced/meta.en-US.json Co-authored-by: Jiachi Liu <inbox@huozhi.im> * change the link of Understanding SWR Co-authored-by: Jiachi Liu <inbox@huozhi.im> * add documentations for useSWRMutation (#348) * reorganize the mutation page for useSWRMutation * write paramters and return values sections for mutation * docs: add examples of useSWRMutation * add an exmple to use useSWRMutation for loading data * Apply suggestions from code review Co-authored-by: Jiachi Liu <inbox@huozhi.im> Co-authored-by: Jiachi Liu <inbox@huozhi.im> * docs: add notes for Suspense on SSR and React v18 in SWR v2 (#334) * Empty commit for v2 branch * docs: add notes for Suspense on SSR and React v18 * Apply suggestions from code review Co-authored-by: Jiachi Liu <inbox@huozhi.im> * apply suggestions to other languages * Apply suggestions from code review Co-authored-by: Jiachi Liu <inbox@huozhi.im> * update other language Co-authored-by: Jiachi Liu <inbox@huozhi.im> * sync and refine mutate page (#350) * sync the mutation page of other languages * move the return values section of mutate into the API section * Note for the shape of keys in mutate filter functions (#353) add a note for the shape of keys in mutate filter functions * make explicit the location of mutate (#354) * explicit the location of mutate * Apply suggestions from code review Co-authored-by: Jiachi Liu <inbox@huozhi.im> * apply feedback to other languages * add more descriptiong to mutation Co-authored-by: Jiachi Liu <inbox@huozhi.im> * v2 blog post (#351) * add the v2 blog page * update the description * add the migration guide section * write more section for what's new * write changes of highlights * add demo videos in the v2 blog and links to the CodeSandbox * tweak * add braking changes for mutate multiple items * update description * add isMutating into the example for useSWRMutation * Apply suggestions from code review Co-authored-by: Jiachi Liu <inbox@huozhi.im> * Update pages/blog/swr-v2.en-US.mdx Co-authored-by: Jiachi Liu <inbox@huozhi.im> * move the details of isLoading and isValidating to the Userstanding SWR page * tweak wording * add authors * add og image Co-authored-by: Jiachi Liu <inbox@huozhi.im> * use link for codesandbox example (#355) * sync translations (#356) * sync the translation docs * fix Author's link * remove copy from a file name * fix: typos in v2 docs (#357) * fix: the hook name of useSWRMutation example * fix: optimisticData examples * Add onDiscarded option (#371) add onDiscarded option * V2 docs improvements (#361) * blog improvements * update * update blog post * update mutation * update * docs: change the build target in the v2 blogdocs: (#381) docs: change the build target in the v2 blog * Add functional rollbackOnError description (#377) * Add functional rollbackOnError description * fix typo * docs: translate v2 blog into Japanese (#383) * docs: translate v2 updates in Japanese (#384) * docs: translate v2 updates into Japanese * tweak * Fix case for section title (#387) * Update card and description for the v2 blog post (#388) update card and description * Rename laggy ui to preserving previous state (#389) * Rename laggy ui to preserving previous state * fix Co-authored-by: Jiachi Liu <inbox@huozhi.im> Co-authored-by: Shu Ding <g@shud.in>
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
This adds the documentation for
useSWRMutation.I've refined the structure of the mutation page to align with other pages.
I've also added the use case of using
useSWRMutationfor loading data.