-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
docs(en): use case for option function in defineStore #1309
Open
trchopan
wants to merge
3
commits into
vuejs:v2
Choose a base branch
from
trchopan:usecase-for-function-style-in-define-store
base: v2
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
# Create Store Dynamically | ||
|
||
Store can be created dynamically using factory pattern. Which will greatly help reduce boilerplate and structure your application. | ||
|
||
## Example | ||
|
||
An usecase of multiple tables that require pagination and filter. And all need to have separate stores to keep track of the result and pagings. | ||
|
||
We can have a creator function like this | ||
|
||
```js | ||
export const createPagingStore = (initialCurrentPage?: number) => { | ||
const currentPage = ref(initialCurrentPage ?? 0) | ||
const totalPage = ref(0) | ||
|
||
return { currentPage, totalPage } | ||
} | ||
``` | ||
|
||
Inside the `defineStore` option function you will have access to all the state and actions, and extra logic as needed. | ||
|
||
```js | ||
|
||
export const usePagingWeather = defineStore('pagingWeather, () => { | ||
const pagingStore = createPagingStore(1) | ||
const content = ref() | ||
|
||
// Logics for this store | ||
|
||
const fetchData = async (page) => { | ||
const data = await api.get(`https://example.com/?page=${page}`) | ||
currentPage.value = page | ||
totalPage.value = data.totalPage | ||
content.value = data.content | ||
} | ||
|
||
const sundays = computed(() => { | ||
return pagingStore.content.value.days.filter(day === 'sunday') | ||
}) | ||
|
||
return { | ||
...pagingStore, // currentPage, totalPage | ||
fetchData, | ||
content, | ||
|
||
sundays, | ||
} | ||
}) | ||
``` | ||
|
||
Don't worry about the same `ref`'s inside multiple store to be the same. They are handled by `pinia` as separate states in the stores. |
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In this example, there should be
ts
if you want to use type annotations. Nothing critical, but the formatting would be a little bit better