# @prncss-xyz/zustand-optics

> zustand integration for optics-ts

Latest version **1.1.1** (published 2024-05-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install @prncss-xyz/zustand-optics
pnpm add @prncss-xyz/zustand-optics
yarn add @prncss-xyz/zustand-optics
bun add @prncss-xyz/zustand-optics
```

## Health

**Score 35/100 (D)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; has provenance; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2024-05-20 |
| First published | 2024-05-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Dependencies | 0 |
| Unpacked size | 23.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 4 |
| Author | Juliette Lamarche |
| Maintainers | prncss-xyz |
| Keywords | zustand, react, optics, state |

## Links

- npm: https://www.npmjs.com/package/@prncss-xyz/zustand-optics
- Repository: https://github.com/prncss-xyz/zustand-optics
- Homepage: https://github.com/prncss-xyz/zustand-optics#readme
- Issues: https://github.com/prncss-xyz/zustand-optics/issues
- npm.io page: https://npm.io/package/@prncss-xyz/zustand-optics

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.1.1 (latest) — 2024-05-20
- 1.1.0 — 2024-05-20
- 1.0.3 — 2024-05-20
- 0.0.5 — 2024-05-10
- 0.0.4 — 2024-05-10
- 0.0.3 — 2024-05-10
- 0.0.2 — 2024-05-10
- 0.0.1 — 2024-05-10
- 0.0.0 — 2024-05-10

## README

# Zustand Optics

[![Codecov](https://img.shields.io/codecov/c/github/prncss-xyz/zustand-optics)](https://codecov.io/github/prncss-xyz/zustand-optics)
[![Version](https://img.shields.io/npm/v/@prncss-xyz/zustand-optics)](https://www.npmjs.com/package/@prncss-xyz/zustand-optics)

[Zustand](https://docs.pmnd.rs/zustand) integration for [optics-ts](https://akheron.github.io/optics-ts/). Based on [jotai-optics](https://github.com/jotaijs/jotai-optics).

## Install

`npm i optics-ts @prncss-xyz/zustand-optics`

## Usage

### First create a store

```typescript
import { create } from "zustand";
import { withOptics } from "@prncss-xyz/zustand-optics";
import { optic } from "optics-ts";

const init = { bears: { grizzly: 0 } };
const useBearStore = withOptics(create(() => init));
const bearStoreO = optic<typeof init>();
```

### Then

```javascript
import { useCallback } from "react";

function GrizzlyCounter({ grizzly }: { grizzly: number }) {
  return <h1>{grizzly} around here...</h1>;
}
const grizzlyO = bearStoreO.prop("bears").prop("grizzly");

function App() {
  const [grizzly, setGrizzly] = useBearStore.rw(grizzlyO);
  const increasePopulation = useCallback(() => setGrizzly((x) => x + 1), [setGrizzly]);
  return (
    <>
      <GrizzlyCounter grizzly={grizzly} />
      <button onClick={increasePopulation}>one up</button>
    </>
  );
}

```

## API

### withOptics

`const useStore = withOptics<S>(useBoundStore: UseBoundStore<StoreApi<S>>, defaultIsEqual = Object.is)`

Create a hook with methods as described below. For the meaning of `defaultIsEqual`, see `activate`.

### Basic hooks

#### get

```javascript
const value = useStore.get(focus);
```

Returns the value of the focus. (Will return an array if focus is a traversable).

#### set

```javascript
const setValue = useStore.set(focus);
setValue(value);
```

Returns a callback which accepts a value and sets the focus to it. If `value` is a value (!), sets the focus to that value. If `value` is a callback, applies the callback to focus. If `value` is `undefined`, removes the focus for a removable optics (prism and traversable) and do nothing otherwise.

The callback is stable.

### Utility hooks

These are wrappers around the basic hooks which can help with code readability.

### rw

Returns a pair made of the focus value and a `set` callback.

```javascript
const [value, setValue] = useStore.rw(focus);
```

### activate

```javascript
const [active, activate] = useStore.activate(focus, target, isEqual?);
activate()
```

Returns a pair. The first value is a boolean representing whether the focus is equal to target. The second value is a callback setting focus to target value.

```typescript
isEqual<A>(a: A, b: A): boolean
```

The second argument is an optional equality function. If not provided, it defaults to the second argument of `createStoreWithOptics`. If neither is provided, defaults to `Object.is`.

### setWith

```javascript
const setter = useStore.setWith([focus1, value1], [focus2, value2] /*, ...*/);
setter();
```

Creates a callback which calls multiple `set` operations from left to right.

Note on typing: if you have more than 7 arguments (please don't), TypeScript will assume they all have the same type.

---
_Source: https://npm.io/package/@prncss-xyz/zustand-optics · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._