https://github.com/wobsoriano/solid-zustand

🐻 State management in Solid using zustand.
https://github.com/wobsoriano/solid-zustand

solid state-management zustand

Last synced: 2 months ago
JSON representation

🐻 State management in Solid using zustand.

• Host: GitHub
• URL: https://github.com/wobsoriano/solid-zustand
• Owner: wobsoriano
• License: mit
• Created: 2021-07-06T15:09:27.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-05-13T19:49:04.000Z (7 months ago)
• Last Synced: 2024-10-01T00:42:05.995Z (2 months ago)
• Topics: solid, state-management, zustand
• Language: TypeScript
• Homepage: https://stackblitz.com/edit/vitejs-vite-tcofpc?file=src/App.tsx
• Size: 422 KB
• Stars: 128
• Watchers: 4
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-solid-js - Solid Zustand

README

        


  



# solid-zustand

🐻 State management in Solid using [zustand](https://github.com/pmndrs/zustand).

## Install

```sh

pnpm add zustand solid-zustand

```

Demo: https://stackblitz.com/edit/vitejs-vite-tcofpc

## Usage

First create a zustand store

```tsx

import { createWithSignal } from 'solid-zustand'

interface BearState {

  bears: number

  increase: () => void

}

const useStore = createWithSignal(set => ({

  bears: 0,

  increase: () => set(state => ({ bears: state.bears + 1 })),

}))

```

Then bind your components, and that's it!

```tsx

function BearCounter() {

  const bears = useStore(state => state.bears)

  return 
{bears()} around here ...

}


function Controls() {

  const increase = useStore(state => state.increase)

  return one up

}

```

If you prefer [stores](https://docs.solidjs.com/references/api-reference/stores/using-stores) over [signals](https://www.solidjs.com/docs/latest#createsignal), use `createWithStore` function instead:

```tsx

import { createWithStore } from 'solid-zustand'

const useStore = createWithStore(set => ({

  bears: {

    count: 0,

  },

  increase: () => set(state => ({ bears: state.bears.count + 1 })),

}))

function BearCounter() {

  const bears = useStore(state => state.bears)

  return 
{bears.count} around here ...

}

```


## Recipes

### Fetching everything

```ts

const state = useStore()

```

### Selecting multiple state slices

It detects changes with strict-equality (old === new) by default, this is efficient for atomic state picks.

```ts

const nuts = useStore(state => state.nuts) // nuts()

const honey = useStore(state => state.honey) // honey()

```

If you want to construct a single object with multiple state-picks inside, similar to redux's mapStateToProps, you can tell zustand that you want the object to be diffed shallowly by passing the `shallow` equality function. That function will then be passed to the [`equals`](https://www.solidjs.com/docs/latest/api#options) option of `createSignal` (if using `createWithSignal`):

```ts

import shallow from 'zustand/shallow'

// Object pick, either state.nuts or state.honey change

const state = useStore(state => ({ nuts: state.nuts, honey: state.honey }), shallow) // state().nuts, state().honey

// Array pick, either state.nuts or state.honey change

const state = useStore(state => [state.nuts, state.honey], shallow) // state()[0], state()[1]

```

## License

MIT