# Saved Views (Lumen Halo): prompt.md (v1.0.0)

- id: `lumen-saved-views` · version 1.0.0 · component · pro (All-Access)
- category: Data
- build: Base UI (one set of files; its dependencies follow the build)
- install (this build): `npx shadcn@latest add @beautiful-ui-pro/lumen-saved-views`
- npm dependencies: none
- registry dependencies: utils, @beautiful-ui-pro/lumen-popover, @beautiful-ui/lumen-button, @beautiful-ui-pro/lumen-alert-dialog, https://beautiful-ui.dev/r/lumen-foundation.json
- docs: https://beautiful-ui.dev/components/lumen-saved-views
- The install command carries everything this item needs (files, CSS, tokens, npm and registry dependencies). Prefer it to copying source by hand.

Names for "these filters, this sort, these columns". The trigger shows the view in use and a lit dot when the screen has drifted from it; views are shared or private, one is the default, and each can be renamed in place, duplicated or deleted. Plain JSON, kept by any store.

## Build it
- Stack: React 19 (`ref` is a plain prop), TypeScript, Tailwind CSS v4 utilities, a shadcn-initialised project with the `@/*` alias.
- Packages: none beyond React.
- Files: `components/ui/lumen/controls/saved-views.tsx`; shared code: `lib/beautiful-ui/core/views.ts`, `lib/beautiful-ui/core/filters.ts`.
- Registry dependencies, installed with it automatically: shadcn `utils` (cn), `lumen-popover`, `lumen-button`, `lumen-alert-dialog`, `lumen-foundation`.
- Builds: one set of files for both, but its dependencies come in Base UI and Radix builds. Install the one that matches the project (see Install): a free item's bare URL installs the Base UI build of it and its dependencies.
- Exports to keep: `SavedViews`, and every exported type.
- CSS: the install merges this item's rules (the registry `css` field) into your global stylesheet, in `@layer components`, and adds the lumen foundation (tokens, keyframes, motion levels) once. Nothing to import by hand.
- Re-running `add` (or `--overwrite`) re-applies those rules: put overrides in your own CSS, never in the installed rules.
- Tokens: retheme with the `--lumen-*` custom properties (`--lumen-accent`, `--lumen-accent-text`, `--lumen-bad`, `--lumen-bad-text`, `--lumen-focus`, `--lumen-good`, `--lumen-good-text`, `--lumen-hairline`, `--lumen-ink`, `--lumen-muted-ink`, `--lumen-series-1`, `--lumen-series-2`, `--lumen-series-3`, `--lumen-series-4`, `--lumen-series-5`, `--lumen-series-6`, `--lumen-warn`, `--lumen-warn-text`); this item's CSS also reads `--lumen-font-mono`, `--lumen-font-sans`, `--lumen-radius-k`. Never add Tailwind colour classes inside the component.

```tsx
import { SavedViews, useSavedViews, localViewStore } from "@/components/ui/lumen/controls/saved-views";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `SavedViews` | — | The trigger, the list with row actions, and save / save as new / discard. |

## Sound
- Keep every `data-slot` and `data-sound` attribute: the sound layer reads them.
- Installing this item adds no audio. Nothing plays until the app mounts `GlassSoundProvider` once (install: `npx shadcn@latest add https://beautiful-ui.dev/r/glass-sound.json`, import from `@/components/beautiful-ui/glass-sound`); `GlassSoundToggle` is its mute control. Without a provider the audio engine never loads.

## Match the original
- Read `components/ui/lumen/controls/saved-views.tsx` as the reference implementation before changing or recreating anything, and match it: sizes, colours per theme, motion timings, copy and behaviour.
- If you deviate (a prop you can't honour, a style you changed, a dependency you swapped), say so in your reply, part by part.
- Keep the accessibility contract, the keyboard map and the motion levels listed below.

## Use it when
- saved views, saved filters, views menu, table views, presets, default view, shared views, unsaved changes, Lumen
- Tables and dashboards people return to with the same filters and sort
- Teams that share a few standard cuts of the data

### Not when
- One-off filtering: the Filter Bar's URL state is enough

## Mistakes
- Store shared views on your server; localStorage is per browser
- Save the view state, not the rows: views are filters, sort and columns

## Usage

```tsx
import { SavedViews, useSavedViews, localViewStore } from "@/components/ui/lumen/controls/saved-views";
import { useDataExplorer } from "@/components/ui/lumen/controls/data-explorer";

function ExplorerViews() {
  const views = useSavedViews({ store: localViewStore("accounts-views") });
  const { viewState, applyViewState } = useDataExplorer();
  return <SavedViews {...views.props} current={viewState} onApply={applyViewState} />;
}

<DataExplorerToolbar><ExplorerViews /></DataExplorerToolbar>
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `views / onViewsChange` | `ViewsState` |  | Every view, the active one and the default; useSavedViews keeps it and persists it through a ViewStore. |
| `current` | `ViewState` |  | The screen's filters, sort and columns right now; from Data Explorer, useDataExplorer().viewState. |
| `onApply` | `(state: ViewState) => void` |  | Put a view on the screen; from Data Explorer, useDataExplorer().applyViewState. |
| `ownerId` | `string` |  | Views by someone else can be used and duplicated, not renamed, shared or deleted. |
| `canShare` | `boolean` | `true` | Offer shared and private, grouped in the list. |
| `labels` | `Partial<Labels>` |  | Every word, for i18n. |
| `useSavedViews({ store, initial })` | `hook` |  | State plus persistence; localViewStore(key) is an example store (localStorage). Use your server for shared views. |

Full docs: https://beautiful-ui.dev/components/lumen-saved-views

## Customising
- Colours: set the `--lumen-*` tokens on `:root`, or on a container with the `lumen-scope` class to retheme one area. Add the `lumen-inherit` class to follow your shadcn palette instead (`--chart-N`, `--destructive`).
- Dark mode follows the `.dark` class on an ancestor (the shadcn and next-themes convention).
- Update later by re-running the install with `--overwrite` (review the diff if you edited it). Changelog: https://beautiful-ui.dev/r/changelog.json

## Keyboard

| Keys | Action |
|---|---|
| Enter / Space | Open the list, pick a view, run an action |
| Tab | Move through views and their actions |
| Escape | Cancel a rename, close the list |

## Motion inventory

| Interaction | What moves |
|---|---|
| Unsaved changes | A small lit dot appears on the trigger |
| Open | The floating glass grows from the trigger |

## Accessibility contract (preserve when editing)
- The trigger names the view in use and says when there are unsaved changes
- Groups are labelled; the view in use is aria-current
- Every row action is a named button, reachable by Tab; the default star is a toggle
- Deleting asks first in an alert dialog

## Install

```bash
npx shadcn@latest add @beautiful-ui-pro/lumen-saved-views
```

Pro item: needs the `@beautiful-ui-pro` registry in `components.json` and `BEAUTIFUL_UI_TOKEN` in `.env.local` (https://beautiful-ui.dev/account). Setup: https://beautiful-ui.dev/docs/pro. Your components.json `style` picks the build: radix-*, new-york and default get Radix, base-* gets Base UI.

## Credits
- Built on shadcn/ui (https://ui.shadcn.com)

The lumen foundation (the tokens listed above, keyframes and motion levels) installs once with the first component; its CSS is public at https://beautiful-ui.dev/r/lumen-foundation.json.