@simpleapps-com/augur-web 2.2.10 → 2.2.11
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/EXPORTS.md +1 -1
- package/README.md +348 -0
- package/llms.txt +123 -1
- package/package.json +6 -6
package/EXPORTS.md
CHANGED
package/README.md
ADDED
|
@@ -0,0 +1,348 @@
|
|
|
1
|
+
# @simpleapps-com/augur-web
|
|
2
|
+
|
|
3
|
+
> Shared React UI components for Augur ecommerce sites (Radix + Tailwind)
|
|
4
|
+
|
|
5
|
+
> Auto-generated. Do not edit manually. Regenerate with: `pnpm run generate-exports`
|
|
6
|
+
|
|
7
|
+
Part of the **@simpleapps-com/augur-\*** platform. All packages use fixed versioning (same version number).
|
|
8
|
+
|
|
9
|
+
## Install
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
pnpm add @simpleapps-com/augur-web
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
### Peer Dependencies
|
|
16
|
+
|
|
17
|
+
`@radix-ui/react-accordion`, `@radix-ui/react-checkbox`, `@radix-ui/react-dialog`, `@radix-ui/react-dropdown-menu`, `@radix-ui/react-label`, `@radix-ui/react-navigation-menu`, `@radix-ui/react-popover`, `@radix-ui/react-radio-group`, `@radix-ui/react-select`, `@radix-ui/react-separator`, `@radix-ui/react-slot`, `@radix-ui/react-tabs`, `class-variance-authority`, `cmdk`, `react`, `react-dom`, `react-icons`, `tailwindcss`
|
|
18
|
+
|
|
19
|
+
## Entry Points
|
|
20
|
+
|
|
21
|
+
| Import | Description |
|
|
22
|
+
|--------|-------------|
|
|
23
|
+
| `@simpleapps-com/augur-web/accordion` | 4 exports, 0 types |
|
|
24
|
+
| `@simpleapps-com/augur-web/add-to-cart-button` | 1 exports, 1 types |
|
|
25
|
+
| `@simpleapps-com/augur-web/breadcrumb` | 7 exports, 0 types |
|
|
26
|
+
| `@simpleapps-com/augur-web/breadcrumbs` | 1 exports, 1 types |
|
|
27
|
+
| `@simpleapps-com/augur-web/button` | 2 exports, 1 types |
|
|
28
|
+
| `@simpleapps-com/augur-web/card` | 6 exports, 0 types |
|
|
29
|
+
| `@simpleapps-com/augur-web/checkbox` | 1 exports, 0 types |
|
|
30
|
+
| `@simpleapps-com/augur-web/input` | 1 exports, 1 types |
|
|
31
|
+
| `@simpleapps-com/augur-web/label` | 1 exports, 0 types |
|
|
32
|
+
| `@simpleapps-com/augur-web/list-view` | 1 exports, 0 types |
|
|
33
|
+
| `@simpleapps-com/augur-web/pagination` | 9 exports, 0 types |
|
|
34
|
+
| `@simpleapps-com/augur-web/price` | 3 exports, 4 types |
|
|
35
|
+
| `@simpleapps-com/augur-web/price-format` | 1 exports, 2 types |
|
|
36
|
+
| `@simpleapps-com/augur-web/radio-group` | 2 exports, 0 types |
|
|
37
|
+
| `@simpleapps-com/augur-web/select` | 10 exports, 0 types |
|
|
38
|
+
| `@simpleapps-com/augur-web/spinner` | 1 exports, 0 types |
|
|
39
|
+
| `@simpleapps-com/augur-web/table` | 8 exports, 0 types |
|
|
40
|
+
| `@simpleapps-com/augur-web/tabs` | 4 exports, 0 types |
|
|
41
|
+
| `@simpleapps-com/augur-web/textarea` | 1 exports, 1 types |
|
|
42
|
+
| `@simpleapps-com/augur-web/command` | 9 exports, 0 types |
|
|
43
|
+
| `@simpleapps-com/augur-web/dialog` | 10 exports, 0 types |
|
|
44
|
+
| `@simpleapps-com/augur-web/dropdown-menu` | 15 exports, 0 types |
|
|
45
|
+
| `@simpleapps-com/augur-web/navigation-menu` | 9 exports, 0 types |
|
|
46
|
+
| `@simpleapps-com/augur-web/popover` | 4 exports, 0 types |
|
|
47
|
+
| `@simpleapps-com/augur-web/separator` | 1 exports, 0 types |
|
|
48
|
+
| `@simpleapps-com/augur-web/skeleton` | 1 exports, 0 types |
|
|
49
|
+
| `@simpleapps-com/augur-web/form-field` | 1 exports, 1 types |
|
|
50
|
+
| `@simpleapps-com/augur-web/form-input` | 1 exports, 1 types |
|
|
51
|
+
| `@simpleapps-com/augur-web/form-select` | 1 exports, 1 types |
|
|
52
|
+
| `@simpleapps-com/augur-web/form-textarea` | 1 exports, 1 types |
|
|
53
|
+
| `@simpleapps-com/augur-web/financing-widget` | 1 exports, 3 types |
|
|
54
|
+
| `@simpleapps-com/augur-web/gtm` | 6 exports, 14 types |
|
|
55
|
+
| `@simpleapps-com/augur-web/mdx-components` | 1 exports, 0 types |
|
|
56
|
+
| `@simpleapps-com/augur-web/payment-modal` | 2 exports, 1 types |
|
|
57
|
+
| `@simpleapps-com/augur-web/quantity-input` | 1 exports, 1 types |
|
|
58
|
+
| `@simpleapps-com/augur-web/session-replay` | 1 exports, 2 types |
|
|
59
|
+
| `@simpleapps-com/augur-web/stock-label` | 1 exports, 4 types |
|
|
60
|
+
| `@simpleapps-com/augur-web/provider` | 1 exports, 1 types |
|
|
61
|
+
|
|
62
|
+
## Exports
|
|
63
|
+
|
|
64
|
+
### Analytics
|
|
65
|
+
|
|
66
|
+
| Export | Kind | Description |
|
|
67
|
+
|--------|------|-------------|
|
|
68
|
+
| `AnalyticsNoscript` | function | |
|
|
69
|
+
| `GtmNoscript` | const | |
|
|
70
|
+
| `useAnalytics` | function | |
|
|
71
|
+
| `useGtm` | const | |
|
|
72
|
+
|
|
73
|
+
### Auth & Context
|
|
74
|
+
|
|
75
|
+
| Export | Kind | Description |
|
|
76
|
+
|--------|------|-------------|
|
|
77
|
+
| `AnalyticsProvider` | function | |
|
|
78
|
+
| `GtmProvider` | const | |
|
|
79
|
+
| `SessionReplayScript` | function | Loads a session replay script with `lazyOnload` behavior. |
|
|
80
|
+
| `AugurSiteProvider` | function | Unified site provider that composes AugurHooksProvider with analytics |
|
|
81
|
+
|
|
82
|
+
### Cart
|
|
83
|
+
|
|
84
|
+
| Export | Kind | Description |
|
|
85
|
+
|--------|------|-------------|
|
|
86
|
+
| `AddToCartButton` | component | |
|
|
87
|
+
|
|
88
|
+
### Items & Categories
|
|
89
|
+
|
|
90
|
+
| Export | Kind | Description |
|
|
91
|
+
|--------|------|-------------|
|
|
92
|
+
| `AccordionItem` | component | |
|
|
93
|
+
| `BreadcrumbItem` | component | |
|
|
94
|
+
| `PaginationItem` | component | |
|
|
95
|
+
| `RadioGroupItem` | component | |
|
|
96
|
+
| `SelectItem` | component | |
|
|
97
|
+
| `CommandItem` | component | |
|
|
98
|
+
| `DropdownMenuCheckboxItem` | component | |
|
|
99
|
+
| `DropdownMenuItem` | component | |
|
|
100
|
+
| `DropdownMenuRadioItem` | component | |
|
|
101
|
+
| `NavigationMenuItem` | component | |
|
|
102
|
+
|
|
103
|
+
### Payment & Checkout
|
|
104
|
+
|
|
105
|
+
| Export | Kind | Description |
|
|
106
|
+
|--------|------|-------------|
|
|
107
|
+
| `PaymentModal` | function | |
|
|
108
|
+
|
|
109
|
+
### Pricing
|
|
110
|
+
|
|
111
|
+
| Export | Kind | Description |
|
|
112
|
+
|--------|------|-------------|
|
|
113
|
+
| `FormatPriceOptions` | value | |
|
|
114
|
+
| `PriceFormatConfig` | value | |
|
|
115
|
+
| `createPrice` | function | Factory that creates a `Price` component and a `formatPrice` function |
|
|
116
|
+
| `createFormatPrice` | function | Create a pure price-formatting function. Server-safe (no React dependency). |
|
|
117
|
+
|
|
118
|
+
### SEO & Structured Data
|
|
119
|
+
|
|
120
|
+
| Export | Kind | Description |
|
|
121
|
+
|--------|------|-------------|
|
|
122
|
+
| `BreadcrumbEllipsis` | const | |
|
|
123
|
+
| `BreadcrumbSeparator` | const | |
|
|
124
|
+
|
|
125
|
+
### Stock
|
|
126
|
+
|
|
127
|
+
| Export | Kind | Description |
|
|
128
|
+
|--------|------|-------------|
|
|
129
|
+
| `createStockLabel` | function | |
|
|
130
|
+
|
|
131
|
+
### UI Components
|
|
132
|
+
|
|
133
|
+
| Export | Kind | Description |
|
|
134
|
+
|--------|------|-------------|
|
|
135
|
+
| `Accordion` | component | |
|
|
136
|
+
| `AccordionContent` | component | |
|
|
137
|
+
| `AccordionTrigger` | component | |
|
|
138
|
+
| `Breadcrumb` | component | |
|
|
139
|
+
| `BreadcrumbLink` | component | |
|
|
140
|
+
| `BreadcrumbList` | component | |
|
|
141
|
+
| `BreadcrumbPage` | component | |
|
|
142
|
+
| `BreadCrumbs` | component | Breadcrumb navigation with optional JSON-LD structured data. |
|
|
143
|
+
| `Button` | component | Styled button with variant/size props. Supports polymorphism via `asChild`. |
|
|
144
|
+
| `Card` | component | |
|
|
145
|
+
| `CardContent` | component | |
|
|
146
|
+
| `CardDescription` | component | |
|
|
147
|
+
| `CardFooter` | component | |
|
|
148
|
+
| `CardHeader` | component | |
|
|
149
|
+
| `CardTitle` | component | |
|
|
150
|
+
| `Checkbox` | component | |
|
|
151
|
+
| `Input` | component | |
|
|
152
|
+
| `Label` | component | |
|
|
153
|
+
| `PaginationContent` | component | |
|
|
154
|
+
| `RadioGroup` | component | |
|
|
155
|
+
| `Select` | component | |
|
|
156
|
+
| `SelectContent` | component | |
|
|
157
|
+
| `SelectGroup` | component | |
|
|
158
|
+
| `SelectLabel` | component | |
|
|
159
|
+
| `SelectScrollDownButton` | component | |
|
|
160
|
+
| `SelectScrollUpButton` | component | |
|
|
161
|
+
| `SelectSeparator` | component | |
|
|
162
|
+
| `SelectTrigger` | component | |
|
|
163
|
+
| `SelectValue` | component | |
|
|
164
|
+
| `Table` | component | |
|
|
165
|
+
| `TableBody` | component | |
|
|
166
|
+
| `TableCaption` | component | |
|
|
167
|
+
| `TableCell` | component | |
|
|
168
|
+
| `TableFooter` | component | |
|
|
169
|
+
| `TableHead` | component | |
|
|
170
|
+
| `TableHeader` | component | |
|
|
171
|
+
| `TableRow` | component | |
|
|
172
|
+
| `Tabs` | component | |
|
|
173
|
+
| `TabsContent` | component | |
|
|
174
|
+
| `TabsList` | component | |
|
|
175
|
+
| `TabsTrigger` | component | |
|
|
176
|
+
| `Textarea` | component | |
|
|
177
|
+
| `Command` | component | |
|
|
178
|
+
| `CommandEmpty` | component | |
|
|
179
|
+
| `CommandGroup` | component | |
|
|
180
|
+
| `CommandInput` | component | |
|
|
181
|
+
| `CommandList` | component | |
|
|
182
|
+
| `CommandSeparator` | component | |
|
|
183
|
+
| `Dialog` | component | |
|
|
184
|
+
| `DialogClose` | component | |
|
|
185
|
+
| `DialogContent` | component | |
|
|
186
|
+
| `DialogDescription` | component | |
|
|
187
|
+
| `DialogOverlay` | component | |
|
|
188
|
+
| `DialogPortal` | component | |
|
|
189
|
+
| `DialogTitle` | component | |
|
|
190
|
+
| `DialogTrigger` | component | |
|
|
191
|
+
| `DropdownMenu` | component | |
|
|
192
|
+
| `DropdownMenuContent` | component | |
|
|
193
|
+
| `DropdownMenuGroup` | component | |
|
|
194
|
+
| `DropdownMenuLabel` | component | |
|
|
195
|
+
| `DropdownMenuPortal` | component | |
|
|
196
|
+
| `DropdownMenuRadioGroup` | component | |
|
|
197
|
+
| `DropdownMenuSeparator` | component | |
|
|
198
|
+
| `DropdownMenuSub` | component | |
|
|
199
|
+
| `DropdownMenuSubContent` | component | |
|
|
200
|
+
| `DropdownMenuSubTrigger` | component | |
|
|
201
|
+
| `DropdownMenuTrigger` | component | |
|
|
202
|
+
| `NavigationMenu` | component | |
|
|
203
|
+
| `NavigationMenuContent` | component | |
|
|
204
|
+
| `NavigationMenuIndicator` | component | |
|
|
205
|
+
| `NavigationMenuLink` | component | |
|
|
206
|
+
| `NavigationMenuList` | component | |
|
|
207
|
+
| `NavigationMenuTrigger` | component | |
|
|
208
|
+
| `NavigationMenuViewport` | component | |
|
|
209
|
+
| `Popover` | component | |
|
|
210
|
+
| `PopoverAnchor` | component | |
|
|
211
|
+
| `PopoverContent` | component | |
|
|
212
|
+
| `PopoverTrigger` | component | |
|
|
213
|
+
| `Separator` | component | |
|
|
214
|
+
| `FormField` | component | Base form layout: label + children + optional error message. |
|
|
215
|
+
| `FormInput` | component | Labeled text input with error display. Composes FormField + Input. |
|
|
216
|
+
| `FormSelect` | component | Labeled select dropdown with error display. Composes FormField + Select. |
|
|
217
|
+
| `FormTextarea` | component | Labeled textarea with error display. Composes FormField + Textarea. |
|
|
218
|
+
| `QuantityInput` | component | Numeric input with optional +/- stepper buttons for cart quantities. |
|
|
219
|
+
|
|
220
|
+
### Other
|
|
221
|
+
|
|
222
|
+
| Export | Kind | Description |
|
|
223
|
+
|--------|------|-------------|
|
|
224
|
+
| `buttonVariants` | const | CVA variants for the Button. Variants: default, destructive, outline, |
|
|
225
|
+
| `ListView` | const | Generic list renderer that maps an array through a render function. |
|
|
226
|
+
| `ListPagination` | const | |
|
|
227
|
+
| `Pagination` | const | |
|
|
228
|
+
| `PaginationEllipsis` | const | |
|
|
229
|
+
| `PaginationLink` | const | |
|
|
230
|
+
| `PaginationNext` | const | |
|
|
231
|
+
| `PaginationPrevious` | const | |
|
|
232
|
+
| `getPageNumbers` | function | Build an array of page numbers and ellipsis markers for pagination UI. |
|
|
233
|
+
| `Spinner` | const | Animated SVG loading spinner. Sizes: `sm` (12px), `md` (16px), `lg` (24px). |
|
|
234
|
+
| `CommandDialog` | const | |
|
|
235
|
+
| `CommandShortcut` | const | |
|
|
236
|
+
| `DialogFooter` | const | |
|
|
237
|
+
| `DialogHeader` | const | |
|
|
238
|
+
| `DropdownMenuShortcut` | const | |
|
|
239
|
+
| `navigationMenuTriggerStyle` | const | |
|
|
240
|
+
| `Skeleton` | function | |
|
|
241
|
+
| `FinancingWidget` | function | Loads a financing widget script on the pages where it's needed. |
|
|
242
|
+
| `getMDXComponents` | function | Returns a map of HTML element names to styled React components |
|
|
243
|
+
| `extractBin` | function | Extract a card BIN from a postMessage payload. |
|
|
244
|
+
|
|
245
|
+
## Examples
|
|
246
|
+
|
|
247
|
+
### BreadCrumbs
|
|
248
|
+
|
|
249
|
+
```tsx
|
|
250
|
+
import Link from "next/link";
|
|
251
|
+
<BreadCrumbs
|
|
252
|
+
links={[{ href: "/", text: "Home" }, { href: "/shop", text: "Shop" }]}
|
|
253
|
+
activeBreadcrumb="Widget"
|
|
254
|
+
linkComponent={Link}
|
|
255
|
+
baseUrl="https://example.com"
|
|
256
|
+
/>
|
|
257
|
+
```
|
|
258
|
+
|
|
259
|
+
### Button
|
|
260
|
+
|
|
261
|
+
```tsx
|
|
262
|
+
<Button variant="outline" size="sm">Cancel</Button>
|
|
263
|
+
<Button asChild><Link href="/shop">Browse</Link></Button>
|
|
264
|
+
```
|
|
265
|
+
|
|
266
|
+
### createPrice
|
|
267
|
+
|
|
268
|
+
```tsx
|
|
269
|
+
// lib/price.ts -- one-time site config
|
|
270
|
+
import { createPrice } from "@simpleapps-com/augur-web/price";
|
|
271
|
+
export const { Price, formatPrice } = createPrice({
|
|
272
|
+
currency: "USD",
|
|
273
|
+
zeroLabel: "Call for Price",
|
|
274
|
+
});
|
|
275
|
+
|
|
276
|
+
// components/ProductCard.tsx
|
|
277
|
+
<Price value={item.price1} uom={item.default_selling_unit} />
|
|
278
|
+
```
|
|
279
|
+
|
|
280
|
+
### FormInput
|
|
281
|
+
|
|
282
|
+
```tsx
|
|
283
|
+
<FormInput label="Email" name="email" type="email" required error={errors.email} />
|
|
284
|
+
```
|
|
285
|
+
|
|
286
|
+
### FormSelect
|
|
287
|
+
|
|
288
|
+
```tsx
|
|
289
|
+
<FormSelect
|
|
290
|
+
label="State"
|
|
291
|
+
name="state"
|
|
292
|
+
options={[{ label: "Texas", value: "TX" }]}
|
|
293
|
+
value={state}
|
|
294
|
+
onValueChange={setState}
|
|
295
|
+
/>
|
|
296
|
+
```
|
|
297
|
+
|
|
298
|
+
### FinancingWidget
|
|
299
|
+
|
|
300
|
+
```tsx
|
|
301
|
+
// On a product page
|
|
302
|
+
<FinancingWidget provider="timepayment" vendorCode="PVD5P" />
|
|
303
|
+
|
|
304
|
+
// With load callback
|
|
305
|
+
<FinancingWidget
|
|
306
|
+
provider="timepayment"
|
|
307
|
+
vendorCode="PVD5P"
|
|
308
|
+
onLoad={() => console.log("Financing ready")}
|
|
309
|
+
/>
|
|
310
|
+
```
|
|
311
|
+
|
|
312
|
+
### QuantityInput
|
|
313
|
+
|
|
314
|
+
```tsx
|
|
315
|
+
<QuantityInput value={qty} onChange={setQty} min={1} step={1} />
|
|
316
|
+
```
|
|
317
|
+
|
|
318
|
+
### SessionReplayScript
|
|
319
|
+
|
|
320
|
+
```tsx
|
|
321
|
+
// In layout.tsx
|
|
322
|
+
<SessionReplayScript provider="mouseflow" siteId="88d79cd5-..." />
|
|
323
|
+
|
|
324
|
+
// With 50% sampling
|
|
325
|
+
<SessionReplayScript provider="mouseflow" siteId="..." sampleRate={0.5} />
|
|
326
|
+
|
|
327
|
+
// Disabled in dev
|
|
328
|
+
<SessionReplayScript provider="hotjar" siteId="..." disabled={isDev} />
|
|
329
|
+
```
|
|
330
|
+
|
|
331
|
+
## Types
|
|
332
|
+
|
|
333
|
+
`AddToCartButtonProps`, `BreadCrumbsProps`, `ButtonProps`, `InputProps`, `CreatePriceResult`, `PriceClassNames`, `PriceConfig`, `PriceProps`, `FormatPriceOptions`, `PriceFormatConfig`, `TextareaProps`, `FormFieldProps`, `FormInputProps`, `FormSelectProps`, `FormTextareaProps`, `FinancingProvider`, `FinancingWidgetProps`, `UseFinancingResult`, `AnalyticsContextValue`, `AnalyticsNoscriptProps`, `AnalyticsProviderProps`, `AnalyticsStrategy`, `EcommerceEvent`, `EcommerceItem`, `EcommerceParams`, `GtmContextValue`, `GtmEcommerceEvent`, `GtmEcommerceParams`, `GtmItem`, `GtmNoscriptProps`, `GtmProviderProps`, `GtmStrategy`, `PaymentModalProps`, `QuantityInputProps`, `SessionReplayProvider`, `SessionReplayScriptProps`, `CreateStockLabelResult`, `StockLabelClassNames`, `StockLabelConfig`, `StockLabelProps`, `AugurSiteProviderProps`
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
## Related Packages
|
|
337
|
+
|
|
338
|
+
All packages use fixed versioning -- same version number across the platform.
|
|
339
|
+
|
|
340
|
+
| Package | Description |
|
|
341
|
+
|---------|-------------|
|
|
342
|
+
| `@simpleapps-com/augur-config` | Shared tooling configuration presets for Augur ecommerce sites |
|
|
343
|
+
| `@simpleapps-com/augur-core` | Universal foundation for Augur packages — proxy infrastructure, cache keys, method classification, shared types |
|
|
344
|
+
| `@simpleapps-com/augur-hooks` | Cross-platform React Query hooks and Zustand stores for Augur ecommerce sites |
|
|
345
|
+
| `@simpleapps-com/augur-mobile` | React Native/Expo adapters for Augur ecommerce apps (offline sync, biometrics, push) |
|
|
346
|
+
| `@simpleapps-com/augur-server` | Server-side utilities for Augur ecommerce sites (Redis caching, SDK helpers, auth) |
|
|
347
|
+
| `@simpleapps-com/augur-tailwind` | Shared Tailwind CSS v4 theme with HSL variables for Augur ecommerce sites |
|
|
348
|
+
| `@simpleapps-com/augur-utils` | Shared types, cache configuration, and utility functions for Augur ecommerce sites |
|
package/llms.txt
CHANGED
|
@@ -1,8 +1,30 @@
|
|
|
1
|
+
# Augur Platform Packages
|
|
2
|
+
|
|
3
|
+
This package is part of the @simpleapps-com/augur-* platform.
|
|
4
|
+
All packages use fixed versioning (same version number).
|
|
5
|
+
The proxy pattern (createServerQueryProxy) is the primary data fetching API.
|
|
6
|
+
Pure transform utilities bridge user-facing types to SDK params without breaking proxy type safety.
|
|
7
|
+
|
|
8
|
+
## Sibling packages
|
|
9
|
+
|
|
10
|
+
- @simpleapps-com/augur-config - Shared tooling configuration presets for Augur ecommerce sites
|
|
11
|
+
- @simpleapps-com/augur-core - Universal foundation for Augur packages — proxy infrastructure, cache keys, method classification, shared types
|
|
12
|
+
- @simpleapps-com/augur-hooks - Cross-platform React Query hooks and Zustand stores for Augur ecommerce sites
|
|
13
|
+
- @simpleapps-com/augur-mobile - React Native/Expo adapters for Augur ecommerce apps (offline sync, biometrics, push)
|
|
14
|
+
- @simpleapps-com/augur-server - Server-side utilities for Augur ecommerce sites (Redis caching, SDK helpers, auth)
|
|
15
|
+
- @simpleapps-com/augur-tailwind - Shared Tailwind CSS v4 theme with HSL variables for Augur ecommerce sites
|
|
16
|
+
- @simpleapps-com/augur-utils - Shared types, cache configuration, and utility functions for Augur ecommerce sites
|
|
17
|
+
- @simpleapps-com/augur-web (this package) - Shared React UI components for Augur ecommerce sites (Radix + Tailwind)
|
|
18
|
+
|
|
19
|
+
Each package ships its own llms.txt with exports and usage patterns.
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
|
|
1
23
|
# @simpleapps-com/augur-web
|
|
2
24
|
|
|
3
25
|
> Shared React UI components for Augur ecommerce sites (Radix + Tailwind)
|
|
4
26
|
|
|
5
|
-
Version: 2.
|
|
27
|
+
Version: 2.2.10
|
|
6
28
|
|
|
7
29
|
## @simpleapps-com/augur-web/accordion
|
|
8
30
|
|
|
@@ -31,12 +53,35 @@ Version: 2.0.21
|
|
|
31
53
|
- component: BreadCrumbs - Breadcrumb navigation with optional JSON-LD structured data.
|
|
32
54
|
- type: BreadCrumbsProps
|
|
33
55
|
|
|
56
|
+
### Examples
|
|
57
|
+
|
|
58
|
+
BreadCrumbs:
|
|
59
|
+
```tsx
|
|
60
|
+
import Link from "next/link";
|
|
61
|
+
<BreadCrumbs
|
|
62
|
+
links={[{ href: "/", text: "Home" }, { href: "/shop", text: "Shop" }]}
|
|
63
|
+
activeBreadcrumb="Widget"
|
|
64
|
+
linkComponent={Link}
|
|
65
|
+
baseUrl="https://example.com"
|
|
66
|
+
/>
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
|
|
34
70
|
## @simpleapps-com/augur-web/button
|
|
35
71
|
|
|
36
72
|
- component: Button - Styled button with variant/size props. Supports polymorphism via `asChild`.
|
|
37
73
|
- const: buttonVariants - CVA variants for the Button. Variants: default, destructive, outline,
|
|
38
74
|
- type: ButtonProps
|
|
39
75
|
|
|
76
|
+
### Examples
|
|
77
|
+
|
|
78
|
+
Button:
|
|
79
|
+
```tsx
|
|
80
|
+
<Button variant="outline" size="sm">Cancel</Button>
|
|
81
|
+
<Button asChild><Link href="/shop">Browse</Link></Button>
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
|
|
40
85
|
## @simpleapps-com/augur-web/card
|
|
41
86
|
|
|
42
87
|
- component: Card
|
|
@@ -85,6 +130,22 @@ Version: 2.0.21
|
|
|
85
130
|
- type: PriceConfig
|
|
86
131
|
- type: PriceProps
|
|
87
132
|
|
|
133
|
+
### Examples
|
|
134
|
+
|
|
135
|
+
createPrice:
|
|
136
|
+
```tsx
|
|
137
|
+
// lib/price.ts -- one-time site config
|
|
138
|
+
import { createPrice } from "@simpleapps-com/augur-web/price";
|
|
139
|
+
export const { Price, formatPrice } = createPrice({
|
|
140
|
+
currency: "USD",
|
|
141
|
+
zeroLabel: "Call for Price",
|
|
142
|
+
});
|
|
143
|
+
|
|
144
|
+
// components/ProductCard.tsx
|
|
145
|
+
<Price value={item.price1} uom={item.default_selling_unit} />
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
|
|
88
149
|
## @simpleapps-com/augur-web/price-format
|
|
89
150
|
|
|
90
151
|
- function: createFormatPrice - Create a pure price-formatting function. Server-safe (no React dependency).
|
|
@@ -216,11 +277,33 @@ Version: 2.0.21
|
|
|
216
277
|
- component: FormInput - Labeled text input with error display. Composes FormField + Input.
|
|
217
278
|
- type: FormInputProps
|
|
218
279
|
|
|
280
|
+
### Examples
|
|
281
|
+
|
|
282
|
+
FormInput:
|
|
283
|
+
```tsx
|
|
284
|
+
<FormInput label="Email" name="email" type="email" required error={errors.email} />
|
|
285
|
+
```
|
|
286
|
+
|
|
287
|
+
|
|
219
288
|
## @simpleapps-com/augur-web/form-select
|
|
220
289
|
|
|
221
290
|
- component: FormSelect - Labeled select dropdown with error display. Composes FormField + Select.
|
|
222
291
|
- type: FormSelectProps
|
|
223
292
|
|
|
293
|
+
### Examples
|
|
294
|
+
|
|
295
|
+
FormSelect:
|
|
296
|
+
```tsx
|
|
297
|
+
<FormSelect
|
|
298
|
+
label="State"
|
|
299
|
+
name="state"
|
|
300
|
+
options={[{ label: "Texas", value: "TX" }]}
|
|
301
|
+
value={state}
|
|
302
|
+
onValueChange={setState}
|
|
303
|
+
/>
|
|
304
|
+
```
|
|
305
|
+
|
|
306
|
+
|
|
224
307
|
## @simpleapps-com/augur-web/form-textarea
|
|
225
308
|
|
|
226
309
|
- component: FormTextarea - Labeled textarea with error display. Composes FormField + Textarea.
|
|
@@ -233,6 +316,22 @@ Version: 2.0.21
|
|
|
233
316
|
- type: FinancingWidgetProps
|
|
234
317
|
- type: UseFinancingResult
|
|
235
318
|
|
|
319
|
+
### Examples
|
|
320
|
+
|
|
321
|
+
FinancingWidget:
|
|
322
|
+
```tsx
|
|
323
|
+
// On a product page
|
|
324
|
+
<FinancingWidget provider="timepayment" vendorCode="PVD5P" />
|
|
325
|
+
|
|
326
|
+
// With load callback
|
|
327
|
+
<FinancingWidget
|
|
328
|
+
provider="timepayment"
|
|
329
|
+
vendorCode="PVD5P"
|
|
330
|
+
onLoad={() => console.log("Financing ready")}
|
|
331
|
+
/>
|
|
332
|
+
```
|
|
333
|
+
|
|
334
|
+
|
|
236
335
|
## @simpleapps-com/augur-web/gtm
|
|
237
336
|
|
|
238
337
|
- function: AnalyticsNoscript
|
|
@@ -271,12 +370,35 @@ Version: 2.0.21
|
|
|
271
370
|
- component: QuantityInput - Numeric input with optional +/- stepper buttons for cart quantities.
|
|
272
371
|
- type: QuantityInputProps
|
|
273
372
|
|
|
373
|
+
### Examples
|
|
374
|
+
|
|
375
|
+
QuantityInput:
|
|
376
|
+
```tsx
|
|
377
|
+
<QuantityInput value={qty} onChange={setQty} min={1} step={1} />
|
|
378
|
+
```
|
|
379
|
+
|
|
380
|
+
|
|
274
381
|
## @simpleapps-com/augur-web/session-replay
|
|
275
382
|
|
|
276
383
|
- function: SessionReplayScript - Loads a session replay script with `lazyOnload` behavior.
|
|
277
384
|
- type: SessionReplayProvider
|
|
278
385
|
- type: SessionReplayScriptProps
|
|
279
386
|
|
|
387
|
+
### Examples
|
|
388
|
+
|
|
389
|
+
SessionReplayScript:
|
|
390
|
+
```tsx
|
|
391
|
+
// In layout.tsx
|
|
392
|
+
<SessionReplayScript provider="mouseflow" siteId="88d79cd5-..." />
|
|
393
|
+
|
|
394
|
+
// With 50% sampling
|
|
395
|
+
<SessionReplayScript provider="mouseflow" siteId="..." sampleRate={0.5} />
|
|
396
|
+
|
|
397
|
+
// Disabled in dev
|
|
398
|
+
<SessionReplayScript provider="hotjar" siteId="..." disabled={isDev} />
|
|
399
|
+
```
|
|
400
|
+
|
|
401
|
+
|
|
280
402
|
## @simpleapps-com/augur-web/stock-label
|
|
281
403
|
|
|
282
404
|
- function: createStockLabel
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@simpleapps-com/augur-web",
|
|
3
|
-
"version": "2.2.
|
|
3
|
+
"version": "2.2.11",
|
|
4
4
|
"description": "Shared React UI components for Augur ecommerce sites (Radix + Tailwind)",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"repository": {
|
|
@@ -208,9 +208,9 @@
|
|
|
208
208
|
"llms.txt"
|
|
209
209
|
],
|
|
210
210
|
"dependencies": {
|
|
211
|
-
"@simpleapps-com/augur-core": "2.2.
|
|
212
|
-
"@simpleapps-com/augur-hooks": "2.2.
|
|
213
|
-
"@simpleapps-com/augur-utils": "2.2.
|
|
211
|
+
"@simpleapps-com/augur-core": "2.2.11",
|
|
212
|
+
"@simpleapps-com/augur-hooks": "2.2.11",
|
|
213
|
+
"@simpleapps-com/augur-utils": "2.2.11"
|
|
214
214
|
},
|
|
215
215
|
"peerDependencies": {
|
|
216
216
|
"@radix-ui/react-accordion": "^1.2.0",
|
|
@@ -260,8 +260,8 @@
|
|
|
260
260
|
"tsup": "^8.5.0",
|
|
261
261
|
"vitest": "^3.2.0",
|
|
262
262
|
"@augur-packages/tsconfig": "0.0.0",
|
|
263
|
-
"@simpleapps-com/augur-core": "2.2.
|
|
264
|
-
"@simpleapps-com/augur-hooks": "2.2.
|
|
263
|
+
"@simpleapps-com/augur-core": "2.2.11",
|
|
264
|
+
"@simpleapps-com/augur-hooks": "2.2.11"
|
|
265
265
|
},
|
|
266
266
|
"scripts": {
|
|
267
267
|
"build": "tsup",
|