@vvedantb/ui 0.19.1 → 0.20.0

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 CHANGED
@@ -872,10 +872,28 @@ One-plan upgrade dialog. Props: `open`, `onClose`, `title` (accessible, hidden),
872
872
  otherwise it sits in `VisuallyHidden`), `logo` (`dark` and `light` image URLs,
873
873
  shown in that colour mode), `wordmark`, `price`, `tagline`,
874
874
  `taglineFontClassName`, `features`, `ctaLabel` (default "Get Pro"),
875
- `renderCheckout(button)` (wrap the button in the billing provider's checkout),
875
+ `renderCheckout(button, period)` (wrap the button in the billing provider's checkout),
876
876
  `closeButton` (an extra compact close button, default `false`) and `tone`
877
877
  (`"muted"` default or `"muted-foreground"`).
878
878
 
879
+ From 0.20.0, `yearly={{ pricePerMonth, total?, saveLabel? }}` adds a
880
+ monthly/yearly toggle; `price` stays the monthly price. Control the period with
881
+ `billingPeriod` and `onBillingPeriodChange`, or set the start with
882
+ `defaultBillingPeriod` (`"month"` default). `renderCheckout` gets the selected
883
+ `period` (`"month"` or `"year"`) as its second argument, for Clerk's
884
+ `planPeriod`. Without `yearly` the DOM is unchanged.
885
+
886
+ ```tsx
887
+ <PricingModal
888
+ price="$10"
889
+ yearly={{ pricePerMonth: "$8.33", total: "$100" }}
890
+ renderCheckout={(button, period) => (
891
+ <CheckoutButton planId={planId} planPeriod={period}>{button}</CheckoutButton>
892
+ )}
893
+ /* ... */
894
+ />
895
+ ```
896
+
879
897
  ### Account menu items and rail collapse tile
880
898
 
881
899
  `SidebarAccountMenu` takes three optional props. Without them it renders as before.
package/app/README.md ADDED
@@ -0,0 +1,259 @@
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` used by the app helpers: `@clerk/clerk-react` (`useStableAuth`, `ConvexClerkProvider`), `convex` (`ConvexClerkProvider`, `useEnsureUser`), `@tanstack/react-hotkeys` and `zod` (your `z` for `parseClientEnv`). The root imports Clerk and `convex/react` statically, so they must be installed even if you do not use these helpers; see the package README.
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`.
101
+
102
+ ## Theme
103
+
104
+ ```tsx
105
+ import { createThemeProvider } from "@vvedantb/ui";
106
+
107
+ // One kit per app, at module level.
108
+ export const { ThemeProvider, useTheme } = createThemeProvider();
109
+
110
+ <ThemeProvider attribute="class" defaultTheme="system" enableSystem disableTransitionOnChange>
111
+ <App />
112
+ </ThemeProvider>;
113
+
114
+ const { theme, resolvedTheme, setTheme, isDark, toggleTheme, mounted } = useTheme();
115
+ ```
116
+
117
+ `createThemeProvider` is a port of next-themes 0.4.6. An app that uses next-themes can switch without a change in behaviour: the same localStorage writes, `<html>` classes and attributes, `style.colorScheme`, `prefers-color-scheme` listener, cross-tab `storage` sync and transition blocking. Parity tests run both side by side.
118
+
119
+ - Props, as in next-themes: `storageKey` (`"theme"`), `defaultTheme` (`"system"` with `enableSystem`, else `"light"`), `enableSystem` (`true`), `enableColorScheme` (`true`), `attribute` (`"data-theme"`; `"class"`, any `data-*`, or an array), `themes` (`["light", "dark"]`), `value` (theme name to written value), `forcedTheme`, `disableTransitionOnChange` (`false`) and `nonce`.
120
+ - State: `theme`, `setTheme` (a value or a function of the current theme), `resolvedTheme`, `systemTheme`, `forcedTheme` and `themes`, as in next-themes. Added: `mounted` (after the provider's first effect), `isDark` (`mounted && resolvedTheme === "dark"`) and `toggleTheme` (from `resolvedTheme`).
121
+ - `setTheme` is a new function each time `theme` changes and stable otherwise, as in next-themes, so effects that list it re-run at the same times.
122
+ - next-themes reads the DOM options (`attribute`, `themes`, `value`, `enableSystem`, `enableColorScheme`, `defaultTheme`, `disableTransitionOnChange`, `nonce`) once, on the first render, and so does this port. If `enableSystem` starts `false` and later turns `true`, a stored `"system"` is written as the class `system`. `forcedTheme` follows props.
123
+ - A nested `ThemeProvider` from the same kit renders only its children.
124
+ - `createThemeProvider({ missingProviderMessage })`: `useTheme()` outside the provider throws that message. Without it, `useTheme()` returns an empty state with no-op setters, as next-themes does.
125
+ - No inline script is rendered. next-themes renders one for server rendering; React does not run it in a client-rendered app. Keep a pre-paint script in `index.html` if the app has one.
126
+
127
+ For an app with its own theme state (for example a theme synced from the server), two helpers:
128
+
129
+ - `getSystemTheme()`: `"dark"` or `"light"` from `prefers-color-scheme`; `"light"` without `window`.
130
+ - `applyThemeClass(theme)`: removes `light` and `dark` from `<html>`, then adds `theme`. No-op without `document`.
131
+
132
+ ## Page title
133
+
134
+ ```tsx
135
+ import { createPageTitleContext } from "@vvedantb/ui";
136
+
137
+ export const { PageTitleProvider, usePageTitle, usePageTitleSync } = createPageTitleContext({
138
+ missingProviderMessage: "usePageTitle must be used within a PageTitleProvider",
139
+ });
140
+
141
+ // The shell reads it:
142
+ const { pageTitle } = usePageTitle();
143
+ // A page publishes it while mounted:
144
+ usePageTitleSync(title);
145
+ ```
146
+
147
+ - `usePageTitle()` returns `{ pageTitle, setPageTitle, mobileActionsSlot, setMobileActionsSlot }`. `mobileActionsSlot` is an element a mobile top bar registers (pass `setMobileActionsSlot` as its `ref`) so pages can portal actions into it.
148
+ - `usePageTitleSync(title)` sets the title while the caller is mounted and clears it on unmount. Titles that are not strings publish `""`.
149
+ - `missingProviderMessage`: `usePageTitle()` outside the provider throws it. Without it, `usePageTitle()` returns an empty title and no-op setters.
150
+ - `documentTitle` (off by default; without it `document.title` is never touched): `{ suffix?, separator? = " · ", fallback? }`. While a page title is set, `document.title` is `` `${pageTitle}${separator}${suffix}` `` (just the page title without a suffix). While it is empty, `fallback`, else the title at mount. The mount-time title comes back on unmount.
151
+
152
+ ## Page motion
153
+
154
+ ```tsx
155
+ import { MotionConfig } from "motion/react";
156
+ import { PageMotionProvider, useDisablePageMotion } from "@vvedantb/ui";
157
+
158
+ <PageMotionProvider disabled={flags?.disablePageMotion === true} motionConfig={MotionConfig}>
159
+ <App />
160
+ </PageMotionProvider>;
161
+ ```
162
+
163
+ - Sets `html[data-page-motion]` to `"off"` or `"on"` in a layout effect. The attribute stays after unmount. From 0.15.0 `tokens.css` (through `tokens/css/motion.css`) ships the `"off"` rules: `.ui-page-enter`, `.ui-enter`, `.ui-enter-up` and `.ui-stagger` fade only, `animate-in` / `animate-out`, `.t-modal` and `.t-tabs-pill` stop transitioning, and view transitions stop.
164
+ - Renders `motionConfig` with `reducedMotion` `"always"` when disabled, else `"never"`.
165
+ - `useDisablePageMotion()`: the `disabled` value, `false` outside the provider.
166
+ - This module does not import `motion`. Pass `MotionConfig`, or an app component that wraps it, defined at module level, for example with `LazyMotion`:
167
+
168
+ ```tsx
169
+ function LazyMotionConfig({ reducedMotion, children }: PageMotionConfigProps) {
170
+ return (
171
+ <LazyMotion features={domAnimation}>
172
+ <MotionConfig reducedMotion={reducedMotion}>{children}</MotionConfig>
173
+ </LazyMotion>
174
+ );
175
+ }
176
+ ```
177
+
178
+ ## Compact relative time
179
+
180
+ ```ts
181
+ import { formatCompactRelativeTime } from "@vvedantb/ui";
182
+
183
+ formatCompactRelativeTime(createdAt, { justNow: "now" }); // "now", "5m", "3h", "2d", "4mo", "1y"
184
+ formatCompactRelativeTime(updatedAt, { calendar: true }); // "42s", ..., calendar months and years
185
+ ```
186
+
187
+ Pure TypeScript, no dependencies. Options:
188
+
189
+ - `now`: clock in ms, default `Date.now()`.
190
+ - `justNow`: returned for anything under a minute old, future times included. Without it the result is whole seconds (`"42s"`), and a future time gives `"0s"` or a negative count.
191
+ - `calendar`: `false` (default) counts elapsed time: a day is 24 hours, a month 30 days, a year 12 such months. `true` counts as `dayjs().diff(date, unit)` does: days by the local calendar across DST changes, and calendar months and years.
192
+
193
+ Strings are parsed with `new Date(string)`. dayjs parses a date-only string such as `"2026-03-01"` as local midnight, `new Date` as UTC midnight; numbers, `Date` objects and ISO strings with a time give the same result either way. An invalid date gives `"NaNy"` (`"0mo"` with `calendar`).
194
+
195
+ ## Convex provider, VITE env and ensure-user (0.10.0)
196
+
197
+ React and VITE env helpers for Convex apps. The non-React Convex helpers (`mapLoadedQuery`, `forEachLoadedQuery`, `updateAllCachedQueries`, `patchLoadedQuery`, `OptimisticStore`, `tempId`, `createMemoryOptimisticStore`) live in `@vvedantb/server`, so backend packages, tests and React Native can use them without loading this package.
198
+
199
+ ### `ConvexClerkProvider`
200
+
201
+ ```tsx
202
+ import { ConvexClerkProvider, useStableAuth } from "@vvedantb/ui";
203
+ import { ConvexReactClient } from "convex/react";
204
+
205
+ const convex = new ConvexReactClient(env.VITE_CONVEX_URL);
206
+
207
+ <ClerkProvider publishableKey={env.VITE_CLERK_PUBLISHABLE_KEY}>
208
+ <ConvexClerkProvider client={convex} useAuth={useStableAuth}>
209
+ <App />
210
+ </ConvexClerkProvider>
211
+ </ClerkProvider>;
212
+ ```
213
+
214
+ | Props | Renders |
215
+ | --- | --- |
216
+ | `client` is `null` or `undefined` | `children` alone (no provider). |
217
+ | `clerk={false}` | `<ConvexProvider client={client}>`. |
218
+ | otherwise | `<ConvexProviderWithClerk client={client} useAuth={useAuth}>`; `useAuth` defaults to `@clerk/clerk-react`'s. |
219
+
220
+ `clerk` defaults to `true`. Render it inside `ClerkProvider` unless `clerk` is `false`. Types: `ConvexClerkProviderProps`, `ConvexClerkUseAuth`.
221
+
222
+ ### `parseClientEnv`
223
+
224
+ ```ts
225
+ import { z } from "zod";
226
+ import { parseClientEnv } from "@vvedantb/ui";
227
+
228
+ export const clientEnv = parseClientEnv(import.meta.env, { z, viteEnv: "fallback" });
229
+ // { VITE_CONVEX_URL: string; VITE_CLERK_PUBLISHABLE_KEY: string; VITE_ENV: "development" | "staging" | "production" }
230
+
231
+ export const extensionEnv = parseClientEnv(import.meta.env, {
232
+ z,
233
+ viteEnv: false,
234
+ extend: { VITE_CLERK_SYNC_HOST: z.string().url() },
235
+ });
236
+ ```
237
+
238
+ The schema is `z.object({ VITE_CONVEX_URL: z.string().min(1), VITE_CLERK_PUBLISHABLE_KEY: z.string().min(1), VITE_ENV: z.enum(["development", "staging", "production"]), ...extend })`, built with your `z` (zod 3.25+ or 4; the package never imports zod at runtime). Only the schema's keys are read from `rawEnv`. Failure throws the `ZodError` from `.parse`.
239
+
240
+ | `viteEnv` | `VITE_ENV` |
241
+ | --- | --- |
242
+ | `"strict"` (default) | Must be one of `VITE_ENV_NAMES`. |
243
+ | `"fallback"` | Any other value, or none, becomes `"development"` before parsing. |
244
+ | `false` | Not in the schema or the result. |
245
+
246
+ Types: `ClientEnv`, `ClientEnvWithoutViteEnv`, `ClientEnvOptions`, `ClientEnvSource`, `ViteEnvMode`, `ViteEnvName`.
247
+
248
+ ### `useEnsureUser`
249
+
250
+ ```tsx
251
+ function EnsureUser() {
252
+ useEnsureUser(api.users.ensureUserExists);
253
+ return null;
254
+ }
255
+ ```
256
+
257
+ Calls `mutation({})` every time `useConvexAuth().isAuthenticated` becomes `true` (once on mount if already signed in), and logs a rejection with `console.error`. Needs a Convex auth provider above it (`ConvexClerkProvider` with Clerk on). Pair it with `ensureUser` from `@vvedantb/server`. Type: `EnsureUserMutation`.
258
+
259
+ Tests: `app/tests/convex/` ports each app's copy and runs it beside the helper (env with zod 4 and zod 3.25; provider variants; ensure-user calls over auth sequences). `app/tests-node/convex-esm.test.mjs` loads the helpers in plain Node.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vvedantb/ui",
3
- "version": "0.19.1",
3
+ "version": "0.20.0",
4
4
  "license": "MIT",
5
5
  "description": "Shared React 19 UI for web apps: one JavaScript entry (primitives, shell pieces, app helpers including the Convex and Clerk provider, VITE env parsing and ensure-user, artifact viewers over the @vvedantb/server artifacts core, native tokens), design-token CSS, shared Tailwind v4 CSS and a Tailwind preset.",
6
6
  "type": "module",
@@ -59,6 +59,15 @@
59
59
  "./src/ui/sonner.css",
60
60
  "./src/marketing/landing.css"
61
61
  ],
62
+ "scripts": {
63
+ "check:tokens": "node tokens/scripts/check-component-tokens.mjs",
64
+ "build": "node tokens/scripts/check-exports.mjs && node tokens/scripts/check-component-tokens.mjs && tsc -p tsconfig.json",
65
+ "typecheck": "tsc -p tsconfig.json && tsc -p tsconfig.consumer.json && tsc -p tsconfig.consumer-speech.json && tsc -p tokens/tsconfig.json",
66
+ "test": "node tokens/scripts/check-component-tokens.mjs && vitest run && node --test tokens/test/*.test.mjs app/tests-node/*.test.mjs",
67
+ "verify": "node tokens/scripts/check-component-tokens.mjs && node tokens/verify/run.mjs",
68
+ "analyze": "node tokens/verify/analyze.mjs",
69
+ "prepack": "node tokens/scripts/check-exports.mjs"
70
+ },
62
71
  "dependencies": {
63
72
  "@dnd-kit/core": "^6.3.1",
64
73
  "@dnd-kit/modifiers": "^9.0.0",
@@ -148,6 +157,7 @@
148
157
  "@tanstack/react-hotkeys": "^0.13.0",
149
158
  "@types/react": "^19.1.0",
150
159
  "@types/react-dom": "^19.1.0",
160
+ "@vvedantb/server": "workspace:*",
151
161
  "ai": "^5.0.0",
152
162
  "class-variance-authority": "^0.7.1",
153
163
  "clsx": "^2.1.1",
@@ -171,8 +181,7 @@
171
181
  "vaul": "^1.1.0",
172
182
  "vitest": "^3.2.0",
173
183
  "zod": "^4.0.0",
174
- "zod3": "npm:zod@^3.25.76",
175
- "@vvedantb/server": "0.8.1"
184
+ "zod3": "npm:zod@^3.25.76"
176
185
  },
177
186
  "peerDependenciesMeta": {
178
187
  "@clerk/clerk-react": {
@@ -193,13 +202,5 @@
193
202
  "@vvedantb/server": {
194
203
  "optional": true
195
204
  }
196
- },
197
- "scripts": {
198
- "check:tokens": "node tokens/scripts/check-component-tokens.mjs",
199
- "build": "node tokens/scripts/check-exports.mjs && node tokens/scripts/check-component-tokens.mjs && tsc -p tsconfig.json",
200
- "typecheck": "tsc -p tsconfig.json && tsc -p tsconfig.consumer.json && tsc -p tsconfig.consumer-speech.json && tsc -p tokens/tsconfig.json",
201
- "test": "node tokens/scripts/check-component-tokens.mjs && vitest run && node --test tokens/test/*.test.mjs app/tests-node/*.test.mjs",
202
- "verify": "node tokens/scripts/check-component-tokens.mjs && node tokens/verify/run.mjs",
203
- "analyze": "node tokens/verify/analyze.mjs"
204
205
  }
205
- }
206
+ }
package/src/index.ts CHANGED
@@ -289,7 +289,7 @@ export type { PricingModalTone, SiteFooterVariant } from "./marketing/marketing-
289
289
  export { SiteFooter } from "./marketing/SiteFooter";
290
290
  export type { SiteFooterLink, SiteFooterProps, SiteFooterSocial } from "./marketing/SiteFooter";
291
291
  export { PricingModal } from "./marketing/PricingModal";
292
- export type { PricingModalProps } from "./marketing/PricingModal";
292
+ export type { PricingModalPeriod, PricingModalProps } from "./marketing/PricingModal";
293
293
 
294
294
  // App helpers: confirm skip, update watcher, settings chrome, stable auth, Convex provider, VITE env and ensure-user.
295
295
  export * from "../app/src/index";
@@ -1,10 +1,12 @@
1
- import type { ReactElement, ReactNode } from "react";
1
+ import { useState, type ReactElement, type ReactNode } from "react";
2
2
  import { IconCheck, IconX } from "@tabler/icons-react";
3
3
  import { Button } from "../ui/button";
4
4
  import { Dialog, DialogContent, DialogDescription, DialogTitle } from "../ui/dialog";
5
5
  import { VisuallyHidden } from "../ui/visually-hidden";
6
6
  import { pricingModalClasses, type PricingModalTone } from "./marketing-classes";
7
7
 
8
+ export type PricingModalPeriod = "month" | "year";
9
+
8
10
  export type PricingModalProps = {
9
11
  open: boolean;
10
12
  /** Called when the dialog asks to close and by the `closeButton`. */
@@ -19,6 +21,21 @@ export type PricingModalProps = {
19
21
  wordmark: string;
20
22
  /** For example "$9". */
21
23
  price: string;
24
+ /** Adds a monthly/yearly toggle. Without it the modal is monthly only and `price` is the only price. */
25
+ yearly?: {
26
+ /** Yearly price per month, for example "$8.33". */
27
+ pricePerMonth: string;
28
+ /** Yearly total shown in the note, for example "$100". */
29
+ total?: string;
30
+ /** Badge on the yearly option. Default "Save 2 months". */
31
+ saveLabel?: string;
32
+ };
33
+ /** Selected period, when the parent controls it. Needs `yearly`. */
34
+ billingPeriod?: PricingModalPeriod;
35
+ /** Called with the period the user picks. */
36
+ onBillingPeriodChange?: (period: PricingModalPeriod) => void;
37
+ /** Initial period when `billingPeriod` is not set. Default `"month"`. */
38
+ defaultBillingPeriod?: PricingModalPeriod;
22
39
  tagline: ReactNode;
23
40
  /** Extra font class on the tagline, placed after `max-w-[28ch]`. */
24
41
  taglineFontClassName?: string;
@@ -26,8 +43,8 @@ export type PricingModalProps = {
26
43
  features: readonly string[];
27
44
  /** Label of the full-width checkout button. Default "Get Pro". */
28
45
  ctaLabel?: string;
29
- /** Wraps the checkout button, for example in the billing provider's checkout and signed-in gates. */
30
- renderCheckout: (button: ReactElement) => ReactNode;
46
+ /** Wraps the checkout button, for example in the billing provider's checkout and signed-in gates. `period` is the selected period, for `planPeriod`; it is always `"month"` without `yearly`. */
47
+ renderCheckout: (button: ReactElement, period: PricingModalPeriod) => ReactNode;
31
48
  /** Second, compact close button in the top-right corner. Default `false`. */
32
49
  closeButton?: boolean;
33
50
  /** Secondary text colour class. Default `"muted"`. */
@@ -43,6 +60,10 @@ export function PricingModal({
43
60
  logo,
44
61
  wordmark,
45
62
  price,
63
+ yearly,
64
+ billingPeriod,
65
+ onBillingPeriodChange,
66
+ defaultBillingPeriod = "month",
46
67
  tagline,
47
68
  taglineFontClassName,
48
69
  features,
@@ -52,6 +73,12 @@ export function PricingModal({
52
73
  tone = "muted",
53
74
  }: PricingModalProps) {
54
75
  const c = pricingModalClasses[tone];
76
+ const [localPeriod, setLocalPeriod] = useState<PricingModalPeriod>(defaultBillingPeriod);
77
+ const period: PricingModalPeriod = yearly ? (billingPeriod ?? localPeriod) : "month";
78
+ const selectPeriod = (next: PricingModalPeriod) => {
79
+ setLocalPeriod(next);
80
+ onBillingPeriodChange?.(next);
81
+ };
55
82
  const taglineClass = ["mt-4 max-w-[28ch]", taglineFontClassName, c.tagline].filter(Boolean).join(" ");
56
83
  return (
57
84
  <Dialog open={open} onOpenChange={(next) => !next && onClose()}>
@@ -87,9 +114,27 @@ export function PricingModal({
87
114
  </span>
88
115
  </div>
89
116
 
90
- <div className="mt-8 flex items-end gap-2">
117
+ {yearly ? (
118
+ <div role="group" aria-label="Billing period" className="mt-8 inline-flex rounded-lg bg-surface-tertiary p-0.5">
119
+ {(["month", "year"] as const).map((value) => (
120
+ <button
121
+ key={value}
122
+ type="button"
123
+ aria-pressed={period === value}
124
+ onClick={() => selectPeriod(value)}
125
+ className={`rounded-md px-3 py-1 text-xs font-medium transition-colors duration-100 ${
126
+ period === value ? "bg-segment text-segment-foreground" : "text-muted-foreground hover:text-foreground"
127
+ }`}
128
+ >
129
+ {value === "month" ? "Monthly" : `Yearly · ${yearly.saveLabel ?? "Save 2 months"}`}
130
+ </button>
131
+ ))}
132
+ </div>
133
+ ) : null}
134
+
135
+ <div className={yearly ? "mt-5 flex items-end gap-2" : "mt-8 flex items-end gap-2"}>
91
136
  <span className="text-5xl font-medium tabular-nums leading-none tracking-tight text-foreground">
92
- {price}
137
+ {yearly && period === "year" ? yearly.pricePerMonth : price}
93
138
  </span>
94
139
  <span className={c.period}>/ month</span>
95
140
  </div>
@@ -102,9 +147,14 @@ export function PricingModal({
102
147
  <Button size="lg" className="h-11 w-full rounded-xl">
103
148
  {ctaLabel}
104
149
  </Button>,
150
+ period,
105
151
  )}
106
152
 
107
- <p className={c.note}>Cancel anytime. Billed monthly.</p>
153
+ <p className={c.note}>
154
+ {period === "year"
155
+ ? `Cancel anytime. ${yearly?.total ? `${yearly.total} billed yearly.` : "Billed yearly."}`
156
+ : "Cancel anytime. Billed monthly."}
157
+ </p>
108
158
 
109
159
  <div className="mt-8">
110
160
  <p className={c.featuresHeading}>What you get</p>
@@ -0,0 +1,120 @@
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, the radius utilities `rounded-surface` (`clamp(0.75rem, var(--radius), 1rem)`), `rounded-menu-item` (`min(var(--radius), 0.5rem)`) and `rounded-control` (`min(var(--radius), 0.625rem)`) (0.7.1; `rounded-surface` was in `utilities.css` before), `*` border and `body` defaults. From 0.16.3 `--field-radius` (`rounded-field`) is `min(var(--radius), 0.625rem)`, the same cap as `rounded-control` (was `1.25rem`). 0.7.2 adds `--sidebar-accent` / `sidebar-accent` (sidebar nav row fill: light `var(--surface-tertiary)`, dark `oklch(22.64% 0 0)`). 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. From 0.15.0 it imports `clear-input.css`, `scrollbar-thin.css` and `motion.css`, sets the `--modal-*` and `--tabs-*` motion variables on `:root`, and defines `.glass-panel-strong` (`var(--overlay)`) and `.sidebar-section-label`. |
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-tabs` container (0.15.0), `.t-tab` with its press scale, 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` and `@utility reveal-on-hover`. `rounded-surface` moved to `tokens.css` in 0.7.1. |
17
+ | `@vvedantb/ui/tokens/css/scrollbar-thin.css` | `src/css/scrollbar-thin.css` | `.scrollbar-thin` (`@layer utilities`, always emitted). Imported by `tokens.css` from 0.15.0. |
18
+ | `@vvedantb/ui/tokens/css/clear-input.css` | `src/css/clear-input.css` | `ClearInput` layers (`.t-clear*`) and the `--clear-*` / `--glow-*` timings. Imported by `tokens.css`. From 0.15.1 the layers clip in `.t-clear-clip`, so `.t-clear` keeps the focus ring, and the placeholder layer only shows during `.is-clearing`. |
19
+ | `@vvedantb/ui/tokens/css/motion.css` | `src/css/motion.css` | `.ui-page-enter`, `.ui-enter`, `.ui-enter-up`, `.ui-stagger`, their keyframes and reduced-motion rules, and the `html[data-page-motion="off"]` overrides for `PageMotionProvider`. Imported by `tokens.css`. |
20
+ | `@vvedantb/ui/tokens/css/animations.css` | `src/css/animations.css` | `animate-aurora`, `animate-fade-in-up`, `animate-indeterminate` as `@theme` (CSS-first apps). |
21
+ | `@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` (both `min(var(--radius), 0.625rem)` from 0.16.3), the same three radius utilities as `tokens.css` and `.glass-panel-strong` (solid `--popover` from 0.15.0). Import it **or** `tokens.css`, never both. |
22
+ | `@vvedantb/ui/tokens/css/index.css` | `src/css/index.css` | base + dialog + modal + tabs + tabs-pills + utilities + animations + nav-icons, for new CSS-first apps (`tokens.css` brings scrollbar-thin). |
23
+ | `@vvedantb/ui/tokens/tailwind-preset` | `src/tailwind-preset.mjs` (+ `.d.mts`) | Tailwind preset for apps that load a JS config with `@config`. |
24
+
25
+ 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.
26
+
27
+ ## Use
28
+
29
+ CSS-first app (no `tailwind.config`):
30
+
31
+ ```css
32
+ @import "tailwindcss";
33
+ @import "@vvedantb/ui/tokens";
34
+ @import "@vvedantb/ui/tokens/css/animations.css";
35
+ @import "@vvedantb/ui/tokens/css/base.css";
36
+ /* ...app @layer base rules... */
37
+ @import "@vvedantb/ui/tokens/css/modal.css";
38
+ @import "@vvedantb/ui/tokens/css/tabs.css";
39
+ /* ...app @layer components rules... */
40
+ /* no --modal-* / --tabs-* needed: tokens.css sets them */
41
+ ```
42
+
43
+ App with a JS config (`@config "../tailwind.config.ts"`):
44
+
45
+ ```ts
46
+ import { tokensPreset } from "@vvedantb/ui/tokens/tailwind-preset";
47
+
48
+ export default {
49
+ presets: [tokensPreset()],
50
+ // or tokensPreset({ color: (name) => `color-mix(in oklch, var(--${name}) calc(<alpha-value> * 100%), transparent)` })
51
+ content: ["./src/**/*.{ts,tsx}"],
52
+ theme: { extend: { /* app-only colours, fonts, animations */ } },
53
+ plugins: [tailwindcssAnimate],
54
+ };
55
+ ```
56
+
57
+ 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.
58
+
59
+ Do not import `css/animations.css` in an app that uses the preset: the preset already defines the same keyframes and animations.
60
+
61
+ ### Where to put the imports
62
+
63
+ 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.
64
+
65
+ ### Variables each file needs
66
+
67
+ | File | Needs | Provided by |
68
+ | --- | --- | --- |
69
+ | `base.css` | `--accent`, `--foreground` | tokens.css or the app theme |
70
+ | `dialog.css` | none | |
71
+ | `modal.css` | `--modal-open-dur`, `--modal-close-dur`, `--modal-scale`, `--modal-scale-close`, `--modal-ease` | tokens.css (0.15.0), or app `:root` with the compat file |
72
+ | `tabs.css` | `--tabs-dur`, `--tabs-ease` (tokens.css, or app `:root` with the compat file); `--tabs-text-muted`, `--tabs-text-active`, `--tabs-pill-bg` | colours: tabs-pills.css or the app theme |
73
+ | `tabs-pills.css` | `--muted`, `--segment`, `--segment-foreground`, `--default` | tokens.css or the app theme |
74
+ | `utilities.css` | `--breakpoint-sm` (Tailwind default or app theme) | Tailwind |
75
+ | `scrollbar-thin.css` | `--scrollbar` | tokens.css or the app theme |
76
+ | `clear-input.css`, `motion.css` | none (own `:root` defaults) | |
77
+ | `animations.css` | none | |
78
+ | `tailwind-preset` | the CSS variables named in its colour map, `--radius`, `--field-radius` | tokens.css or the app theme |
79
+
80
+ ### Using an existing shadcn RGB theme
81
+
82
+ See the package `README.md`. With the compat file, `base.css`, `scrollbar-thin.css`, `clear-input.css`, `motion.css`, `utilities.css`, `dialog.css`, `modal.css` and `tabs.css` need no `tokens.css` (`modal.css` and `tabs.css` then need the `--modal-*` / `--tabs-*` values on the app `:root`). `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.
83
+
84
+ ### Parameters
85
+
86
+ 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.
87
+
88
+ | File | Property | Default | Set by |
89
+ | --- | --- | --- | --- |
90
+ | `base.css` | `--tokens-control-transition-property` | `background-color, border-color, color, box-shadow, transform, opacity` | app-c: `background-color, color, transform, opacity` |
91
+ | `base.css` | `--tokens-control-transition-duration` | `240ms` | app-c: `100ms` |
92
+
93
+ From 0.15.0 the files that moved out of the apps take `:root` variables too. Every rule is in a Tailwind layer, so an app rule for the same selector (unlayered, or later in the same layer) also wins.
94
+
95
+ | File | Property | Default |
96
+ | --- | --- | --- |
97
+ | `tokens.css` | `--modal-open-dur`, `--modal-close-dur` | `180ms`, `120ms` |
98
+ | `tokens.css` | `--modal-scale`, `--modal-scale-close` | `0.96`, `0.96` |
99
+ | `tokens.css` | `--modal-ease`, `--tabs-ease` | `cubic-bezier(0.22, 1, 0.36, 1)` |
100
+ | `tokens.css` | `--tabs-dur` | `200ms` |
101
+ | `tokens.css` | `--sidebar-section-label-mix`, `--sidebar-section-label-hover-mix` | `55%`, `80%` (share of `--muted`) |
102
+ | `scrollbar-thin.css` | `--scrollbar-thin-rest`, `--scrollbar-thin-hover` | `40%`, `80%` (share of `--scrollbar`) |
103
+ | `clear-input.css` | `--clear-dur`, `--clear-out-dur`, `--clear-in-dur` | `1000ms`, `400ms`, `400ms` |
104
+ | `clear-input.css` | `--clear-out-fly`, `--clear-in-fly` | `12px`, `12px` |
105
+ | `clear-input.css` | `--clear-out-ease`, `--clear-in-ease` | `cubic-bezier(0.22, 1, 0.36, 1)` |
106
+ | `clear-input.css` | `--glow-delay`, `--glow-peak-at`, `--glow-opacity`, `--glow-spread` | `50ms`, `0.15`, `0.85`, `1.5` |
107
+ | `motion.css` | `--ui-enter-ease` | `cubic-bezier(0.22, 1, 0.36, 1)` |
108
+ | `motion.css` | `--ui-page-enter-dur`, `--ui-enter-dur`, `--ui-enter-up-dur` | `160ms`, `200ms`, `220ms` |
109
+ | `motion.css` | `--ui-stagger-step` | `40ms` (children 1 to 8) |
110
+
111
+ ## Develop
112
+
113
+ ```sh
114
+ pnpm --filter @vvedantb/ui build # export targets exist + tsc (primitives, shell, app)
115
+ pnpm --filter @vvedantb/ui test # vitest (app helpers) + offline node --test: exports, CSS structure, Tailwind compile, preset
116
+ pnpm --filter @vvedantb/ui analyze # rule-level duplication across the app clones -> verify/ANALYSIS.tables.md
117
+ pnpm --filter @vvedantb/ui verify # before/after compile of every app -> verify/RESULTS.md, examples/migration.md
118
+ ```
119
+
120
+ `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.