wehub-resource-sync
e30e75b5d4
Changesets / Create Version PR (push) Has been cancelled
Deploy Shadcn Registry / Deploy Production (push) Has been cancelled
Template Metrics / LOC + Bundle Size (push) Has been cancelled
Code Quality / Oxlint + Oxfmt (push) Has been cancelled
Code Quality / Template Sync (push) Has been cancelled
Code Quality / Build Changed Packages (push) Has been cancelled
Code Quality / Test Changed Packages (push) Has been cancelled
Deploy Expo Example / Deploy Production (push) Has been cancelled
Deploy Ink Example / Deploy Production (push) Has been cancelled
Python Tests / pytest (assistant-stream, 3.10) (push) Has been cancelled
Python Tests / pytest (assistant-stream, 3.12) (push) Has been cancelled
Python Tests / pytest (assistant-ui-sync-server-api, 3.10) (push) Has been cancelled
Python Tests / pytest (assistant-ui-sync-server-api, 3.12) (push) Has been cancelled
66 lines
1.8 KiB
Markdown
66 lines
1.8 KiB
Markdown
# `@assistant-ui/store`
|
|
|
|
[](https://www.npmjs.com/package/@assistant-ui/store)
|
|
[](https://github.com/assistant-ui/assistant-ui)
|
|
|
|
Tap-based state container with React Context integration. Bridges `@assistant-ui/tap` resources into React via `useAui`, `useAuiState`, and `<AuiProvider>`.
|
|
|
|
`store` powers the runtime layer of assistant-ui. Most users do not install it directly; reach for `@assistant-ui/react` instead.
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
npm install @assistant-ui/store @assistant-ui/tap
|
|
```
|
|
|
|
## Usage
|
|
|
|
```typescript
|
|
import { resource } from "@assistant-ui/tap";
|
|
import { useState } from "react";
|
|
import {
|
|
useAui,
|
|
useAuiState,
|
|
AuiProvider,
|
|
type ClientOutput,
|
|
} from "@assistant-ui/store";
|
|
|
|
declare module "@assistant-ui/store" {
|
|
interface ScopeRegistry {
|
|
counter: {
|
|
methods: {
|
|
getState: () => { count: number };
|
|
increment: () => void;
|
|
};
|
|
};
|
|
}
|
|
}
|
|
|
|
const useCounterClient = (): ClientOutput<"counter"> => {
|
|
const [state, setState] = useState({ count: 0 });
|
|
return {
|
|
getState: () => state,
|
|
increment: () => setState({ count: state.count + 1 }),
|
|
};
|
|
};
|
|
|
|
const CounterClient = resource(useCounterClient);
|
|
|
|
function App() {
|
|
const aui = useAui({ counter: CounterClient() });
|
|
return (
|
|
<AuiProvider value={aui}>
|
|
<Counter />
|
|
</AuiProvider>
|
|
);
|
|
}
|
|
|
|
function Counter() {
|
|
const count = useAuiState((s) => s.counter.count);
|
|
const aui = useAui();
|
|
return <button onClick={() => aui.counter().increment()}>{count}</button>;
|
|
}
|
|
```
|
|
|
|
Full API reference (clients, derived clients, events, `useClientLookup`, `useClientList`) at [assistant-ui.com/tap/docs/store/quickstart](https://www.assistant-ui.com/tap/docs/store/quickstart).
|