akadmin/zulip
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

updated/consolidated lit+zustand

Browse source
This commit is contained in:
authentik Default Admin 2026-03-04 18:11:14 -08:00
parent 648412dd6d
commit 2178304c76
7 changed files with 83 additions and 307 deletions
Download patch file Download diff file Expand all files Collapse all files

218
README.md
View file

@ -1,63 +1,25 @@
# Lit + Zustand Architecture # zulip
A simple (but modern & scalable) no-build web application architecture using Lit web components with Zustand state management and IndexedDB persistence. A modern, no-build web application using Lit web components with Zustand state management.
## For TSX/React Developers
If you're coming from React/TSX, here's how this architecture maps to familiar concepts:
| React/TSX Pattern | This Architecture |
|-------------------|-------------------|
| `useState` / `useReducer` | Zustand vanilla store |
| `useEffect` + state subscription | `StoreController` (ReactiveController) |
| Context API | Global Zustand store |
| `localStorage` / `sessionStorage` | IndexedDB via persist middleware |
| JSX | Lit's `html` tagged template literals |
| CSS-in-JS / CSS Modules | Lit's `css` tagged template literals |
| React Router | Simple route state in store |
| Build step (Vite/Webpack) | Import maps (no build!) |
### Key Differences
1. **No Virtual DOM**: Lit uses native Web Components with efficient DOM updates
2. **No Build Step**: Import maps let you use npm packages directly from CDN
3. **Reactive Controllers**: Replace hooks - attach to component lifecycle
4. **Tagged Templates**: Instead of JSX, use `html\`<div>...</div>\``
## Architecture Overview ## Architecture Overview
* **Lit-based web components** - Standards-based, framework-agnostic UI * **Lit-based web components** - Standards-based, framework-agnostic UI
* **No-build tooling** - Import maps only, no bundler required * **No-build tooling** - Import maps only, no bundler required
* **Zustand state management** - Lightweight, vanilla JS store * **Zustand state management** - Lightweight, vanilla JS store
* **IndexedDB persistence** - Automatic state persistence with idb-keyval * **StoreController** - Reactive controller that bridges Zustand and Lit
## Project Structure
## Layout
``` ```
src/ components/ -> standard lit components, including top-level "app-root"
store/ controllers/ -> lit reactive controllers (such as Zustand<->Lit bridge)
index.js ← zustand store definition store/ -> defines specific accessor sets
middleware/ index.html -> entry point with inline importmap and app-root
persistence.js ← idb-keyval persist adapter README.md
sync.js ← optional cross-tab broadcast
components/
app-root.js
feature-a/
feature-a.js ← Lit component
feature-a.css ← adopted stylesheet or constructable
controllers/
fetch.js ← ReactiveController for API calls
3d.js ← optional Three/WebGPU controller
lib/
idb.js ← thin idb-keyval wrapper/schema
index.html
importmap.json ← extracted importmap (referenced via <script src>)
``` ```
## Data Flow Diagrams ## Data Flow Diagram
### Component-to-Store Pattern
```mermaid ```mermaid
sequenceDiagram sequenceDiagram
@ -65,94 +27,61 @@ sequenceDiagram
participant LitComponent participant LitComponent
participant StoreController participant StoreController
participant ZustandStore participant ZustandStore
participant IndexedDB
User->>LitComponent: Click button User->>LitComponent: Click button
LitComponent->>ZustandStore: Call action (e.g., addItem) LitComponent->>ZustandStore: Call action (e.g., addItem)
ZustandStore->>ZustandStore: Update state ZustandStore->>ZustandStore: Update state
ZustandStore->>IndexedDB: Persist (via middleware)
ZustandStore->>StoreController: Notify subscribers ZustandStore->>StoreController: Notify subscribers
StoreController->>LitComponent: requestUpdate() StoreController->>LitComponent: requestUpdate()
LitComponent->>LitComponent: Re-render LitComponent->>LitComponent: Re-render
LitComponent->>User: Show updated UI LitComponent->>User: Show updated UI
``` ```
### Store Subscription Pattern ## Example
```mermaid ### 1. Define Store (Zustand Vanilla)
graph TD
A[Zustand Store] -->|subscribe| B[StoreController]
B -->|selector function| C[Extract specific state]
C -->|value changed?| D{Compare}
D -->|Yes| E[host.requestUpdate]
D -->|No| F[Skip update]
E --> G[Lit re-renders component]
style A fill:#f9f,stroke:#333,stroke-width:2px
style B fill:#bbf,stroke:#333,stroke-width:2px
style G fill:#bfb,stroke:#333,stroke-width:2px
```
### Complete Mental Model
```
┌─────────────────────────────────────────┐
│ User Interaction │
└──────────────┬──────────────────────────┘
│ (events)
▼
┌─────────────────────────────────────────┐
│ Lit Web Components │
│ - html`` templates (like JSX) │
│ - css`` styles (scoped) │
│ - Event handlers │
└──────────────┬──────────────────────────┘
│ (actions)
▼
┌─────────────────────────────────────────┐
│ StoreController (glue layer) │
│ - ReactiveController interface │
│ - Subscribes to store │
│ - Triggers requestUpdate() │
└──────────────┬──────────────────────────┘
│ (selector)
▼
┌─────────────────────────────────────────┐
│ Zustand Vanilla Store │
│ - Global state (like Context) │
│ - Actions (like reducers) │
│ - Subscriptions │
└──────────────┬──────────────────────────┘
│ (persist middleware)
▼
┌─────────────────────────────────────────┐
│ IndexedDB (via idb-keyval) │
│ - Automatic persistence │
│ - Async storage │
└─────────────────────────────────────────┘
```
## Quick Start Example
### 1. Define Store (like Redux/Zustand)
```javascript ```javascript
// store/index.js // store/index.js
import { createStore } from 'zustand/vanilla' import { createStore } from 'zustand/vanilla'
import { persist } from 'zustand/middleware'
export const store = createStore( export const store = createStore((set, get) => ({
persist(
(set) => ({
count: 0, count: 0,
increment: () => set(s => ({ count: s.count + 1 })), increment: () => set(s => ({ count: s.count + 1 })),
}), decrement: () => set(s => ({ count: s.count - 1 })),
{ name: 'my-store' } }))
)
)
``` ```
### 2. Create Component (like React component) ### 2. Create StoreController (Bridge)
```javascript
// controllers/store.js
export class StoreController {
constructor(host, store, selector) {
this.host = host
this.store = store
this.selector = selector
host.addController(this)
}
hostConnected() {
this._unsub = this.store.subscribe((state) => {
const next = this.selector(state)
if (next !== this.value) {
this.value = next
this.host.requestUpdate()
}
})
this.value = this.selector(this.store.getState())
}
hostDisconnected() {
this._unsub?.()
}
}
```
### 3. Create Component (Lit + StoreController)
```javascript ```javascript
// components/counter.js // components/counter.js
@ -165,16 +94,15 @@ class Counter extends LitElement {
#count = new StoreController(this, store, s => s.count) #count = new StoreController(this, store, s => s.count)
static styles = css` static styles = css`
button { padding: 1rem; font-size: 1.2rem; } button { padding: 1rem; font-size: 1.2rem; margin: 0.5rem; }
` `
render() { render() {
return html` return html`
<div> <div>
<p>Count: ${this.#count.value}</p> <p>Count: ${this.#count.value}</p>
<button @click=${() => store.getState().increment()}> <button @click=${() => store.getState().decrement()}>-</button>
Increment <button @click=${() => store.getState().increment()}>+</button>
</button>
</div> </div>
` `
} }
@ -183,40 +111,32 @@ class Counter extends LitElement {
customElements.define('my-counter', Counter) customElements.define('my-counter', Counter)
``` ```
### 3. Use in HTML (no build step!) ### 4. Instantiate in parent (such as app-root)
```html ```js
<!DOCTYPE html> import counter from "./counter.js":
<html>
<head> class AppRoot extends LitElement {
<script type="importmap"> render() {
{ return html`
"imports": { <counter></counter>
"lit": "https://esm.sh/lit@3", `;
"zustand/vanilla": "https://esm.sh/zustand@5/vanilla",
"zustand/middleware": "https://esm.sh/zustand@5/middleware"
} }
} }
</script>
</head>
<body>
<script type="module" src="components/counter.js"></script>
<my-counter></my-counter>
</body>
</html>
``` ```
## Benefits Over React/TSX ## Benefits Over TSX
✅ **No build step** - Edit and refresh, instant feedback 1. **No build step** - Edit and refresh, instant feedback
✅ **Smaller bundle** - No framework runtime, just standards
✅ **Better encapsulation** - Shadow DOM, scoped styles
✅ **Framework agnostic** - Works anywhere, even in React apps
✅ **Future-proof** - Built on web standards
## See Also 1. **Smaller bundle** - No framework runtime, just standards
- [tasks.md](./tasks.md) - Current issues and improvements 1. **Better encapsulation** - Shadow DOM, scoped styles
- [Lit Documentation](https://lit.dev)
- [Zustand Documentation](https://zustand.docs.pmnd.rs) 1. **Framework agnostic** - Works anywhere, even in React apps
- [Web Components](https://developer.mozilla.org/en-US/docs/Web/Web_Components)
1. **Future-proof** - Built on web standards
1. **Familiar patterns** - Zustand works like Redux/Context
1. **Type-safe** - Can add JSDoc or TypeScript without build step

11
components/app-root.js
View file

@ -6,7 +6,6 @@ import "./page-home.js";
import "./page-items.js"; import "./page-items.js";
class AppRoot extends LitElement { class AppRoot extends LitElement {
#hydrated = new StoreController(this, store, s => s._hydrated);
#user = new StoreController(this, store, s => s.user); #user = new StoreController(this, store, s => s.user);
#route = new StoreController(this, store, s => s.route); #route = new StoreController(this, store, s => s.route);
@ -15,19 +14,9 @@ class AppRoot extends LitElement {
display: block; display: block;
min-height: 100vh; min-height: 100vh;
} }
.loading {
display: grid;
place-items: center;
height: 100vh;
opacity: 0.4;
}
`; `;
render() { render() {
if (!this.#hydrated.value) {
return html`<div class="loading">loading...</div>`;
}
return html` return html`
<nav-bar .user=${this.#user.value}></nav-bar> <nav-bar .user=${this.#user.value}></nav-bar>
<main>${this.#renderRoute()}</main> <main>${this.#renderRoute()}</main>

4
index.html
View file

@ -9,9 +9,7 @@
"imports": { "imports": {
"lit": "https://esm.sh/lit@3", "lit": "https://esm.sh/lit@3",
"lit/decorators.js": "https://esm.sh/lit@3/decorators.js", "lit/decorators.js": "https://esm.sh/lit@3/decorators.js",
"zustand/vanilla": "https://esm.sh/zustand@5/vanilla", "zustand/vanilla": "https://esm.sh/zustand@5/vanilla"
"zustand/middleware": "https://esm.sh/zustand@5/middleware",
"idb-keyval": "https://esm.sh/idb-keyval@6"
} }
} }
</script> </script>

33
store/idb.js
View file

@ -1,33 +0,0 @@
// lib/idb.js
import { createStore, get, set, del, entries, clear } from 'idb-keyval'
// Named stores — each maps to a distinct IDBObjectStore
export const itemsStore = createStore('app-db', 'items')
export const userStore = createStore('app-db', 'user')
export const cacheStore = createStore('app-db', 'cache')
// Typed wrappers — keeps raw idb-keyval calls out of the rest of the app
// and gives you one place to add validation, logging, or migration logic
export const db = {
items: {
getAll: () => entries(itemsStore),
get: (id) => get(id, itemsStore),
set: (id, value) => set(id, value, itemsStore),
remove: (id) => del(id, itemsStore),
clear: () => clear(itemsStore),
},
user: {
get: () => get('user', userStore),
set: (value) => set('user', value, userStore),
clear: () => del('user', userStore),
},
cache: {
get: (key) => get(key, cacheStore),
set: (key, value) => set(key, value, cacheStore),
remove: (key) => del(key, cacheStore),
clear: () => clear(cacheStore),
}
}

37
store/index.js
View file

@ -1,42 +1,13 @@
import { createStore } from 'zustand/vanilla' import { createStore } from 'zustand/vanilla'
import { persist, createJSONStorage } from 'zustand/middleware'
import { get, set, del } from 'idb-keyval'
const storage = createJSONStorage(() => ({ export const store = createStore((set, get) => ({
getItem: async (name) => {
const value = await get(name)
return value ?? null
},
setItem: async (name, value) => {
await set(name, value)
},
removeItem: async (name) => {
await del(name)
},
}))
export const store = createStore(
persist(
(set, get) => ({
_hydrated: false,
user: null, user: null,
items: [], items: [],
route: 'home', route: 'home',
// Actions
setUser: (user) => set({ user }), setUser: (user) => set({ user }),
addItem: (item) => set(s => ({ items: [...s.items, item] })), addItem: (item) => set(s => ({ items: [...s.items, item] })),
removeItem: (id) => set(s => ({ items: s.items.filter(i => i.id !== id) })), removeItem: (id) => set(s => ({ items: s.items.filter(i => i.id !== id) })),
navigate: (route) => set({ route }), navigate: (route) => set({ route }),
}), }))
{
name: 'app-store',
storage,
onRehydrateStorage: () => {
return (state, error) => {
if (!error) {
store.setState({ _hydrated: true })
}
}
},
}
)
)

9
store/middleware/persistence.js
View file

@ -1,9 +0,0 @@
// store/middleware/persistence.js
import { db } from '../idb.js'
export const makeIdbStorage = (storeName) =>
createJSONStorage(() => ({
getItem: (name) => db[storeName].get(name),
setItem: (name, value) => db[storeName].set(name, value),
removeItem: (name) => db[storeName].remove(name),
}))

60
tasks.md
View file

@ -1,60 +0,0 @@
# Tasks & Issues
## 1. Critical Issues
- [ ] **1.1 Fix missing `del` import in store/index.js**
- Line 3 imports `get, set` from idb-keyval but `del` is used on line 13
- Add `del` to the import statement
- This will cause a ReferenceError when removeItem is called
- [ ] **1.2 Fix hydration flag initialization**
- The `onRehydrateStorage` callback uses `store.setState()` before `store` is fully initialized
- Creates a circular reference issue preventing app from loading
- **Options:**
- A) Initialize `_hydrated: true` by default (simplest)
- B) Use Zustand's persist middleware built-in hydration detection
- C) Move hydration callback outside store creation
- [ ] **1.3 Consolidate duplicate storage implementation**
- Storage is defined in both `store/index.js` AND `store/middleware/persistence.js`
- The middleware file exports `idbStorage` but it's not being used
- **Decision needed:** Use one or the other, not both
## 2. Architectural Improvements
- [ ] **2.1 Add error handling**
- Add try/catch blocks around IndexedDB operations
- Implement fallback if IndexedDB fails or is unavailable
- Add user feedback for errors (toast notifications?)
- [ ] **2.2 Add partialize option to persist middleware**
- Currently saves ALL state including `_hydrated` flag and `route`
- Should use `partialize: (state) => ({ user: state.user, items: state.items })`
- Prevents unnecessary data in IndexedDB
- [ ] **2.3 Add basic CSS reset to index.html**
- No base styles, margins, or font settings currently
- Consider adding minimal reset or normalize.css
- [ ] **2.4 Add loading states for async operations**
- No loading indicators for add/remove item operations
- Consider adding optimistic updates
## 3. Nice to Have
- [ ] **3.1 Add TypeScript types** (optional)
- JSDoc comments for better IDE support
- Or migrate to .ts files with no-build setup
- [ ] **3.2 Add cross-tab synchronization**
- README mentions optional `sync.js` middleware
- Implement BroadcastChannel for cross-tab state sync
- [ ] **3.3 Add route history management**
- Integrate with browser history API
- Support back/forward navigation
- [ ] **3.4 Add unit tests**
- Test store actions and selectors
- Test component rendering
- Test persistence layer