Skip to content
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
5 changes: 5 additions & 0 deletions .changeset/svelte-selector-identity.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@tanstack/svelte-store': patch
---

Fix `useSelector` object selection comparisons by preserving raw value identity.
2 changes: 1 addition & 1 deletion packages/svelte-store/src/useSelector.svelte.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export function useSelector<TState, TSelected = NoInfer<TState>>(
options: UseSelectorOptions<TSelected> = {},
): { readonly current: TSelected } {
const compare = options.compare ?? defaultCompare
let slice = $state(selector(source.get()))
let slice = $state.raw(selector(source.get()))

$effect(() => {
const unsub = source.subscribe((s) => {
Expand Down
35 changes: 35 additions & 0 deletions packages/svelte-store/tests/ObjectSelector.test.svelte
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
<script lang="ts">
import { untrack } from 'svelte'
import { createStore } from '@tanstack/store'
import { useSelector } from '../src/index.svelte.js'

const store = createStore({
selected: { value: 1 },
ignored: 1,
})

const selected = useSelector(store, (state) => state.selected)

let renderCount = $state(0)

$effect(() => {
selected.current
untrack(() => {
renderCount++
})
})
</script>

<div>
<p>Number rendered: {renderCount}</p>
<p>Selected: {selected.current.value}</p>
<button
onclick={() =>
store.setState((state) => ({
...state,
ignored: state.ignored + 1,
}))}
>
Update ignored
</button>
</div>
10 changes: 10 additions & 0 deletions packages/svelte-store/tests/index.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { render, waitFor } from '@testing-library/svelte'
import { userEvent } from '@testing-library/user-event'
import { shallow } from '../src/index.svelte.js'
import TestBaseStore from './BaseStore.test.svelte'
import TestObjectSelector from './ObjectSelector.test.svelte'
import TestRerender from './Render.test.svelte'
import TestValue from './Value.test.svelte'

Expand All @@ -28,6 +29,15 @@ describe('useSelector', () => {
expect(getByText('Number rendered: 2')).toBeInTheDocument()
})

it('preserves object identity for unchanged selector state', async () => {
const { getByRole, getByText } = render(TestObjectSelector)
expect(getByText('Number rendered: 1')).toBeInTheDocument()

await user.click(getByRole('button', { name: 'Update ignored' }))

expect(getByText('Number rendered: 1')).toBeInTheDocument()
})

it('useSelector reads writable and readonly store state', async () => {
const { getByText } = render(TestValue)
expect(getByText('Value: 1')).toBeInTheDocument()
Expand Down