Skip to content

feat(vue): allow dynamic Store instance #194

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/framework/vue/reference/functions/shallow.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ title: shallow
function shallow<T>(objA, objB): boolean
```

Defined in: [index.ts:47](https://github.com/TanStack/store/blob/main/packages/vue-store/src/index.ts#L47)
Defined in: [index.ts:49](https://github.com/TanStack/store/blob/main/packages/vue-store/src/index.ts#L49)

## Type Parameters

Expand Down
4 changes: 2 additions & 2 deletions docs/framework/vue/reference/functions/usestore.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Defined in: [index.ts:12](https://github.com/TanStack/store/blob/main/packages/v

#### store

`Store`\<`TState`, `any`\>
`MaybeRefOrGetter`\<`Store`\<`TState`, `any`\>\>

#### selector?

Expand Down Expand Up @@ -53,7 +53,7 @@ Defined in: [index.ts:16](https://github.com/TanStack/store/blob/main/packages/v

#### store

`Derived`\<`TState`, `any`\>
`MaybeRefOrGetter`\<`Derived`\<`TState`, `any`\>\>

#### selector?

Expand Down
16 changes: 9 additions & 7 deletions packages/vue-store/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { readonly, ref, toRaw, watch } from 'vue-demi'
import { readonly, ref, toRaw, toValue, watch } from 'vue-demi'
import type { Derived, Store } from '@tanstack/store'
import type { Ref } from 'vue-demi'
import type { MaybeRefOrGetter, Ref } from 'vue-demi'

export * from '@tanstack/store'

Expand All @@ -10,21 +10,23 @@ export * from '@tanstack/store'
export type NoInfer<T> = [T][T extends any ? 0 : never]

export function useStore<TState, TSelected = NoInfer<TState>>(
store: Store<TState, any>,
store: MaybeRefOrGetter<Store<TState, any>>,
selector?: (state: NoInfer<TState>) => TSelected,
): Readonly<Ref<TSelected>>
export function useStore<TState, TSelected = NoInfer<TState>>(
store: Derived<TState, any>,
store: MaybeRefOrGetter<Derived<TState, any>>,
selector?: (state: NoInfer<TState>) => TSelected,
): Readonly<Ref<TSelected>>
export function useStore<TState, TSelected = NoInfer<TState>>(
store: Store<TState, any> | Derived<TState, any>,
store:
| MaybeRefOrGetter<Store<TState, any>>
| MaybeRefOrGetter<Derived<TState, any>>,
selector: (state: NoInfer<TState>) => TSelected = (d) => d as any,
): Readonly<Ref<TSelected>> {
const slice = ref(selector(store.state)) as Ref<TSelected>
const slice = ref<TSelected>(selector(toValue(store).state))

watch(
() => store,
() => toValue(store),
(value, _oldValue, onCleanup) => {
const unsub = value.subscribe(() => {
const data = selector(value.state)
Expand Down
30 changes: 29 additions & 1 deletion packages/vue-store/tests/index.test.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { describe, expect, it, test, vi } from 'vitest'
// @ts-expect-error We need to import `h` as it's part of Vue's JSX transform
import { defineComponent, h } from 'vue-demi'
import { defineComponent, h, ref } from 'vue-demi'
import { render, waitFor } from '@testing-library/vue'
import { Store } from '@tanstack/store'
import { userEvent } from '@testing-library/user-event'
Expand Down Expand Up @@ -79,6 +79,34 @@ describe('useStore', () => {
await user.click(getByText('Update ignored'))
expect(getByText('Number rendered: 2')).toBeInTheDocument()
})

it('allows us to use a dynamic store', async () => {
function createStore(count: number) {
return new Store({ count })
}

const Comp = defineComponent(() => {
const store = ref(createStore(0))
const storeVal = useStore(store, (state) => state.count)

return () => {
return (
<div>
<p>Store: {storeVal.value}</p>
<button onClick={() => (store.value = createStore(10))}>
Update store
</button>
</div>
)
}
})

const { getByText } = render(Comp)
expect(getByText('Store: 0')).toBeInTheDocument()

await user.click(getByText('Update store'))
await waitFor(() => expect(getByText('Store: 10')).toBeInTheDocument())
})
})

describe('shallow', () => {
Expand Down
Loading