@vvedantb/ui 0.5.1 → 0.5.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +33 -4
- package/package.json +10 -11
- package/shell/src/AppSidebar.tsx +10 -1
- package/shell/src/SidebarAccountMenu.tsx +40 -2
- package/src/ui/confirm-dialog.tsx +41 -2
- package/app/README.md +0 -100
- package/tokens/README.md +0 -98
package/README.md
CHANGED
|
@@ -208,11 +208,13 @@ import { ConfirmDialog, SlideOverPanel, ToolbarSearchInput } from "@vvedantb/ui"
|
|
|
208
208
|
<ToolbarSearchInput value={query} onChange={setQuery} />
|
|
209
209
|
|
|
210
210
|
<ConfirmDialog size="sm" open={open} onOpenChange={setOpen} title="Delete item?" variant="destructive" onConfirm={remove} />
|
|
211
|
+
|
|
212
|
+
<ConfirmDialog size="md" open={open} onOpenChange={setOpen} title="Delete item?" description="This cannot be undone." confirmLabel="Delete" variant="destructive" onConfirm={remove} />
|
|
211
213
|
```
|
|
212
214
|
|
|
213
215
|
- `SlideOverPanel`: a right-side panel, absolutely positioned inside its nearest positioned parent. It is not a portal or dialog. It slides in with a spring and is hidden below `md`. Only the close button closes it (no Escape, no outside click). `width` is `"w-96"` (default) or `"w-80"`. `closeLabel` defaults to `"Close panel"`. `className` merges last.
|
|
214
216
|
- `ToolbarSearchInput`: a compact `h-8` search field for toolbars, with a search icon and a clear button. The clear button stays mounted and is hidden while the value is blank. Clearing calls `onChange("")` and does not move focus. Defaults: `placeholder="Search..."`, `label="Search"` (the `aria-label`), `clearLabel="Clear search"`. The ref goes to the `<input>`.
|
|
215
|
-
- `ConfirmDialog` `size`: `"default"` keeps the alert dialog. `"sm"` renders a compact, dismissible dialog (outside click, Escape and the close button close it) with small Cancel and confirm buttons. Cancel calls `onCancel` and then `onOpenChange(false)`. Confirm calls `onConfirm` only, so the caller closes it.
|
|
217
|
+
- `ConfirmDialog` `size`: `"default"` keeps the alert dialog. `"sm"` renders a compact, dismissible dialog (outside click, Escape and the close button close it) with small Cancel and confirm buttons. Cancel calls `onCancel` and then `onOpenChange(false)`. Confirm calls `onConfirm` only, so the caller closes it. `"md"` (0.5.2) is dismissible like `"sm"`, with the title in a header (`pb-4`), the description in its own section (`py-6`) and a footer (`pt-4`) with default-size buttons. It has the same Cancel and confirm behaviour as `"sm"`.
|
|
216
218
|
|
|
217
219
|
## Buttons, menus and fields (0.4.4)
|
|
218
220
|
|
|
@@ -248,7 +250,7 @@ import {
|
|
|
248
250
|
- `SelectField`: a labelled single select built from `Select`. Children are `SelectItem`s. An empty `value` shows the placeholder. `id` goes to the trigger and the label points at it. `className` merges onto the trigger.
|
|
249
251
|
- Motion: `springTransition`, `springFastTransition` and `fadeUpSpring` presets. `FadePresence` takes optional `variants` (`hidden`, `show`, `exit`); omitted, it keeps its opacity fade. `PanelTransition` wraps children in React `ViewTransition` with `default="none"` and `enter`/`exit` classes (`vt-panel-in`, `vt-panel-out` by default). It needs a React build that exports `ViewTransition`, and the app supplies the `::view-transition-*` CSS.
|
|
250
252
|
|
|
251
|
-
## App shell (0.5.0
|
|
253
|
+
## App shell (0.5.0 to 0.5.2)
|
|
252
254
|
|
|
253
255
|
A sidebar and main page layout, extracted from existing app markup. It is router-free: pass your own links (with `asChild`), state and media query result. Tooltips need a `TooltipProvider` above the shell.
|
|
254
256
|
|
|
@@ -289,15 +291,42 @@ import {
|
|
|
289
291
|
|
|
290
292
|
- Widths: `AppShell` sets `--app-shell-rail-width` (default `4rem`), `--app-shell-sidebar-width` (rail plus panel, default `20rem`) and `--app-shell-mobile-header-height` (default `calc(3.5rem + env(safe-area-inset-top, 0px))`) as inline style. Change them with `railWidth`, `sidebarWidth` and `mobileHeaderHeight`. The other pieces read these variables. Outside `AppShell`, set the variables yourself or pass a width class with `className`.
|
|
291
293
|
- `AppShell`: `sidebar`, `children`, `panelHidden` (main offsets by the rail width instead of the sidebar width), `skipLinkLabel` (`"Skip to main content"`), `mainId` (`"main-content"`), `className`, `mainClassName`, `contentClassName`.
|
|
292
|
-
- `AppSidebar`: `rail`, `panel` (not rendered while `panelHidden`), `collapsed`, `panelHidden`, `isDesktop`, `mobileOpen`, `onMobileOpenChange`, `id` (default from `useId`), `asideProps` (`data-*` attributes for the `<aside>`), `className`, `mobileTitle`, `mobileMenuIcon` (`(open) => node`, default a menu icon), `mobileMenuLabel` (`"Open navigation menu"`), `closeLabel` (`"Close navigation"`). Swipe left or Escape closes the drawer. The drawer is `inert` while closed on mobile, and closes when `isDesktop` becomes `true`. Close it on route change in the app.
|
|
294
|
+
- `AppSidebar`: `rail`, `panel` (not rendered while `panelHidden`), `collapsed`, `panelHidden`, `isDesktop`, `mobileOpen`, `onMobileOpenChange`, `id` (default from `useId`), `asideProps` (`data-*` attributes for the `<aside>`), `className`, `mobileTitle`, `mobileHeaderActions` (0.5.2; trailing actions such as icon buttons, in place of the end spacer), `mobileMenuIcon` (`(open) => node`, default a menu icon), `mobileMenuLabel` (`"Open navigation menu"`), `closeLabel` (`"Close navigation"`). Swipe left or Escape closes the drawer. The drawer is `inert` while closed on mobile, and closes when `isDesktop` becomes `true`. Close it on route change in the app.
|
|
293
295
|
- `SidebarRail`: `top`, `children` (scroll body), `footer`, `showDivider`, `bodyAsChild` (the single child, for example a tabs list, becomes the body), `className`, `topClassName`, `bodyClassName`, `footerClassName`. Other HTML attributes (`id`, `data-*`, `aria-*`) go to the root `<div>`. The top and footer wrappers render only when their slot is set.
|
|
294
296
|
- `RailTile`: `label` (`aria-label` and tooltip), `active`, `tooltip`, `showTooltip` (default `true`), `badge` (inside the tile, after the children; style it with `railBadgeClass`), `asChild`, `className`. Without `asChild` it is a ghost `Button`; other props go to it. With `asChild` the child (for example a router link) gets the tile classes and `aria-current="page"` when active.
|
|
295
297
|
- `RailDivider`, `SidebarIconTooltip` (`label`, `enabled`, `side` `"right"`, `sideOffset` 8).
|
|
296
298
|
- `SidebarPanel`: `title`, `headerTrailing`, `onClose` (adds the close button; pass it on the mobile drawer only), `closeLabel`, `closeButtonClassName`, `collapsed` (`md:hidden`), `className`, `children`.
|
|
297
|
-
- `SidebarAccountMenu`: `name`, `email` (two-line label when set), `stackedLabel` (two-line layout even without `email`, default `false`), `imageUrl` (initials without it), `align` (`"center"`), `side` (`"right"`), `sideOffset` (8), `collisionPadding`, `contentClassName`, `children` (menu items). `SidebarAccountMenuPlaceholder` is the tile-sized loading box.
|
|
299
|
+
- `SidebarAccountMenu`: `name`, `email` (two-line label when set), `stackedLabel` (two-line layout even without `email`, default `false`), `imageUrl` (initials without it), `align` (`"center"`), `side` (`"right"`), `sideOffset` (8), `collisionPadding`, `contentClassName`, `children` (menu items). 0.5.2 adds `badge` (unread dot beside the trigger, in a `relative` wrapper around the menu, so the trigger's dimming and press scale skip it: `true` shows it, `false` fades it out, omitted renders no wrapper and no dot), `triggerProps` (spread onto the trigger `Button` after the defaults; `className` merges last) and `contentProps` (spread onto `DropdownMenuContent`, for example `fitViewport` or `aria-label`; no `className`, use `contentClassName`). `SidebarAccountMenuPlaceholder` is the tile-sized loading box.
|
|
298
300
|
- `SignOutDialog`: `open`, `onOpenChange` (not called with `false` while `pending`), `pending`, `onConfirm`, `description`, `contentClassName`, `title` (`"Sign out"`), `question` (`"Sign out of your account?"`).
|
|
299
301
|
- Class helpers: `railTileClass`, `railTileStateClass(active)`, `railBadgeClass`, `sidebarNavRowClass(isIconOnly)`, `sidebarNavLinkTextClass(isActive)`, `sidebarSectionLabelClass`.
|
|
300
302
|
|
|
303
|
+
### Header actions and account badge (0.5.2)
|
|
304
|
+
|
|
305
|
+
All opt-in. Without these props the header keeps its end spacer and the account trigger has no dot.
|
|
306
|
+
|
|
307
|
+
```tsx
|
|
308
|
+
<AppSidebar
|
|
309
|
+
/* … */
|
|
310
|
+
mobileHeaderActions={
|
|
311
|
+
<>
|
|
312
|
+
<Button size="icon" variant="ghost" aria-label="Search"><IconSearch size={20} /></Button>
|
|
313
|
+
<Button size="icon" variant="ghost" aria-label="New item"><IconPlus size={20} /></Button>
|
|
314
|
+
</>
|
|
315
|
+
}
|
|
316
|
+
/>
|
|
317
|
+
|
|
318
|
+
<SidebarAccountMenu
|
|
319
|
+
name={name}
|
|
320
|
+
badge={hasUnread}
|
|
321
|
+
triggerProps={{ "aria-label": hasUnread ? `Account menu for ${name}, unread updates` : `Account menu for ${name}` }}
|
|
322
|
+
contentProps={{ fitViewport: true, "aria-label": "Account" }}
|
|
323
|
+
>
|
|
324
|
+
<DropdownMenuItem>Settings</DropdownMenuItem>
|
|
325
|
+
</SidebarAccountMenu>
|
|
326
|
+
```
|
|
327
|
+
|
|
328
|
+
The dot is `aria-hidden`, so say it in the trigger label when it matters, as above.
|
|
329
|
+
|
|
301
330
|
### Resizable panel (0.5.1)
|
|
302
331
|
|
|
303
332
|
Pass `resizable` to `AppShell`. Widths are panel px, rail excluded. Without it nothing changes.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vvedantb/ui",
|
|
3
|
-
"version": "0.5.
|
|
3
|
+
"version": "0.5.2",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"description": "Shared React 19 UI for web apps: one JavaScript entry (primitives, shell pieces, app helpers, native tokens), design-token CSS, shared Tailwind v4 CSS and a Tailwind preset.",
|
|
6
6
|
"type": "module",
|
|
@@ -52,15 +52,6 @@
|
|
|
52
52
|
"sideEffects": [
|
|
53
53
|
"./src/ui/sonner.css"
|
|
54
54
|
],
|
|
55
|
-
"scripts": {
|
|
56
|
-
"check:tokens": "node tokens/scripts/check-component-tokens.mjs",
|
|
57
|
-
"build": "node tokens/scripts/check-exports.mjs && node tokens/scripts/check-component-tokens.mjs && tsc -p tsconfig.json",
|
|
58
|
-
"typecheck": "tsc -p tsconfig.json && tsc -p tokens/tsconfig.json",
|
|
59
|
-
"test": "node tokens/scripts/check-component-tokens.mjs && vitest run && node --test tokens/test/*.test.mjs",
|
|
60
|
-
"verify": "node tokens/scripts/check-component-tokens.mjs && node tokens/verify/run.mjs",
|
|
61
|
-
"analyze": "node tokens/verify/analyze.mjs",
|
|
62
|
-
"prepack": "node tokens/scripts/check-exports.mjs"
|
|
63
|
-
},
|
|
64
55
|
"peerDependencies": {
|
|
65
56
|
"@clerk/clerk-react": ">=5",
|
|
66
57
|
"@radix-ui/react-accordion": "^1.2.12",
|
|
@@ -171,5 +162,13 @@
|
|
|
171
162
|
"zod": {
|
|
172
163
|
"optional": true
|
|
173
164
|
}
|
|
165
|
+
},
|
|
166
|
+
"scripts": {
|
|
167
|
+
"check:tokens": "node tokens/scripts/check-component-tokens.mjs",
|
|
168
|
+
"build": "node tokens/scripts/check-exports.mjs && node tokens/scripts/check-component-tokens.mjs && tsc -p tsconfig.json",
|
|
169
|
+
"typecheck": "tsc -p tsconfig.json && tsc -p tokens/tsconfig.json",
|
|
170
|
+
"test": "node tokens/scripts/check-component-tokens.mjs && vitest run && node --test tokens/test/*.test.mjs",
|
|
171
|
+
"verify": "node tokens/scripts/check-component-tokens.mjs && node tokens/verify/run.mjs",
|
|
172
|
+
"analyze": "node tokens/verify/analyze.mjs"
|
|
174
173
|
}
|
|
175
|
-
}
|
|
174
|
+
}
|
package/shell/src/AppSidebar.tsx
CHANGED
|
@@ -29,6 +29,8 @@ export type AppSidebarProps = {
|
|
|
29
29
|
className?: string;
|
|
30
30
|
/** Centred in the mobile header when truthy. */
|
|
31
31
|
mobileTitle?: ReactNode;
|
|
32
|
+
/** Trailing actions in the mobile header, for example icon buttons. Replaces the end spacer. */
|
|
33
|
+
mobileHeaderActions?: ReactNode;
|
|
32
34
|
/** Menu button icon. Default a 20px menu icon. */
|
|
33
35
|
mobileMenuIcon?: (open: boolean) => ReactNode;
|
|
34
36
|
/** Default `"Open navigation menu"`. */
|
|
@@ -57,6 +59,7 @@ export function AppSidebar({
|
|
|
57
59
|
asideProps,
|
|
58
60
|
className,
|
|
59
61
|
mobileTitle,
|
|
62
|
+
mobileHeaderActions,
|
|
60
63
|
mobileMenuIcon = defaultMobileMenuIcon,
|
|
61
64
|
mobileMenuLabel = "Open navigation menu",
|
|
62
65
|
closeLabel = "Close navigation",
|
|
@@ -114,7 +117,13 @@ export function AppSidebar({
|
|
|
114
117
|
{mobileTitle}
|
|
115
118
|
</h1>
|
|
116
119
|
) : null}
|
|
117
|
-
|
|
120
|
+
{mobileHeaderActions ? (
|
|
121
|
+
<div data-app-sidebar-mobile-actions="" className="ml-auto flex shrink-0 items-center gap-2">
|
|
122
|
+
{mobileHeaderActions}
|
|
123
|
+
</div>
|
|
124
|
+
) : (
|
|
125
|
+
<div className="ml-auto h-11 w-11 shrink-0" aria-hidden="true" />
|
|
126
|
+
)}
|
|
118
127
|
</header>
|
|
119
128
|
|
|
120
129
|
<AnimatePresence initial={false}>
|
|
@@ -30,6 +30,19 @@ export type SidebarAccountMenuProps = {
|
|
|
30
30
|
collisionPadding?: ContentProps["collisionPadding"];
|
|
31
31
|
/** Merged onto the menu content after `w-56`. */
|
|
32
32
|
contentClassName?: string;
|
|
33
|
+
/**
|
|
34
|
+
* Unread dot over the trigger's top-right corner, a sibling of the trigger in
|
|
35
|
+
* a `relative` wrapper. `true` shows it, `false` keeps it mounted at zero
|
|
36
|
+
* opacity so it fades out. Omitted: no wrapper and no dot.
|
|
37
|
+
*/
|
|
38
|
+
badge?: boolean;
|
|
39
|
+
/** Spread onto the trigger `Button` after the defaults (overrides `title`, `aria-label`, …). `className` merges last. */
|
|
40
|
+
triggerProps?: Omit<ComponentPropsWithoutRef<typeof Button>, "children" | "asChild">;
|
|
41
|
+
/** Spread onto `DropdownMenuContent`, for example `fitViewport` or `aria-label`. Use `contentClassName` for classes. */
|
|
42
|
+
contentProps?: Omit<
|
|
43
|
+
ContentProps,
|
|
44
|
+
"children" | "className" | "align" | "side" | "sideOffset" | "collisionPadding"
|
|
45
|
+
>;
|
|
33
46
|
/** Menu items after the label and separator. */
|
|
34
47
|
children?: ReactNode;
|
|
35
48
|
};
|
|
@@ -73,9 +86,12 @@ export function SidebarAccountMenu({
|
|
|
73
86
|
sideOffset = 8,
|
|
74
87
|
collisionPadding,
|
|
75
88
|
contentClassName,
|
|
89
|
+
badge,
|
|
90
|
+
triggerProps,
|
|
91
|
+
contentProps,
|
|
76
92
|
children,
|
|
77
93
|
}: SidebarAccountMenuProps) {
|
|
78
|
-
|
|
94
|
+
const menu = (
|
|
79
95
|
<DropdownMenu>
|
|
80
96
|
<DropdownMenuTrigger asChild>
|
|
81
97
|
<Button
|
|
@@ -83,12 +99,19 @@ export function SidebarAccountMenu({
|
|
|
83
99
|
variant="ghost"
|
|
84
100
|
title={name}
|
|
85
101
|
aria-label={`Account menu for ${name}`}
|
|
86
|
-
|
|
102
|
+
{...triggerProps}
|
|
103
|
+
className={cn(
|
|
104
|
+
railTileClass,
|
|
105
|
+
"h-11 w-11 p-0",
|
|
106
|
+
railTileStateClass(false),
|
|
107
|
+
triggerProps?.className,
|
|
108
|
+
)}
|
|
87
109
|
>
|
|
88
110
|
<AccountAvatar src={imageUrl} name={name} className="h-7 w-7" />
|
|
89
111
|
</Button>
|
|
90
112
|
</DropdownMenuTrigger>
|
|
91
113
|
<DropdownMenuContent
|
|
114
|
+
{...contentProps}
|
|
92
115
|
align={align}
|
|
93
116
|
side={side}
|
|
94
117
|
sideOffset={sideOffset}
|
|
@@ -111,6 +134,21 @@ export function SidebarAccountMenu({
|
|
|
111
134
|
</DropdownMenuContent>
|
|
112
135
|
</DropdownMenu>
|
|
113
136
|
);
|
|
137
|
+
if (badge === undefined) return menu;
|
|
138
|
+
// Sibling of the trigger, so its opacity and press scale do not reach the dot.
|
|
139
|
+
return (
|
|
140
|
+
<div className="relative">
|
|
141
|
+
{menu}
|
|
142
|
+
<span
|
|
143
|
+
aria-hidden="true"
|
|
144
|
+
data-account-badge=""
|
|
145
|
+
className={cn(
|
|
146
|
+
"pointer-events-none absolute right-0 top-0 h-2.5 w-2.5 rounded-full border-2 border-background bg-danger transition-opacity duration-150 ease-out",
|
|
147
|
+
badge ? "opacity-100" : "opacity-0",
|
|
148
|
+
)}
|
|
149
|
+
/>
|
|
150
|
+
</div>
|
|
151
|
+
);
|
|
114
152
|
}
|
|
115
153
|
|
|
116
154
|
export type SidebarAccountMenuPlaceholderProps = { className?: string };
|
|
@@ -10,7 +10,14 @@ import {
|
|
|
10
10
|
AlertDialogTitle,
|
|
11
11
|
} from "./alert-dialog";
|
|
12
12
|
import { Button } from "./button";
|
|
13
|
-
import {
|
|
13
|
+
import {
|
|
14
|
+
Dialog,
|
|
15
|
+
DialogContent,
|
|
16
|
+
DialogDescription,
|
|
17
|
+
DialogFooter,
|
|
18
|
+
DialogHeader,
|
|
19
|
+
DialogTitle,
|
|
20
|
+
} from "./dialog";
|
|
14
21
|
|
|
15
22
|
export type ConfirmDialogProps = React.ComponentProps<typeof AlertDialog> & {
|
|
16
23
|
title: React.ReactNode;
|
|
@@ -25,8 +32,10 @@ export type ConfirmDialogProps = React.ComponentProps<typeof AlertDialog> & {
|
|
|
25
32
|
* `"default"`: blocking alert dialog that closes on either button.
|
|
26
33
|
* `"sm"`: compact dismissible dialog (outside click, Escape and the close
|
|
27
34
|
* button close it). Confirm does not close it; the caller controls `open`.
|
|
35
|
+
* `"md"`: dismissible dialog like `"sm"`, with a header, description and
|
|
36
|
+
* footer in separate sections and default-size buttons.
|
|
28
37
|
*/
|
|
29
|
-
size?: "default" | "sm";
|
|
38
|
+
size?: "default" | "sm" | "md";
|
|
30
39
|
};
|
|
31
40
|
|
|
32
41
|
function ConfirmDialog({
|
|
@@ -78,6 +87,36 @@ function ConfirmDialog({
|
|
|
78
87
|
);
|
|
79
88
|
}
|
|
80
89
|
|
|
90
|
+
if (size === "md") {
|
|
91
|
+
return (
|
|
92
|
+
<Dialog {...props}>
|
|
93
|
+
{children}
|
|
94
|
+
<DialogContent className="sm:max-w-96">
|
|
95
|
+
<DialogHeader className="pb-4">
|
|
96
|
+
<DialogTitle>{title}</DialogTitle>
|
|
97
|
+
</DialogHeader>
|
|
98
|
+
{description != null ? (
|
|
99
|
+
<DialogDescription className="py-6 text-muted-foreground">{description}</DialogDescription>
|
|
100
|
+
) : null}
|
|
101
|
+
<DialogFooter className="pt-4">
|
|
102
|
+
<Button
|
|
103
|
+
variant="ghost"
|
|
104
|
+
onClick={() => {
|
|
105
|
+
onCancel?.();
|
|
106
|
+
props.onOpenChange?.(false);
|
|
107
|
+
}}
|
|
108
|
+
>
|
|
109
|
+
{cancelLabel}
|
|
110
|
+
</Button>
|
|
111
|
+
<Button variant={variant} disabled={confirmDisabled} onClick={onConfirm}>
|
|
112
|
+
{confirmLabel}
|
|
113
|
+
</Button>
|
|
114
|
+
</DialogFooter>
|
|
115
|
+
</DialogContent>
|
|
116
|
+
</Dialog>
|
|
117
|
+
);
|
|
118
|
+
}
|
|
119
|
+
|
|
81
120
|
return (
|
|
82
121
|
<AlertDialog {...props}>
|
|
83
122
|
{children}
|
package/app/README.md
DELETED
|
@@ -1,100 +0,0 @@
|
|
|
1
|
-
# App helpers (`@vvedantb/ui`)
|
|
2
|
-
|
|
3
|
-
Shared web React helpers that were duplicated across apps. Source-exported as the `./app` subpath of `@vvedantb/ui`.
|
|
4
|
-
|
|
5
|
-
## Install
|
|
6
|
-
|
|
7
|
-
```sh
|
|
8
|
-
npm install @vvedantb/ui
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
## Peers
|
|
12
|
-
|
|
13
|
-
Required: `react` and `react-dom` (>=19). Optional peers of `@vvedantb/ui`, needed only for the app helpers: `@clerk/clerk-react` (`useStableAuth`), `@tanstack/react-hotkeys` and `zod`.
|
|
14
|
-
|
|
15
|
-
`sonner` is not a dependency. The update watcher takes the toast API as an option. The app source uses a local class join, which the root does not export (the root `cn` is the clsx and tailwind-merge one). Tailwind must scan `node_modules/@vvedantb/ui/app/src/**/*.{ts,tsx}` so the class names are generated, and the app needs the `@vvedantb/ui/tokens` names (`bg-surface-card`, `divide-separator`, `text-muted-foreground` and so on).
|
|
16
|
-
|
|
17
|
-
```css
|
|
18
|
-
@source "../node_modules/@vvedantb/ui/app/src/**/*.{ts,tsx}";
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
## Confirm skip (Alt-click)
|
|
22
|
-
|
|
23
|
-
```tsx
|
|
24
|
-
import { ConfirmSkipHint, skipConfirmTitle, useRequestConfirm } from "@vvedantb/ui";
|
|
25
|
-
|
|
26
|
-
const { request } = useRequestConfirm();
|
|
27
|
-
|
|
28
|
-
<DropdownMenuItem
|
|
29
|
-
title={skipConfirmTitle("Delete")}
|
|
30
|
-
onSelect={(event) => request(() => setOpen(true), () => remove(), event)}
|
|
31
|
-
>
|
|
32
|
-
Delete <ConfirmSkipHint />
|
|
33
|
-
</DropdownMenuItem>
|
|
34
|
-
```
|
|
35
|
-
|
|
36
|
-
- `useRequestConfirm` does not subscribe to Alt. It reads `getAltHeld()` when the request happens, so the menu owner does not re-render when Alt goes down. It returns `{ request }` only.
|
|
37
|
-
- `ConfirmSkipHint` stays mounted and gains a `hidden` class when Alt is not held, so an open Radix menu keeps a stable child tree.
|
|
38
|
-
- The Alt store resets when the last subscriber leaves, clears on blur and tab hide, and cancels a bare Alt keydown only inside `[role='menu']` or `[data-radix-menu-content]`.
|
|
39
|
-
- Also exported: `useAltHeld`, `getAltHeld`, `createAltHeldStore`, `bindToWindow`, `shouldSkipConfirm`, `requestConfirm`.
|
|
40
|
-
|
|
41
|
-
## Update available watcher
|
|
42
|
-
|
|
43
|
-
```ts
|
|
44
|
-
import { toast } from "sonner";
|
|
45
|
-
import { startUpdateAvailableWatcher } from "@vvedantb/ui";
|
|
46
|
-
|
|
47
|
-
useEffect(
|
|
48
|
-
() =>
|
|
49
|
-
startUpdateAvailableWatcher({
|
|
50
|
-
origin: window.location.origin,
|
|
51
|
-
toast,
|
|
52
|
-
closeConvex: () => void convex.close(),
|
|
53
|
-
enabled: !import.meta.env.DEV,
|
|
54
|
-
}),
|
|
55
|
-
[],
|
|
56
|
-
);
|
|
57
|
-
```
|
|
58
|
-
|
|
59
|
-
Options: `origin`, `toast`, `closeConvex?`, `pollMs?` (default 60000), `toastId?` (default `app-update-available`), `enabled?` (default true), `reload?` (default `window.location.reload`). On a changed asset fingerprint it shows a sticky "Update available" toast. Refresh calls `closeConvex` (errors ignored), then reloads. `fingerprintFromHtml` and `fetchDeployFingerprint` are exported too. The fingerprint looks for Vite `/assets/*.js` URLs in the index HTML.
|
|
60
|
-
|
|
61
|
-
## Settings chrome
|
|
62
|
-
|
|
63
|
-
```tsx
|
|
64
|
-
import { SettingsPage, SettingsSection, SettingsToggleRow } from "@vvedantb/ui";
|
|
65
|
-
|
|
66
|
-
<SettingsPage
|
|
67
|
-
title="Notifications"
|
|
68
|
-
layout={({ title, headerRight, toolbar, tabs, fillHeight, children }) => (
|
|
69
|
-
<PageContainer title={title} rightSection={headerRight} toolbar={toolbar} tabs={tabs} noScroll={fillHeight}>
|
|
70
|
-
{children}
|
|
71
|
-
</PageContainer>
|
|
72
|
-
)}
|
|
73
|
-
>
|
|
74
|
-
<SettingsSection title="Email" bodyVariant="list">
|
|
75
|
-
<SettingsToggleRow title="Weekly digest" action={<Switch />} />
|
|
76
|
-
</SettingsSection>
|
|
77
|
-
</SettingsPage>
|
|
78
|
-
```
|
|
79
|
-
|
|
80
|
-
Exports: `SettingsSection`, `SettingsField`, `SettingsStack`, `SettingsToggleRow`, `SettingsEmptyState` (icon is `ComponentType<{ size?: number; className?: string }>`), `SettingsPage`. `SettingsField` `layout`: `"stacked"` (default) puts the label above the control. `"horizontal"` renders one row with the label and description on the left and the control on the right. Without `layout`, `SettingsPage` renders a plain `div` with a heading and the optional slots.
|
|
81
|
-
|
|
82
|
-
## useStableAuth
|
|
83
|
-
|
|
84
|
-
```ts
|
|
85
|
-
import { useStableAuth } from "@vvedantb/ui"; // 2000 ms debounce, wraps Clerk useAuth
|
|
86
|
-
import { createUseStableAuth } from "@vvedantb/ui";
|
|
87
|
-
|
|
88
|
-
const useAuth = createUseStableAuth(useClerkAuth, { debounceMs: 3000 });
|
|
89
|
-
```
|
|
90
|
-
|
|
91
|
-
After a signed-in session, a drop to signed-out reports `isLoaded: false` for the debounce window so Convex does not cascade. State is module-level. `resetStableAuthSession()` clears it and is for tests only.
|
|
92
|
-
|
|
93
|
-
## Develop
|
|
94
|
-
|
|
95
|
-
```sh
|
|
96
|
-
pnpm --filter @vvedantb/ui typecheck
|
|
97
|
-
pnpm --filter @vvedantb/ui test
|
|
98
|
-
```
|
|
99
|
-
|
|
100
|
-
Source is in `app/src` and tests in `app/tests`. Publish steps are in the root `README.md`.
|
package/tokens/README.md
DELETED
|
@@ -1,98 +0,0 @@
|
|
|
1
|
-
# `@vvedantb/ui/tokens`
|
|
2
|
-
|
|
3
|
-
Design tokens and shared Tailwind v4 CSS for the vvedantb web apps. The CSS and Tailwind preset are subpaths of `@vvedantb/ui`; the native JS tokens are named exports of the root (`tokens`, `Tokens`). Source-exported: no build step. Paths in the `File` column are relative to `packages/ui/tokens/`.
|
|
4
|
-
|
|
5
|
-
## Exports
|
|
6
|
-
|
|
7
|
-
| Export | File | What it is |
|
|
8
|
-
| --- | --- | --- |
|
|
9
|
-
| `@vvedantb/ui/tokens`, `@vvedantb/ui/tokens/tokens.css` | `src/tokens.css` | Colour, radius, shadow, ease and font tokens (`@theme`), light/dark variables, `dark` variant, `*` border and `body` defaults. In 0.2.1 it also defines shadcn-style aliases (`primary`, `muted-foreground`, `secondary`, `destructive`, `card`, `popover`, `input`, `ring`) that point at the same tokens. |
|
|
10
|
-
| `tokens` and `Tokens` from `@vvedantb/ui` | `src/native.ts` | JS colours, radii and spacing for React Native. `@vvedantb/native-ui` keeps its own copy in `src/tokens.ts`; a test keeps the two equal. |
|
|
11
|
-
| `@vvedantb/ui/tokens/css/base.css` | `src/css/base.css` | `html` touch/accent, `::selection`, control transitions, pointer cursor, range accent (`@layer base`). |
|
|
12
|
-
| `@vvedantb/ui/tokens/css/dialog.css` | `src/css/dialog.css` | Unlayered `max-width: none` for `@vvedantb/ui` compact (bottom-sheet) dialogs. |
|
|
13
|
-
| `@vvedantb/ui/tokens/css/modal.css` | `src/css/modal.css` | `.t-modal`, `.is-open`, `.is-closing` and `t-modal-presence-wait` (`@layer components`). |
|
|
14
|
-
| `@vvedantb/ui/tokens/css/tabs.css` | `src/css/tabs.css` | `.t-tab`, active colour, `.t-tabs-pill`, small-screen `.t-tabs` scrolling. |
|
|
15
|
-
| `@vvedantb/ui/tokens/css/tabs-pills.css` | `src/css/tabs-pills.css` | `--tabs-*` colour variables, `.t-tabs--segmented`, `.t-tabs--pills` and pill hover / active fills. |
|
|
16
|
-
| `@vvedantb/ui/tokens/css/utilities.css` | `src/css/utilities.css` | `@utility hit-target`, `@utility reveal-on-hover` and `@utility rounded-surface` (`clamp(0.75rem, var(--radius), 1rem)`). |
|
|
17
|
-
| `@vvedantb/ui/tokens/css/scrollbar-thin.css` | `src/css/scrollbar-thin.css` | `.scrollbar-thin` (`@layer utilities`, always emitted). |
|
|
18
|
-
| `@vvedantb/ui/tokens/css/animations.css` | `src/css/animations.css` | `animate-aurora`, `animate-fade-in-up`, `animate-indeterminate` as `@theme` (CSS-first apps). |
|
|
19
|
-
| `@vvedantb/ui/tokens/css/compat-shadcn-rgb.css`, `@vvedantb/ui/tokens/compat/shadcn-rgb.css` | `src/css/compat-shadcn-rgb.css` | Replaces `tokens.css` for apps with shadcn-style `R G B` channel variables. Defines only the UI-only `--color-*` names as `rgb(var(--x) / alpha)` references, `--radius-field`, `--scrollbar`, `--field-radius` and a `glass-panel-strong` fallback. Import it **or** `tokens.css`, never both. |
|
|
20
|
-
| `@vvedantb/ui/tokens/css/index.css` | `src/css/index.css` | base + dialog + utilities + scrollbar-thin + animations, for new CSS-first apps. |
|
|
21
|
-
| `@vvedantb/ui/tokens/tailwind-preset` | `src/tailwind-preset.mjs` (+ `.d.mts`) | Tailwind preset for apps that load a JS config with `@config`. |
|
|
22
|
-
|
|
23
|
-
Every file was extracted because the same rule (same at-rule context, selector and body) sits in 3 or more of the five apps. The measured duplication is in `verify/ANALYSIS.md`, and the proof that each app compiles to the same CSS after migrating is in `verify/RESULTS.md`. Blocks that only 2 apps share, or that drift in a way that would change an app's CSS, stay in the apps; `verify/ANALYSIS.md` lists them.
|
|
24
|
-
|
|
25
|
-
## Use
|
|
26
|
-
|
|
27
|
-
CSS-first app (no `tailwind.config`):
|
|
28
|
-
|
|
29
|
-
```css
|
|
30
|
-
@import "tailwindcss";
|
|
31
|
-
@import "@vvedantb/ui/tokens";
|
|
32
|
-
@import "@vvedantb/ui/tokens/css/animations.css";
|
|
33
|
-
@import "@vvedantb/ui/tokens/css/base.css";
|
|
34
|
-
/* ...app @layer base rules... */
|
|
35
|
-
@import "@vvedantb/ui/tokens/css/modal.css";
|
|
36
|
-
@import "@vvedantb/ui/tokens/css/tabs.css";
|
|
37
|
-
/* ...app @layer components rules... */
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
App with a JS config (`@config "../tailwind.config.ts"`):
|
|
41
|
-
|
|
42
|
-
```ts
|
|
43
|
-
import { tokensPreset } from "@vvedantb/ui/tokens/tailwind-preset";
|
|
44
|
-
|
|
45
|
-
export default {
|
|
46
|
-
presets: [tokensPreset()],
|
|
47
|
-
// or tokensPreset({ color: (name) => `color-mix(in oklch, var(--${name}) calc(<alpha-value> * 100%), transparent)` })
|
|
48
|
-
content: ["./src/**/*.{ts,tsx}"],
|
|
49
|
-
theme: { extend: { /* app-only colours, fonts, animations */ } },
|
|
50
|
-
plugins: [tailwindcssAnimate],
|
|
51
|
-
};
|
|
52
|
-
```
|
|
53
|
-
|
|
54
|
-
The preset holds `darkMode: "class"`, the shared colour map (`border`, `surface.*`, `danger.*`, `field.*`, shadcn aliases `primary`/`secondary`/`destructive`/`card`/`popover`/`input` ...), `borderRadius` lg/md/sm/field, `boxShadow` soft/panel/insetSoft, `ease-smooth`, `screens` xs to 2xl in px, and the aurora / fade-in-up / indeterminate / accordion keyframes. It does not hold plugins, `content`, fonts, `accent`/`muted`/`ring`/`sidebar` (they differ per app) or accordion timings.
|
|
55
|
-
|
|
56
|
-
Do not import `css/animations.css` in an app that uses the preset: the preset already defines the same keyframes and animations.
|
|
57
|
-
|
|
58
|
-
### Where to put the imports
|
|
59
|
-
|
|
60
|
-
Tailwind inlines an `@import` where it sits, even in the middle of a file (it must be at top level, not inside an `@layer` block). Put each import where the app's own copy of the rules was. Within one layer, later rules win at equal specificity, so moving shared rules above or below app rules can flip the result for elements matched by both. `examples/migration.md` gives the exact position for each app, and `pnpm --filter @vvedantb/ui verify` checks it.
|
|
61
|
-
|
|
62
|
-
### Variables each file needs
|
|
63
|
-
|
|
64
|
-
| File | Needs | Provided by |
|
|
65
|
-
| --- | --- | --- |
|
|
66
|
-
| `base.css` | `--accent`, `--foreground` | tokens.css or the app theme |
|
|
67
|
-
| `dialog.css` | none | |
|
|
68
|
-
| `modal.css` | `--modal-open-dur`, `--modal-close-dur`, `--modal-scale`, `--modal-scale-close`, `--modal-ease` | app `:root` |
|
|
69
|
-
| `tabs.css` | `--tabs-dur`, `--tabs-ease` (app `:root`); `--tabs-text-muted`, `--tabs-text-active`, `--tabs-pill-bg` | colours: tabs-pills.css or the app theme |
|
|
70
|
-
| `tabs-pills.css` | `--muted`, `--segment`, `--segment-foreground`, `--default` | tokens.css or the app theme |
|
|
71
|
-
| `utilities.css` | `--breakpoint-sm` (Tailwind default or app theme) | Tailwind |
|
|
72
|
-
| `scrollbar-thin.css` | `--scrollbar` | tokens.css or the app theme |
|
|
73
|
-
| `animations.css` | none | |
|
|
74
|
-
| `tailwind-preset` | the CSS variables named in its colour map, `--radius`, `--field-radius` | tokens.css or the app theme |
|
|
75
|
-
|
|
76
|
-
### Using an existing shadcn RGB theme
|
|
77
|
-
|
|
78
|
-
See the package `README.md`. With the compat file, `base.css`, `scrollbar-thin.css`, `utilities.css`, `dialog.css`, `modal.css` and `tabs.css` need no `tokens.css`. `base.css` reads `--accent` and `--foreground` and `tabs-pills.css` reads `--muted`, `--segment` and `--default`. Those are not channel-compatible, so skip `tabs-pills.css` and `index.css` (which includes `base.css`) unless the app defines those variables as full colours.
|
|
79
|
-
|
|
80
|
-
### Parameters
|
|
81
|
-
|
|
82
|
-
Where apps share a rule but drifted in one value, the value is a custom property whose fallback is the most common value. Set it on `:root` to keep a different value.
|
|
83
|
-
|
|
84
|
-
| File | Property | Default | Set by |
|
|
85
|
-
| --- | --- | --- | --- |
|
|
86
|
-
| `base.css` | `--tokens-control-transition-property` | `background-color, border-color, color, box-shadow, transform, opacity` | app-c: `background-color, color, transform, opacity` |
|
|
87
|
-
| `base.css` | `--tokens-control-transition-duration` | `240ms` | app-c: `100ms` |
|
|
88
|
-
|
|
89
|
-
## Develop
|
|
90
|
-
|
|
91
|
-
```sh
|
|
92
|
-
pnpm --filter @vvedantb/ui build # export targets exist + tsc (primitives, shell, app)
|
|
93
|
-
pnpm --filter @vvedantb/ui test # vitest (app helpers) + offline node --test: exports, CSS structure, Tailwind compile, preset
|
|
94
|
-
pnpm --filter @vvedantb/ui analyze # rule-level duplication across the app clones -> verify/ANALYSIS.tables.md
|
|
95
|
-
pnpm --filter @vvedantb/ui verify # before/after compile of every app -> verify/RESULTS.md, examples/migration.md
|
|
96
|
-
```
|
|
97
|
-
|
|
98
|
-
`analyze` and `verify` need the app clones (`APPS_DIR`, default `/workspace/cvx`; name or symlink the clones `app-a` to `app-e` inside it) and network access the first time: they install Tailwind 4.3.3, the plugins, postcss and jiti into a scratch directory (`VERIFY_DIR`, default `/workspace/pk-tokens-verify`, outside the repo). The migration for each app is data in `verify/migrations/<app>.json`. Each removed block must equal the shared file's block with the same context and selector, or the run fails.
|