@askrjs/themes 0.0.25 → 0.0.28

package/dist/components/card/card.types.d.ts

@@ -1,38 +1,47 @@
 import { JSX } from "@askrjs/askr/jsx-runtime";
 import { Ref } from "@askrjs/askr/foundations/utilities";
 //#region src/components/card/card.types.d.ts
+/** Visual style of a {@link CardProps} card. */
 type CardVariant = "default" | "raised";
+/** Heading tag allowed for a card's title via `titleAs`. */
 type CardTitleHeadingTag = "h1" | "h2" | "h3" | "h4" | "h5" | "h6";
 type DivProps = Omit<JSX.IntrinsicElements["div"], "children" | "ref">;
 type HeadingProps = Omit<JSX.IntrinsicElements["h3"], "children" | "ref">;
 type ParagraphProps = Omit<JSX.IntrinsicElements["p"], "children" | "ref">;
+/** Props for the {@link Card} component. */
 type CardProps = DivProps & {
   children?: unknown;
   variant?: CardVariant;
   ref?: Ref<HTMLDivElement>;
 };
+/** Props for the {@link CardHeader} component. */
 type CardHeaderProps = DivProps & {
   children?: unknown;
   ref?: Ref<HTMLDivElement>;
 };
+/** Props for the {@link CardTitle} component. */
 type CardTitleProps = HeadingProps & {
   children?: unknown;
   /** Choose the level that follows the surrounding document hierarchy. */
   titleAs?: CardTitleHeadingTag;
   ref?: Ref<HTMLHeadingElement>;
 };
+/** Props for the {@link CardDescription} component. */
 type CardDescriptionProps = ParagraphProps & {
   children?: unknown;
   ref?: Ref<HTMLParagraphElement>;
 };
+/** Props for the {@link CardContent} component. */
 type CardContentProps = DivProps & {
   children?: unknown;
   ref?: Ref<HTMLDivElement>;
 };
+/** Props for the {@link CardFooter} component. */
 type CardFooterProps = DivProps & {
   children?: unknown;
   ref?: Ref<HTMLDivElement>;
 };
+/** Props for the {@link CardAction} component. */
 type CardActionProps = DivProps & {
   children?: unknown;
   ref?: Ref<HTMLDivElement>;

package/dist/components/catalog.d.ts

@@ -2,6 +2,10 @@ import { JSX } from "@askrjs/askr/jsx-runtime";
 import { Ref } from "@askrjs/askr/foundations/utilities";
 //#region src/components/catalog.d.ts
 type CatalogElement = keyof JSX.IntrinsicElements;
+/**
+ * Shared prop shape for the shadcn-compatible catalog primitives below: a
+ * polymorphic `as`/`asChild` element plus passthrough attributes.
+ */
 type CatalogComponentProps = Record<string, unknown> & {
   as?: CatalogElement;
   asChild?: boolean;
@@ -9,34 +13,61 @@ type CatalogComponentProps = Record<string, unknown> & {
   class?: string;
   ref?: Ref<HTMLElement>;
 };
+/** Legacy `Box` layout alias for {@link Block} with no default direction. */
 declare function Box(props: CatalogComponentProps): JSX.Element;
+/** Legacy `Stack` layout alias for {@link Block} that defaults to a column direction. */
 declare function Stack(props: CatalogComponentProps): JSX.Element;
+/** Legacy `Inline` layout alias for {@link Block} that defaults to a row direction. */
 declare function Inline(props: CatalogComponentProps): JSX.Element;
+/** Legacy `Shell` layout alias for {@link Block}; the `variant` prop is accepted but ignored. */
 declare function Shell(props: CatalogComponentProps & {
   variant?: unknown;
 }): JSX.Element;
+/** Legacy `ShellNav` layout alias for {@link Block}. */
 declare function ShellNav(props: CatalogComponentProps): JSX.Element;
+/** Legacy `ShellMain` layout alias for {@link Block} that renders a growing `<main>` element. */
 declare function ShellMain(props: CatalogComponentProps): JSX.Element;
+/** Renders the `alert-title` part of the shadcn-compatible catalog primitives. */
 declare function AlertTitle(props: CatalogComponentProps): JSX.Element;
+/** Renders the `alert-description` part of the shadcn-compatible catalog primitives. */
 declare function AlertDescription(props: CatalogComponentProps): JSX.Element;
+/** Renders the `breadcrumb` part of the shadcn-compatible catalog primitives. */
 declare function Breadcrumb(props: CatalogComponentProps): JSX.Element;
+/** Renders the `breadcrumb-list` part of the shadcn-compatible catalog primitives. */
 declare function BreadcrumbList(props: CatalogComponentProps): JSX.Element;
+/** Renders the `breadcrumb-item` part of the shadcn-compatible catalog primitives. */
 declare function BreadcrumbItem(props: CatalogComponentProps): JSX.Element;
+/** Renders the `breadcrumb-link` part of the shadcn-compatible catalog primitives. */
 declare function BreadcrumbLink(props: CatalogComponentProps): JSX.Element;
+/** Renders the current (non-link) breadcrumb page, marked `aria-current="page"`. */
 declare function BreadcrumbPage(props: CatalogComponentProps): JSX.Element;
+/** Renders the separator between breadcrumb items (defaults to `"/"`). */
 declare function BreadcrumbSeparator(props: CatalogComponentProps): JSX.Element;
+/** Renders a non-interactive ellipsis marker in a breadcrumb trail. */
 declare function BreadcrumbEllipsis(props: CatalogComponentProps): JSX.Element;
+/** Renders the `calendar` part of the shadcn-compatible catalog primitives. */
 declare function Calendar(props: CatalogComponentProps): JSX.Element;
+/** Renders the `calendar-header` part of the shadcn-compatible catalog primitives. */
 declare function CalendarHeader(props: CatalogComponentProps): JSX.Element;
+/** Renders the `calendar-caption` part of the shadcn-compatible catalog primitives. */
 declare function CalendarCaption(props: CatalogComponentProps): JSX.Element;
+/** Renders the `calendar-nav` part of the shadcn-compatible catalog primitives. */
 declare function CalendarNav(props: CatalogComponentProps): JSX.Element;
+/** Button that navigates the calendar to the previous month. */
 declare function CalendarPreviousButton(props: CatalogComponentProps): JSX.Element;
+/** Button that navigates the calendar to the next month. */
 declare function CalendarNextButton(props: CatalogComponentProps): JSX.Element;
+/** Renders the `calendar-grid` part of the shadcn-compatible catalog primitives. */
 declare function CalendarGrid(props: CatalogComponentProps): JSX.Element;
+/** Renders the `calendar-head` part of the shadcn-compatible catalog primitives. */
 declare function CalendarHead(props: CatalogComponentProps): JSX.Element;
+/** Renders the `calendar-body` part of the shadcn-compatible catalog primitives. */
 declare function CalendarBody(props: CatalogComponentProps): JSX.Element;
+/** Renders the `calendar-row` part of the shadcn-compatible catalog primitives. */
 declare function CalendarRow(props: CatalogComponentProps): JSX.Element;
+/** Renders the `calendar-cell` part of the shadcn-compatible catalog primitives. */
 declare function CalendarCell(props: CatalogComponentProps): JSX.Element;
+/** Renders a single selectable day cell in the calendar grid, with selection/range/today state exposed as data attributes. */
 declare function CalendarDay(props: CatalogComponentProps & {
   disabled?: boolean;
   outside?: boolean;
@@ -46,110 +77,201 @@ declare function CalendarDay(props: CatalogComponentProps & {
   selected?: boolean;
   today?: boolean;
 }): JSX.Element;
+/** Renders the `carousel` part of the shadcn-compatible catalog primitives. */
 declare function Carousel(props: CatalogComponentProps): JSX.Element;
+/** Renders the `carousel-content` part of the shadcn-compatible catalog primitives. */
 declare function CarouselContent(props: CatalogComponentProps): JSX.Element;
+/** Renders the `carousel-item` part of the shadcn-compatible catalog primitives. */
 declare function CarouselItem(props: CatalogComponentProps): JSX.Element;
+/** Button that navigates the carousel to the previous item. */
 declare function CarouselPrevious(props: CatalogComponentProps): JSX.Element;
+/** Button that navigates the carousel to the next item. */
 declare function CarouselNext(props: CatalogComponentProps): JSX.Element;
+/** Renders the `combobox` part of the shadcn-compatible catalog primitives. */
 declare function Combobox(props: CatalogComponentProps): JSX.Element;
+/** Renders the combobox's text input, wired up with `role="combobox"`. */
 declare function ComboboxInput(props: CatalogComponentProps): JSX.Element;
+/** Renders the `combobox-list` part of the shadcn-compatible catalog primitives. */
 declare function ComboboxList(props: CatalogComponentProps): JSX.Element;
+/** Renders the `combobox-option` part of the shadcn-compatible catalog primitives. */
 declare function ComboboxOption(props: CatalogComponentProps): JSX.Element;
+/** Renders the `command` part of the shadcn-compatible catalog primitives. */
 declare function Command(props: CatalogComponentProps): JSX.Element;
+/** Renders the `command-dialog` part of the shadcn-compatible catalog primitives. */
 declare function CommandDialog(props: CatalogComponentProps): JSX.Element;
+/** Renders the command palette's search `<input>`. */
 declare function CommandInput(props: CatalogComponentProps): JSX.Element;
+/** Renders the `command-header` part of the shadcn-compatible catalog primitives. */
 declare function CommandHeader(props: CatalogComponentProps): JSX.Element;
+/** Renders the `command-list` part of the shadcn-compatible catalog primitives. */
 declare function CommandList(props: CatalogComponentProps): JSX.Element;
+/** Renders the `command-empty` part of the shadcn-compatible catalog primitives. */
 declare function CommandEmpty(props: CatalogComponentProps): JSX.Element;
+/** Renders the `command-group` part of the shadcn-compatible catalog primitives. */
 declare function CommandGroup(props: CatalogComponentProps): JSX.Element;
+/** Renders the `command-group-heading` part of the shadcn-compatible catalog primitives. */
 declare function CommandGroupHeading(props: CatalogComponentProps): JSX.Element;
+/** Renders a selectable command list entry, exposing `active`/`disabled`/`selected` as ARIA and data attributes. */
 declare function CommandItem(props: CatalogComponentProps & {
   active?: boolean;
   disabled?: boolean;
   selected?: boolean;
 }): JSX.Element;
+/** Renders the `command-separator` part of the shadcn-compatible catalog primitives. */
 declare function CommandSeparator(props: CatalogComponentProps): JSX.Element;
+/** Renders the `command-shortcut` part of the shadcn-compatible catalog primitives. */
 declare function CommandShortcut(props: CatalogComponentProps): JSX.Element;
+/** Renders the `data-table` part of the shadcn-compatible catalog primitives. */
 declare function DataTable(props: CatalogComponentProps): JSX.Element;
+/** Renders the `date-picker` part of the shadcn-compatible catalog primitives. */
 declare function DatePicker(props: CatalogComponentProps): JSX.Element;
+/** Renders the date picker's `<input type="date">` by default. */
 declare function DatePickerInput(props: CatalogComponentProps): JSX.Element;
+/** Sets the `dir` attribute (defaulting to `"ltr"`) on its wrapping element for RTL/LTR scoping. */
 declare function Direction(props: CatalogComponentProps & {
   dir?: "ltr" | "rtl";
 }): JSX.Element;
+/** Renders the `empty` part of the shadcn-compatible catalog primitives. */
 declare function Empty(props: CatalogComponentProps): JSX.Element;
+/** Renders the `empty-header` part of the shadcn-compatible catalog primitives. */
 declare function EmptyHeader(props: CatalogComponentProps): JSX.Element;
+/** Renders the `empty-title` part of the shadcn-compatible catalog primitives. */
 declare function EmptyTitle(props: CatalogComponentProps): JSX.Element;
+/** Renders the `empty-description` part of the shadcn-compatible catalog primitives. */
 declare function EmptyDescription(props: CatalogComponentProps): JSX.Element;
+/** Renders the `empty-content` part of the shadcn-compatible catalog primitives. */
 declare function EmptyContent(props: CatalogComponentProps): JSX.Element;
+/** Renders the `empty-media` part of the shadcn-compatible catalog primitives. */
 declare function EmptyMedia(props: CatalogComponentProps): JSX.Element;
+/** Renders the `field-group` part of the shadcn-compatible catalog primitives. */
 declare function FieldGroup(props: CatalogComponentProps): JSX.Element;
+/** Renders the `field-set` part of the shadcn-compatible catalog primitives. */
 declare function FieldSet(props: CatalogComponentProps): JSX.Element;
+/** Renders the `field-legend` part of the shadcn-compatible catalog primitives. */
 declare function FieldLegend(props: CatalogComponentProps): JSX.Element;
+/** Renders the `field-label` part of the shadcn-compatible catalog primitives. */
 declare function FieldLabel(props: CatalogComponentProps): JSX.Element;
+/** Renders the `field-description` part of the shadcn-compatible catalog primitives. */
 declare function FieldDescription(props: CatalogComponentProps): JSX.Element;
+/** Renders the `field-content` part of the shadcn-compatible catalog primitives. */
 declare function FieldContent(props: CatalogComponentProps): JSX.Element;
+/** Renders the `field-title` part of the shadcn-compatible catalog primitives. */
 declare function FieldTitle(props: CatalogComponentProps): JSX.Element;
+/** Renders the `field-separator` part of the shadcn-compatible catalog primitives. */
 declare function FieldSeparator(props: CatalogComponentProps): JSX.Element;
+/** Renders the `input-otp` part of the shadcn-compatible catalog primitives. */
 declare function InputOTP(props: CatalogComponentProps): JSX.Element;
+/** Renders the `input-otp-group` part of the shadcn-compatible catalog primitives. */
 declare function InputOTPGroup(props: CatalogComponentProps): JSX.Element;
+/** Renders the `input-otp-slot` part of the shadcn-compatible catalog primitives. */
 declare function InputOTPSlot(props: CatalogComponentProps): JSX.Element;
+/** Renders the visual separator between InputOTP groups (defaults to `"-"`). */
 declare function InputOTPSeparator(props: CatalogComponentProps): JSX.Element;
+/** Renders a generic list item part, exposing `active`/`size`/`variant` as data attributes. */
 declare function Item(props: CatalogComponentProps & {
   active?: boolean;
   size?: "default" | "sm" | "xs";
   variant?: "default" | "outline" | "muted";
 }): JSX.Element;
+/** Renders the `item-group` part of the shadcn-compatible catalog primitives. */
 declare function ItemGroup(props: CatalogComponentProps): JSX.Element;
+/** Renders the `item-header` part of the shadcn-compatible catalog primitives. */
 declare function ItemHeader(props: CatalogComponentProps): JSX.Element;
+/** Renders the `item-media` part of the shadcn-compatible catalog primitives. */
 declare function ItemMedia(props: CatalogComponentProps): JSX.Element;
+/** Renders the `item-content` part of the shadcn-compatible catalog primitives. */
 declare function ItemContent(props: CatalogComponentProps): JSX.Element;
+/** Renders the `item-title` part of the shadcn-compatible catalog primitives. */
 declare function ItemTitle(props: CatalogComponentProps): JSX.Element;
+/** Renders the `item-description` part of the shadcn-compatible catalog primitives. */
 declare function ItemDescription(props: CatalogComponentProps): JSX.Element;
+/** Renders the `item-actions` part of the shadcn-compatible catalog primitives. */
 declare function ItemActions(props: CatalogComponentProps): JSX.Element;
+/** Renders the `item-footer` part of the shadcn-compatible catalog primitives. */
 declare function ItemFooter(props: CatalogComponentProps): JSX.Element;
+/** Renders the `kbd` part of the shadcn-compatible catalog primitives. */
 declare function Kbd(props: CatalogComponentProps): JSX.Element;
+/** Renders a styled native `<select>` element. */
 declare function NativeSelect(props: CatalogComponentProps): JSX.Element;
+/** Renders the `navigation-menu` part of the shadcn-compatible catalog primitives. */
 declare function NavigationMenu(props: CatalogComponentProps): JSX.Element;
+/** Renders the `navigation-menu-list` part of the shadcn-compatible catalog primitives. */
 declare function NavigationMenuList(props: CatalogComponentProps): JSX.Element;
+/** Renders the `navigation-menu-item` part of the shadcn-compatible catalog primitives. */
 declare function NavigationMenuItem(props: CatalogComponentProps): JSX.Element;
+/** Renders the `navigation-menu-content` part of the shadcn-compatible catalog primitives. */
 declare function NavigationMenuTrigger(props: CatalogComponentProps): JSX.Element;
+/** Renders the `navigation-menu-content` part of the shadcn-compatible catalog primitives. */
 declare function NavigationMenuContent(props: CatalogComponentProps): JSX.Element;
+/** Renders the `navigation-menu-link` part of the shadcn-compatible catalog primitives. */
 declare function NavigationMenuLink(props: CatalogComponentProps): JSX.Element;
+/** Renders the `navigation-menu-viewport` part of the shadcn-compatible catalog primitives. */
 declare function NavigationMenuViewport(props: CatalogComponentProps): JSX.Element;
+/** Renders the `navigation-menu-indicator` part of the shadcn-compatible catalog primitives. */
 declare function NavigationMenuIndicator(props: CatalogComponentProps): JSX.Element;
+/** Renders the `pagination` part of the shadcn-compatible catalog primitives. */
 declare function Pagination(props: CatalogComponentProps): JSX.Element;
+/** Renders the `pagination-content` part of the shadcn-compatible catalog primitives. */
 declare function PaginationContent(props: CatalogComponentProps): JSX.Element;
+/** Renders the `pagination-item` part of the shadcn-compatible catalog primitives. */
 declare function PaginationItem(props: CatalogComponentProps): JSX.Element;
+/** Renders a pagination page link, marking it `aria-current="page"` when `active`. */
 declare function PaginationLink(props: CatalogComponentProps & {
   active?: boolean;
 }): JSX.Element;
+/** Pagination link that moves to the previous page. */
 declare function PaginationPrevious(props: CatalogComponentProps): JSX.Element;
+/** Pagination link that moves to the next page. */
 declare function PaginationNext(props: CatalogComponentProps): JSX.Element;
+/** Renders a non-interactive ellipsis marker between pagination links. */
 declare function PaginationEllipsis(props: CatalogComponentProps): JSX.Element;
+/** Renders the `resizable-panel-group` part of the shadcn-compatible catalog primitives. */
 declare function ResizablePanelGroup(props: CatalogComponentProps): JSX.Element;
+/** Renders the `resizable-panel` part of the shadcn-compatible catalog primitives. */
 declare function ResizablePanel(props: CatalogComponentProps): JSX.Element;
+/** Renders the `resizable-handle` part of the shadcn-compatible catalog primitives. */
 declare function ResizableHandle(props: CatalogComponentProps): JSX.Element;
+/** Renders the `tabs-list` part of the shadcn-compatible catalog primitives. */
 declare function TabsList(props: CatalogComponentProps): JSX.Element;
+/** Renders the `tabs-content` part of the shadcn-compatible catalog primitives. */
 declare function TabsTrigger(props: CatalogComponentProps): JSX.Element;
+/** Renders the `tabs-content` part of the shadcn-compatible catalog primitives. */
 declare function TabsContent(props: CatalogComponentProps): JSX.Element;
+/** Sheet variant of the dialog content part; defaults to sliding in from the right. */
 declare function SheetContent(props: CatalogComponentProps & {
   side?: "top" | "right" | "bottom" | "left";
 }): JSX.Element;
+/** Renders the `sheet-header` part of the shadcn-compatible catalog primitives. */
 declare function SheetHeader(props: CatalogComponentProps): JSX.Element;
+/** Renders the `sheet-footer` part of the shadcn-compatible catalog primitives. */
 declare function SheetFooter(props: CatalogComponentProps): JSX.Element;
+/** Sheet variant of the dialog title part. */
 declare function SheetTitle(props: CatalogComponentProps): JSX.Element;
+/** Sheet variant of the dialog description part. */
 declare function SheetDescription(props: CatalogComponentProps): JSX.Element;
+/** Renders the `sonner` part of the shadcn-compatible catalog primitives. */
 declare function Toaster(props: CatalogComponentProps): JSX.Element;
+/** Alias of {@link Toaster} kept for shadcn/sonner API compatibility. */
 declare const Sonner: typeof Toaster;
+/** Renders the `typography` part of the shadcn-compatible catalog primitives. */
 declare function Typography(props: CatalogComponentProps): JSX.Element;
+/** Renders the `typography-h1` part of the shadcn-compatible catalog primitives. */
 declare function TypographyH1(props: CatalogComponentProps): JSX.Element;
+/** Renders the `typography-h2` part of the shadcn-compatible catalog primitives. */
 declare function TypographyH2(props: CatalogComponentProps): JSX.Element;
+/** Renders the `typography-h3` part of the shadcn-compatible catalog primitives. */
 declare function TypographyH3(props: CatalogComponentProps): JSX.Element;
+/** Renders the `typography-h4` part of the shadcn-compatible catalog primitives. */
 declare function TypographyH4(props: CatalogComponentProps): JSX.Element;
+/** Renders the `typography-p` part of the shadcn-compatible catalog primitives. */
 declare function TypographyP(props: CatalogComponentProps): JSX.Element;
+/** Renders the `typography-blockquote` part of the shadcn-compatible catalog primitives. */
 declare function TypographyBlockquote(props: CatalogComponentProps): JSX.Element;
+/** Renders the `typography-list` part of the shadcn-compatible catalog primitives. */
 declare function TypographyList(props: CatalogComponentProps): JSX.Element;
+/** Renders the `typography-lead` part of the shadcn-compatible catalog primitives. */
 declare function TypographyLead(props: CatalogComponentProps): JSX.Element;
+/** Renders the `typography-muted` part of the shadcn-compatible catalog primitives. */
 declare function TypographyMuted(props: CatalogComponentProps): JSX.Element;
 //#endregion
 export { AlertDescription, AlertTitle, Box, Breadcrumb, BreadcrumbEllipsis, BreadcrumbItem, BreadcrumbLink, BreadcrumbList, BreadcrumbPage, BreadcrumbSeparator, Calendar, CalendarBody, CalendarCaption, CalendarCell, CalendarDay, CalendarGrid, CalendarHead, CalendarHeader, CalendarNav, CalendarNextButton, CalendarPreviousButton, CalendarRow, Carousel, CarouselContent, CarouselItem, CarouselNext, CarouselPrevious, CatalogComponentProps, Combobox, ComboboxInput, ComboboxList, ComboboxOption, Command, CommandDialog, CommandEmpty, CommandGroup, CommandGroupHeading, CommandHeader, CommandInput, CommandItem, CommandList, CommandSeparator, CommandShortcut, DataTable, DatePicker, DatePickerInput, Direction, Empty, EmptyContent, EmptyDescription, EmptyHeader, EmptyMedia, EmptyTitle, FieldContent, FieldDescription, FieldGroup, FieldLabel, FieldLegend, FieldSeparator, FieldSet, FieldTitle, Inline, InputOTP, InputOTPGroup, InputOTPSeparator, InputOTPSlot, Item, ItemActions, ItemContent, ItemDescription, ItemFooter, ItemGroup, ItemHeader, ItemMedia, ItemTitle, Kbd, NativeSelect, NavigationMenu, NavigationMenuContent, NavigationMenuIndicator, NavigationMenuItem, NavigationMenuLink, NavigationMenuList, NavigationMenuTrigger, NavigationMenuViewport, Pagination, PaginationContent, PaginationEllipsis, PaginationItem, PaginationLink, PaginationNext, PaginationPrevious, ResizableHandle, ResizablePanel, ResizablePanelGroup, SheetContent, SheetDescription, SheetFooter, SheetHeader, SheetTitle, Shell, ShellMain, ShellNav, Sonner, Stack, TabsContent, TabsList, TabsTrigger, Toaster, Typography, TypographyBlockquote, TypographyH1, TypographyH2, TypographyH3, TypographyH4, TypographyLead, TypographyList, TypographyMuted, TypographyP };