@simpleapps-com/augur-web 2.4.0 → 2026.11.1

package/EXPORTS.md

@@ -1,9 +1,7 @@
 # @simpleapps-com/augur-web exports
 
-Version: 2.2.29
-
-> Auto-generated from built type declarations. Do not edit manually.
-> Regenerate with: `pnpm run generate-exports`
+> Generated from the package's build by `pnpm -C repo/sites/augur-build generate`. Do not edit by hand.
+> Guide: https://augur.build/docs/packages/augur-web
 
 ## `@simpleapps-com/augur-web/accordion`
 
@@ -16,10 +14,6 @@ Version: 2.2.29
 | `AccordionItem` | component |  |
 | `AccordionTrigger` | component |  |
 
-```ts
-import { Accordion, AccordionContent, AccordionItem } from "@simpleapps-com/augur-web/accordion";
-```
-
 ## `@simpleapps-com/augur-web/add-to-cart-button`
 
 ### Values
@@ -32,10 +26,6 @@ import { Accordion, AccordionContent, AccordionItem } from "@simpleapps-com/augu
 
 `AddToCartButtonProps`
 
-```ts
-import { AddToCartButton } from "@simpleapps-com/augur-web/add-to-cart-button";
-```
-
 ## `@simpleapps-com/augur-web/breadcrumb`
 
 ### Values
@@ -50,10 +40,6 @@ import { AddToCartButton } from "@simpleapps-com/augur-web/add-to-cart-button";
 | `BreadcrumbPage` | component |  |
 | `BreadcrumbSeparator` | const |  |
 
-```ts
-import { Breadcrumb, BreadcrumbEllipsis, BreadcrumbItem } from "@simpleapps-com/augur-web/breadcrumb";
-```
-
 ## `@simpleapps-com/augur-web/breadcrumbs`
 
 ### Values
@@ -66,10 +52,6 @@ import { Breadcrumb, BreadcrumbEllipsis, BreadcrumbItem } from "@simpleapps-com/
 
 `BreadCrumbsProps`
 
-```ts
-import { BreadCrumbs } from "@simpleapps-com/augur-web/breadcrumbs";
-```
-
 ## `@simpleapps-com/augur-web/button`
 
 ### Values
@@ -77,16 +59,12 @@ import { BreadCrumbs } from "@simpleapps-com/augur-web/breadcrumbs";
 | Export | Kind | Description |
 |--------|------|-------------|
 | `Button` | component | Styled button with variant/size props. Supports polymorphism via `asChild`. |
-| `buttonVariants` | const | CVA variants for the Button. Variants: default, destructive, outline, |
+| `buttonVariants` | const | CVA variants for the Button. Variants: default, destructive, outline, secondary, ghost, link. Sizes: default, sm, lg, icon. |
 
 ### Types
 
 `ButtonProps`
 
-```ts
-import { Button, buttonVariants } from "@simpleapps-com/augur-web/button";
-```
-
 ## `@simpleapps-com/augur-web/card`
 
 ### Values
@@ -100,10 +78,6 @@ import { Button, buttonVariants } from "@simpleapps-com/augur-web/button";
 | `CardHeader` | component |  |
 | `CardTitle` | component |  |
 
-```ts
-import { Card, CardContent, CardDescription } from "@simpleapps-com/augur-web/card";
-```
-
 ## `@simpleapps-com/augur-web/checkbox`
 
 ### Values
@@ -112,10 +86,6 @@ import { Card, CardContent, CardDescription } from "@simpleapps-com/augur-web/ca
 |--------|------|-------------|
 | `Checkbox` | component |  |
 
-```ts
-import { Checkbox } from "@simpleapps-com/augur-web/checkbox";
-```
-
 ## `@simpleapps-com/augur-web/input`
 
 ### Values
@@ -128,10 +98,6 @@ import { Checkbox } from "@simpleapps-com/augur-web/checkbox";
 
 `InputProps`
 
-```ts
-import { Input } from "@simpleapps-com/augur-web/input";
-```
-
 ## `@simpleapps-com/augur-web/label`
 
 ### Values
@@ -140,10 +106,6 @@ import { Input } from "@simpleapps-com/augur-web/input";
 |--------|------|-------------|
 | `Label` | component |  |
 
-```ts
-import { Label } from "@simpleapps-com/augur-web/label";
-```
-
 ## `@simpleapps-com/augur-web/list-view`
 
 ### Values
@@ -152,16 +114,13 @@ import { Label } from "@simpleapps-com/augur-web/label";
 |--------|------|-------------|
 | `ListView` | const | Generic list renderer that maps an array through a render function. |
 
-```ts
-import { ListView } from "@simpleapps-com/augur-web/list-view";
-```
-
 ## `@simpleapps-com/augur-web/pagination`
 
 ### Values
 
 | Export | Kind | Description |
 |--------|------|-------------|
+| `getPageNumbers` | function | Build an array of page numbers and ellipsis markers for pagination UI. |
 | `ListPagination` | const |  |
 | `Pagination` | const |  |
 | `PaginationContent` | component |  |
@@ -170,11 +129,6 @@ import { ListView } from "@simpleapps-com/augur-web/list-view";
 | `PaginationLink` | const |  |
 | `PaginationNext` | const |  |
 | `PaginationPrevious` | const |  |
-| `getPageNumbers` | function | Build an array of page numbers and ellipsis markers for pagination UI. |
-
-```ts
-import { ListPagination, Pagination, PaginationContent } from "@simpleapps-com/augur-web/pagination";
-```
 
 ## `@simpleapps-com/augur-web/price`
 
@@ -182,17 +136,11 @@ import { ListPagination, Pagination, PaginationContent } from "@simpleapps-com/a
 
 | Export | Kind | Description |
 |--------|------|-------------|
-| `FormatPriceOptions` | value |  |
-| `PriceFormatConfig` | value |  |
-| `createPrice` | function | Factory that creates a `Price` component and a `formatPrice` function |
+| `createPrice` | function | Factory that creates a `Price` component and a `formatPrice` function pre-configured with site-level currency/locale/precision. |
 
 ### Types
 
-`CreatePriceResult`, `PriceClassNames`, `PriceConfig`, `PriceProps`
-
-```ts
-import { FormatPriceOptions, PriceFormatConfig, createPrice } from "@simpleapps-com/augur-web/price";
-```
+`CreatePriceResult`, `FormatPriceOptions`, `PriceClassNames`, `PriceConfig`, `PriceFormatConfig`, `PriceProps`
 
 ## `@simpleapps-com/augur-web/price-format`
 
@@ -200,16 +148,12 @@ import { FormatPriceOptions, PriceFormatConfig, createPrice } from "@simpleapps-
 
 | Export | Kind | Description |
 |--------|------|-------------|
-| `createFormatPrice` | function | Create a pure price-formatting function. Server-safe (no React dependency). |
+| `createFormatPrice` | function | Create a pure price-formatting function. Server-safe (no React dependency). Use {@link createPrice} in client components for the full Price component. |
 
 ### Types
 
 `FormatPriceOptions`, `PriceFormatConfig`
 
-```ts
-import { createFormatPrice } from "@simpleapps-com/augur-web/price-format";
-```
-
 ## `@simpleapps-com/augur-web/radio-group`
 
 ### Values
@@ -219,10 +163,6 @@ import { createFormatPrice } from "@simpleapps-com/augur-web/price-format";
 | `RadioGroup` | component |  |
 | `RadioGroupItem` | component |  |
 
-```ts
-import { RadioGroup, RadioGroupItem } from "@simpleapps-com/augur-web/radio-group";
-```
-
 ## `@simpleapps-com/augur-web/resource-tabs`
 
 ### Values
@@ -235,10 +175,6 @@ import { RadioGroup, RadioGroupItem } from "@simpleapps-com/augur-web/radio-grou
 
 `ResourceTabsProps`, `TabDef`
 
-```ts
-import { ResourceTabs } from "@simpleapps-com/augur-web/resource-tabs";
-```
-
 ## `@simpleapps-com/augur-web/select`
 
 ### Values
@@ -256,10 +192,6 @@ import { ResourceTabs } from "@simpleapps-com/augur-web/resource-tabs";
 | `SelectTrigger` | component |  |
 | `SelectValue` | component |  |
 
-```ts
-import { Select, SelectContent, SelectGroup } from "@simpleapps-com/augur-web/select";
-```
-
 ## `@simpleapps-com/augur-web/spinner`
 
 ### Values
@@ -268,10 +200,6 @@ import { Select, SelectContent, SelectGroup } from "@simpleapps-com/augur-web/se
 |--------|------|-------------|
 | `Spinner` | const | Animated SVG loading spinner. Sizes: `sm` (12px), `md` (16px), `lg` (24px). |
 
-```ts
-import { Spinner } from "@simpleapps-com/augur-web/spinner";
-```
-
 ## `@simpleapps-com/augur-web/table`
 
 ### Values
@@ -287,10 +215,6 @@ import { Spinner } from "@simpleapps-com/augur-web/spinner";
 | `TableHeader` | component |  |
 | `TableRow` | component |  |
 
-```ts
-import { Table, TableBody, TableCaption } from "@simpleapps-com/augur-web/table";
-```
-
 ## `@simpleapps-com/augur-web/tabs`
 
 ### Values
@@ -302,10 +226,6 @@ import { Table, TableBody, TableCaption } from "@simpleapps-com/augur-web/table"
 | `TabsList` | component |  |
 | `TabsTrigger` | component |  |
 
-```ts
-import { Tabs, TabsContent, TabsList } from "@simpleapps-com/augur-web/tabs";
-```
-
 ## `@simpleapps-com/augur-web/textarea`
 
 ### Values
@@ -318,10 +238,6 @@ import { Tabs, TabsContent, TabsList } from "@simpleapps-com/augur-web/tabs";
 
 `TextareaProps`
 
-```ts
-import { Textarea } from "@simpleapps-com/augur-web/textarea";
-```
-
 ## `@simpleapps-com/augur-web/command`
 
 ### Values
@@ -338,10 +254,6 @@ import { Textarea } from "@simpleapps-com/augur-web/textarea";
 | `CommandSeparator` | component |  |
 | `CommandShortcut` | const |  |
 
-```ts
-import { Command, CommandDialog, CommandEmpty } from "@simpleapps-com/augur-web/command";
-```
-
 ## `@simpleapps-com/augur-web/confirm-dialog`
 
 ### Values
@@ -354,10 +266,6 @@ import { Command, CommandDialog, CommandEmpty } from "@simpleapps-com/augur-web/
 
 `ConfirmDialogProps`
 
-```ts
-import { ConfirmDialog } from "@simpleapps-com/augur-web/confirm-dialog";
-```
-
 ## `@simpleapps-com/augur-web/data-table`
 
 ### Values
@@ -365,17 +273,10 @@ import { ConfirmDialog } from "@simpleapps-com/augur-web/confirm-dialog";
 | Export | Kind | Description |
 |--------|------|-------------|
 | `DataTable` | function |  |
-| `RowSelectionState` | value |  |
-| `SortingState` | value |  |
-| `VisibilityState` | value |  |
 
 ### Types
 
-`ColumnDef`, `DataTablePagination`, `DataTableProps`
-
-```ts
-import { DataTable, RowSelectionState, SortingState } from "@simpleapps-com/augur-web/data-table";
-```
+`ColumnDef`, `DataTablePagination`, `DataTableProps`, `RowSelectionState`, `SortingState`, `VisibilityState`
 
 ## `@simpleapps-com/augur-web/detail-panel`
 
@@ -383,16 +284,12 @@ import { DataTable, RowSelectionState, SortingState } from "@simpleapps-com/augu
 
 | Export | Kind | Description |
 |--------|------|-------------|
-| `DetailPanel` | function | Read/edit toggle panel for a single record. Renders field values in read |
+| `DetailPanel` | function | Read/edit toggle panel for a single record. Renders field values in read mode, and form inputs in edit mode based on field definitions. |
 
 ### Types
 
 `DetailPanelProps`, `FieldDef`
 
-```ts
-import { DetailPanel } from "@simpleapps-com/augur-web/detail-panel";
-```
-
 ## `@simpleapps-com/augur-web/dialog`
 
 ### Values
@@ -410,10 +307,6 @@ import { DetailPanel } from "@simpleapps-com/augur-web/detail-panel";
 | `DialogTitle` | component |  |
 | `DialogTrigger` | component |  |
 
-```ts
-import { Dialog, DialogClose, DialogContent } from "@simpleapps-com/augur-web/dialog";
-```
-
 ## `@simpleapps-com/augur-web/dropdown-menu`
 
 ### Values
@@ -436,10 +329,6 @@ import { Dialog, DialogClose, DialogContent } from "@simpleapps-com/augur-web/di
 | `DropdownMenuSubTrigger` | component |  |
 | `DropdownMenuTrigger` | component |  |
 
-```ts
-import { DropdownMenu, DropdownMenuCheckboxItem, DropdownMenuContent } from "@simpleapps-com/augur-web/dropdown-menu";
-```
-
 ## `@simpleapps-com/augur-web/navigation-menu`
 
 ### Values
@@ -453,12 +342,8 @@ import { DropdownMenu, DropdownMenuCheckboxItem, DropdownMenuContent } from "@si
 | `NavigationMenuLink` | component |  |
 | `NavigationMenuList` | component |  |
 | `NavigationMenuTrigger` | component |  |
-| `NavigationMenuViewport` | component |  |
 | `navigationMenuTriggerStyle` | const |  |
-
-```ts
-import { NavigationMenu, NavigationMenuContent, NavigationMenuIndicator } from "@simpleapps-com/augur-web/navigation-menu";
-```
+| `NavigationMenuViewport` | component |  |
 
 ## `@simpleapps-com/augur-web/popover`
 
@@ -471,10 +356,6 @@ import { NavigationMenu, NavigationMenuContent, NavigationMenuIndicator } from "
 | `PopoverContent` | component |  |
 | `PopoverTrigger` | component |  |
 
-```ts
-import { Popover, PopoverAnchor, PopoverContent } from "@simpleapps-com/augur-web/popover";
-```
-
 ## `@simpleapps-com/augur-web/separator`
 
 ### Values
@@ -483,10 +364,6 @@ import { Popover, PopoverAnchor, PopoverContent } from "@simpleapps-com/augur-we
 |--------|------|-------------|
 | `Separator` | component |  |
 
-```ts
-import { Separator } from "@simpleapps-com/augur-web/separator";
-```
-
 ## `@simpleapps-com/augur-web/skeleton`
 
 ### Values
@@ -495,10 +372,6 @@ import { Separator } from "@simpleapps-com/augur-web/separator";
 |--------|------|-------------|
 | `Skeleton` | function |  |
 
-```ts
-import { Skeleton } from "@simpleapps-com/augur-web/skeleton";
-```
-
 ## `@simpleapps-com/augur-web/form-field`
 
 ### Values
@@ -511,10 +384,6 @@ import { Skeleton } from "@simpleapps-com/augur-web/skeleton";
 
 `FormFieldProps`
 
-```ts
-import { FormField } from "@simpleapps-com/augur-web/form-field";
-```
-
 ## `@simpleapps-com/augur-web/form-input`
 
 ### Values
@@ -527,10 +396,6 @@ import { FormField } from "@simpleapps-com/augur-web/form-field";
 
 `FormInputProps`
 
-```ts
-import { FormInput } from "@simpleapps-com/augur-web/form-input";
-```
-
 ## `@simpleapps-com/augur-web/form-select`
 
 ### Values
@@ -543,10 +408,6 @@ import { FormInput } from "@simpleapps-com/augur-web/form-input";
 
 `FormSelectProps`
 
-```ts
-import { FormSelect } from "@simpleapps-com/augur-web/form-select";
-```
-
 ## `@simpleapps-com/augur-web/form-textarea`
 
 ### Values
@@ -559,26 +420,18 @@ import { FormSelect } from "@simpleapps-com/augur-web/form-select";
 
 `FormTextareaProps`
 
-```ts
-import { FormTextarea } from "@simpleapps-com/augur-web/form-textarea";
-```
-
 ## `@simpleapps-com/augur-web/financing-widget`
 
 ### Values
 
 | Export | Kind | Description |
 |--------|------|-------------|
-| `FinancingWidget` | function | Loads a financing widget script on the pages where it's needed. |
+| `FinancingWidget` | function | Loads a financing widget script on the pages where it's needed. Renders nothing — this is a side-effect-only leaf component. |
 
 ### Types
 
 `FinancingProvider`, `FinancingWidgetProps`, `UseFinancingResult`
 
-```ts
-import { FinancingWidget } from "@simpleapps-com/augur-web/financing-widget";
-```
-
 ## `@simpleapps-com/augur-web/gtm`
 
 ### Values
@@ -593,21 +446,17 @@ import { FinancingWidget } from "@simpleapps-com/augur-web/financing-widget";
 
 `AnalyticsContextValue`, `AnalyticsNoscriptProps`, `AnalyticsProviderProps`, `AnalyticsStrategy`, `EcommerceEvent`, `EcommerceItem`, `EcommerceParams`
 
-```ts
-import { AnalyticsNoscript, AnalyticsProvider, useAnalytics } from "@simpleapps-com/augur-web/gtm";
-```
-
 ## `@simpleapps-com/augur-web/mdx-components`
 
 ### Values
 
 | Export | Kind | Description |
 |--------|------|-------------|
-| `getMDXComponents` | function | Returns a map of HTML element names to styled React components |
+| `getMDXComponents` | function | Returns a map of HTML element names to styled React components for use with MDX content rendering. |
+
+### Types
 
-```ts
-import { getMDXComponents } from "@simpleapps-com/augur-web/mdx-components";
-```
+`HtmlComponents`
 
 ## `@simpleapps-com/augur-web/payment-modal`
 
@@ -615,17 +464,13 @@ import { getMDXComponents } from "@simpleapps-com/augur-web/mdx-components";
 
 | Export | Kind | Description |
 |--------|------|-------------|
+| `extractBin` | function | Extract a card BIN from a postMessage payload. Handles multiple formats returned by Element/Unified iframes: - URL-encoded string with Bin= parameter - Object with Bin, bin, CardBIN, or cardBin property - Nested data.Bin structure |
 | `PaymentModal` | function |  |
-| `extractBin` | function | Extract a card BIN from a postMessage payload. |
 
 ### Types
 
 `PaymentModalProps`
 
-```ts
-import { PaymentModal, extractBin } from "@simpleapps-com/augur-web/payment-modal";
-```
-
 ## `@simpleapps-com/augur-web/quantity-input`
 
 ### Values
@@ -638,26 +483,18 @@ import { PaymentModal, extractBin } from "@simpleapps-com/augur-web/payment-moda
 
 `QuantityInputProps`
 
-```ts
-import { QuantityInput } from "@simpleapps-com/augur-web/quantity-input";
-```
-
 ## `@simpleapps-com/augur-web/session-replay`
 
 ### Values
 
 | Export | Kind | Description |
 |--------|------|-------------|
-| `SessionReplayScript` | function | Loads a session replay script with `lazyOnload` behavior. |
+| `SessionReplayScript` | function | Loads a session replay script with `lazyOnload` behavior. Renders nothing — this is a side-effect-only leaf component. |
 
 ### Types
 
 `SessionReplayProvider`, `SessionReplayScriptProps`
 
-```ts
-import { SessionReplayScript } from "@simpleapps-com/augur-web/session-replay";
-```
-
 ## `@simpleapps-com/augur-web/stock-label`
 
 ### Values
@@ -670,22 +507,14 @@ import { SessionReplayScript } from "@simpleapps-com/augur-web/session-replay";
 
 `CreateStockLabelResult`, `StockLabelClassNames`, `StockLabelConfig`, `StockLabelProps`
 
-```ts
-import { createStockLabel } from "@simpleapps-com/augur-web/stock-label";
-```
-
 ## `@simpleapps-com/augur-web/provider`
 
 ### Values
 
 | Export | Kind | Description |
 |--------|------|-------------|
-| `AugurSiteProvider` | function | Unified site provider that composes AugurHooksProvider with analytics |
+| `AugurSiteProvider` | function | Unified site provider that composes AugurHooksProvider with analytics based on the site config. |
 
 ### Types
 
 `AugurSiteProviderProps`
-
-```ts
-import { AugurSiteProvider } from "@simpleapps-com/augur-web/provider";
-```