@devalok/shilp-sutra 0.18.0 → 0.18.2

package/docs/components/ui/data-table.md

@@ -0,0 +1,91 @@
+# DataTable
+
+- Import: @devalok/shilp-sutra/ui/data-table
+- Server-safe: No
+- Category: ui
+
+## Props
+    columns: ColumnDef<TData>[] (TanStack column definitions)
+    data: TData[]
+    sortable: boolean — enable column sorting
+    onSort: (key: string, dir: 'asc' | 'desc' | false) => void — server-side sort callback (enables manualSorting)
+    filterable: boolean — enable per-column filters
+    globalFilter: boolean — enable global search
+    paginated: boolean — enable client-side pagination
+    pagination: { page: number, pageSize: number, total: number, onPageChange: (page: number) => void } — server-side pagination (1-based page)
+    pageSize: number (default 10)
+    selectable: boolean — enable row selection with checkboxes
+    selectedIds: Set<string> — controlled selection state
+    selectableFilter: (row: TData) => boolean — disable selection on certain rows
+    getRowId: (row: TData) => string — custom row ID accessor
+    onSelectionChange: (selectedRows: TData[]) => void
+    expandable: boolean — enable row expansion
+    renderExpanded: (row: TData) => ReactNode — expanded row content
+    singleExpand: boolean — only one row expanded at a time
+    loading: boolean — show skeleton shimmer rows
+    emptyState: ReactNode — custom empty state (takes precedence over noResultsText)
+    noResultsText: string (default "No results.")
+    stickyHeader: boolean — sticky table header
+    onRowClick: (row: TData) => void — row click handler (excludes interactive element clicks)
+    bulkActions: BulkAction<TData>[] — floating action bar on selection — { label, onClick, color?: 'default'|'error', disabled? }
+    toolbar: boolean — show DataTableToolbar (column visibility, density, CSV export)
+    editable: boolean — enable double-click cell editing
+    virtualRows: boolean — virtualize rows for large datasets
+    columnPinning: { left?: string[], right?: string[] }
+    defaultDensity: 'compact' | 'standard' | 'comfortable'
+
+## Defaults
+    pageSize=10, noResultsText="No results."
+
+## Example
+```jsx
+import { DataTable } from '@devalok/shilp-sutra/ui/data-table'
+
+<DataTable
+  columns={[
+    { accessorKey: 'name', header: 'Name' },
+    { accessorKey: 'email', header: 'Email' },
+  ]}
+  data={users}
+  sortable
+  onSort={(key, dir) => handleSort(key, dir)}
+  pagination={{ page, pageSize: 20, total: totalCount, onPageChange: setPage }}
+  loading={isLoading}
+  emptyState={<EmptyState title="No users" />}
+/>
+```
+
+## Gotchas
+- Barrel-isolated since v0.5.0 — must use `@devalok/shilp-sutra/ui/data-table`, NOT the `ui` barrel
+- Requires @tanstack/react-table and @tanstack/react-virtual as peer dependencies
+- When onSort is provided, sorting is manual (server-side) — rows stay in data order
+- When pagination prop is provided, pagination is manual — pass total count
+- selectedIds syncs via useEffect — provide getRowId for custom row IDs
+- onRowClick does NOT fire when clicking checkboxes, buttons, links, or inputs
+- Use defaultDensity="compact" for Karm-style h-9 rows
+
+## Changes
+### v0.16.1
+- **Fixed** `serverPagination` object reference in `useCallback` dependency caused stale closure — now uses stable ref for `onPageChange`
+- **Fixed** `onSelectionChange` effect fired every render due to `table` in dependency array — now derives selected rows directly
+- **Fixed** `selectedRows` useMemo for bulk actions had same `table` dependency issue
+
+### v0.16.0
+- **Added** `onSort` callback for server-side sorting
+- **Added** `emptyState` ReactNode slot
+- **Added** `loading` prop with shimmer skeleton rows
+- **Added** `selectedIds` + `selectableFilter` for controlled selection
+- **Added** `pagination` prop for server-side pagination
+- **Added** `singleExpand` prop
+- **Added** `stickyHeader` prop
+- **Added** `onRowClick` handler
+- **Added** `bulkActions` floating action bar
+
+### v0.5.0
+- **Changed** (BREAKING) Removed from `@devalok/shilp-sutra/ui` barrel export — must use `@devalok/shilp-sutra/ui/data-table`
+
+### v0.1.1
+- **Fixed** `useEffect` exhaustive-deps with proper dependency array
+
+### v0.1.0
+- **Added** Initial release

package/docs/components/ui/dialog.md

@@ -0,0 +1,51 @@
+# Dialog
+
+- Import: @devalok/shilp-sutra/ui/dialog
+- Server-safe: No
+- Category: ui
+
+## Compound Components
+    Dialog (root)
+      DialogTrigger
+      DialogContent
+        DialogHeader
+          DialogTitle
+          DialogDescription
+        [body content]
+        DialogFooter
+      DialogClose
+
+## Defaults
+    none
+
+## Example
+```jsx
+<Dialog>
+  <DialogTrigger asChild><Button>Open</Button></DialogTrigger>
+  <DialogContent>
+    <DialogHeader>
+      <DialogTitle>Edit Profile</DialogTitle>
+      <DialogDescription>Make changes to your profile.</DialogDescription>
+    </DialogHeader>
+    <div>Form fields here</div>
+    <DialogFooter>
+      <Button>Save</Button>
+    </DialogFooter>
+  </DialogContent>
+</Dialog>
+```
+
+## Gotchas
+- DialogTitle is required for accessibility — screen readers announce it when the dialog opens
+
+## Changes
+### v0.18.0
+- **Changed** Overlay animations migrated to Framer Motion (physics-based springs)
+- **Added** `DialogContentProps`, `DialogTitleProps` type exports
+- **Fixed** Context provider value wrapped in `useMemo` for performance
+
+### v0.3.0
+- **Fixed** DialogHeader/Footer now support ref forwarding
+
+### v0.1.0
+- **Added** Initial release

package/docs/components/ui/dropdown-menu.md

@@ -0,0 +1,45 @@
+# DropdownMenu
+
+- Import: @devalok/shilp-sutra/ui/dropdown-menu
+- Server-safe: No
+- Category: ui
+
+## Compound Components
+    DropdownMenu (root)
+      DropdownMenuTrigger
+      DropdownMenuContent
+        DropdownMenuLabel
+        DropdownMenuSeparator
+        DropdownMenuItem (+ DropdownMenuShortcut for keyboard hints)
+        DropdownMenuCheckboxItem
+        DropdownMenuRadioGroup > DropdownMenuRadioItem
+        DropdownMenuGroup
+        DropdownMenuSub > DropdownMenuSubTrigger, DropdownMenuSubContent
+
+## Defaults
+    none
+
+## Example
+```jsx
+<DropdownMenu>
+  <DropdownMenuTrigger asChild><Button variant="ghost">Menu</Button></DropdownMenuTrigger>
+  <DropdownMenuContent>
+    <DropdownMenuItem>Profile</DropdownMenuItem>
+    <DropdownMenuSeparator />
+    <DropdownMenuItem>Logout</DropdownMenuItem>
+  </DropdownMenuContent>
+</DropdownMenu>
+```
+
+## Gotchas
+- Use `asChild` on DropdownMenuTrigger to render your own button element
+
+## Changes
+### v0.18.0
+- **Added** `DropdownMenuContentProps`, `DropdownMenuItemProps` type exports
+
+### v0.14.0
+- **Changed** z-index promoted from `z-dropdown` (1000) to `z-popover` (1400) — fixes dropdown rendering behind Sheet/Dialog overlays
+
+### v0.1.0
+- **Added** Initial release

package/docs/components/ui/file-upload.md

@@ -0,0 +1,41 @@
+# FileUpload
+
+- Import: @devalok/shilp-sutra/ui/file-upload
+- Server-safe: No
+- Category: ui
+
+## Props
+    onFiles: (files: File[]) => void (REQUIRED)
+    accept: string (MIME or extension, e.g. "image/*", ".pdf,.doc")
+    maxSize: number (bytes, default: 10MB)
+    multiple: boolean
+    uploading: boolean
+    progress: number (0-100)
+    error: string
+    compact: boolean (inline button mode vs drop zone)
+    disabled: boolean
+    label: string
+    sublabel: string
+
+## Defaults
+    compact: false
+    maxSize: 10MB (10485760 bytes)
+
+## Example
+```jsx
+<FileUpload
+  accept="image/*"
+  maxSize={2 * 1024 * 1024}
+  onFiles={(files) => uploadAvatar(files[0])}
+  label="Upload profile photo"
+  sublabel="PNG, JPG up to 2MB"
+/>
+```
+
+## Gotchas
+- compact=true renders a small inline button; false (default) renders a large drag-and-drop zone
+- Client-side validation: invalid files are rejected before onFiles is called
+
+## Changes
+### v0.1.0
+- **Added** Initial release

package/docs/components/ui/form.md

@@ -0,0 +1,51 @@
+# FormField / FormHelperText / useFormField
+
+- Import: @devalok/shilp-sutra/ui/form
+- Server-safe: No
+- Category: ui
+
+## Props
+### FormField
+    state: "helper" | "error" | "warning" | "success" (default: "helper")
+    helperTextId: string (auto-generated if omitted)
+    required: boolean
+
+### FormHelperText
+    state: "helper" | "error" | "warning" | "success" (inherits from FormField context)
+
+## Types
+    FormHelperState = 'helper' | 'error' | 'warning' | 'success'
+
+## Hook
+    useFormField() => { state, helperTextId, required }
+
+## Defaults
+    state: "helper"
+
+## Example
+```jsx
+<FormField state="error">
+  <Label htmlFor="email">Email</Label>
+  <Input id="email" state="error" />
+  <FormHelperText>Please enter a valid email.</FormHelperText>
+</FormField>
+```
+
+## Gotchas
+- getFormFieldA11y() was REMOVED — use useFormField() hook instead
+- FormHelperText auto-reads state and id from FormField context
+- FormHelperText renders role="alert" when state="error"
+
+## Changes
+### v0.18.0
+- **Fixed** Wrapped FormField context provider value in `useMemo` for performance
+
+### v0.8.0
+- **Fixed** Input/Textarea now consume FormField context automatically (`aria-describedby`, `aria-invalid`, `aria-required`)
+
+### v0.3.0
+- **Added** `useFormField()` hook for automatic aria-describedby wiring
+- **Changed** (BREAKING) FormField auto-wires `aria-describedby` via context. `getFormFieldA11y()` removed
+
+### v0.1.0
+- **Added** Initial release

package/docs/components/ui/hover-card.md

@@ -0,0 +1,32 @@
+# HoverCard
+
+- Import: @devalok/shilp-sutra/ui/hover-card
+- Server-safe: No
+- Category: ui
+
+## Compound Components
+    HoverCard (root)
+      HoverCardTrigger
+      HoverCardContent
+
+## Example
+```jsx
+<HoverCard>
+  <HoverCardTrigger asChild><span>Hover me</span></HoverCardTrigger>
+  <HoverCardContent>Preview content</HoverCardContent>
+</HoverCard>
+```
+
+## Gotchas
+- Overlay component — uses Framer Motion for enter/exit animations (v0.18.0)
+
+## Changes
+### v0.18.0
+- **Changed** Migrated to Framer Motion for enter/exit animations
+- **Added** `HoverCardContentProps` type export
+
+### v0.14.0
+- **Changed** z-index promoted from `z-dropdown` (1000) to `z-popover` (1400) — fixes content rendering behind Sheet/Dialog overlays
+
+### v0.1.0
+- **Added** Initial release

package/docs/components/ui/icon-button.md

@@ -0,0 +1,33 @@
+# IconButton
+
+- Import: @devalok/shilp-sutra/ui/icon-button
+- Server-safe: No
+- Category: ui
+
+## Props
+    icon: ReactNode (REQUIRED)
+    aria-label: string (REQUIRED — WCAG AA mandatory)
+    shape: "square" | "circle"
+    size: "sm" | "md" | "lg"
+    variant: same as Button (solid, outline, ghost, link)
+    color: same as Button (default, error)
+    loading: boolean
+    disabled: boolean
+
+## Defaults
+    shape: "square"
+    size: "md"
+
+## Example
+```jsx
+<IconButton icon={<IconEdit />} variant="ghost" aria-label="Edit item" />
+<IconButton icon={<IconX />} shape="circle" variant="ghost" size="sm" aria-label="Close" />
+```
+
+## Gotchas
+- aria-label is enforced by TypeScript — you MUST provide it
+- Prefer IconButton over Button with size="icon-*" for icon-only buttons
+
+## Changes
+### v0.1.0
+- **Added** Initial release

package/docs/components/ui/input-otp.md

@@ -0,0 +1,44 @@
+# InputOTP
+
+- Import: @devalok/shilp-sutra/ui/input-otp
+- Server-safe: No
+- Category: ui
+
+## Props
+    Standard input-otp props (maxLength, pattern, etc.)
+
+## Compound Components
+    InputOTP (root)
+      InputOTPGroup
+        InputOTPSlot (index: number, REQUIRED)
+      InputOTPSeparator
+
+## Example
+```jsx
+<InputOTP maxLength={6}>
+  <InputOTPGroup>
+    <InputOTPSlot index={0} />
+    <InputOTPSlot index={1} />
+    <InputOTPSlot index={2} />
+  </InputOTPGroup>
+  <InputOTPSeparator />
+  <InputOTPGroup>
+    <InputOTPSlot index={3} />
+    <InputOTPSlot index={4} />
+    <InputOTPSlot index={5} />
+  </InputOTPGroup>
+</InputOTP>
+```
+
+## Gotchas
+- Each InputOTPSlot requires an `index` prop (0-based)
+
+## Changes
+### v0.18.0
+- **Added** `InputOTPProps` type export
+
+### v0.1.1
+- **Fixed** `animate-caret-blink` keyframe added to Tailwind preset — caret animation was silently broken
+
+### v0.1.0
+- **Added** Initial release

package/docs/components/ui/input.md

@@ -0,0 +1,48 @@
+# Input
+
+- Import: @devalok/shilp-sutra/ui/input
+- Server-safe: No
+- Category: ui
+
+## Props
+    size: "sm" | "md" | "lg"
+    state: InputState
+    startIcon: ReactNode
+    endIcon: ReactNode
+    (plus all standard HTML input attributes except native "size")
+
+## Types
+    InputState = 'default' | 'error' | 'warning' | 'success'
+
+## Defaults
+    size: "md"
+
+## Example
+```jsx
+<Input type="email" placeholder="you@example.com" state="error" startIcon={<IconMail />} />
+```
+
+## Gotchas
+- HTML native "size" attribute is excluded — use CSS width instead
+- state="error" sets aria-invalid automatically
+- Inside FormField: auto-inherits state, aria-describedby, aria-required from context (explicit props override)
+- Resting border is border-subtle (soft); focus ring is ring-1 at 50% opacity (v0.12.0)
+- All sizes (sm, md, lg) use text-ds-md (14px) font — size only affects height and padding (v0.15.0)
+
+## Changes
+### v0.15.0
+- **Changed** `lg` size font changed from `text-ds-lg` (18px) to `text-ds-md` (14px) — all input sizes now use 14px for consistency
+- **Changed** `md` size font standardized to `text-ds-md` (14px) from mixed values
+
+### v0.12.0
+- **Changed** Softer resting border (`border-border-subtle` instead of `border-border`), subtler focus ring (`ring-1 ring-focus/50` instead of `ring-2 ring-focus`)
+- **Changed** Reverted split `pl-*/pr-*` size variants back to `px-*`; icon padding uses `pl-ds-07`/`pr-ds-07`
+
+### v0.8.0
+- **Fixed** Now consumes FormField context automatically (`aria-describedby`, `aria-invalid`, `aria-required`)
+
+### v0.4.2
+- **Added** `inputVariants` export
+
+### v0.1.0
+- **Added** Initial release

package/docs/components/ui/label.md

@@ -0,0 +1,25 @@
+# Label
+
+- Import: @devalok/shilp-sutra/ui/label
+- Server-safe: No
+- Category: ui
+
+## Props
+    required: boolean (shows red asterisk)
+    htmlFor: string
+    (plus standard Radix Label props)
+
+## Example
+```jsx
+<Label htmlFor="email" required>Email Address</Label>
+```
+
+## Gotchas
+- Use with FormField for automatic aria wiring
+
+## Changes
+### v0.2.0
+- **Fixed** Children rendering verified and covered by tests — issue was caused by `@primitives` type leak, not a runtime bug
+
+### v0.1.0
+- **Added** Initial release

package/docs/components/ui/link.md

@@ -0,0 +1,29 @@
+# Link
+
+- Import: @devalok/shilp-sutra/ui/link
+- Server-safe: No
+- Category: ui
+
+## Props
+    inline: boolean (default: true — "inline" or "block" display)
+    asChild: boolean (merge with child element, e.g. Next.js Link)
+    (plus standard anchor attributes)
+
+## Defaults
+    inline: true
+
+## Example
+```jsx
+<Link href="/docs">Documentation</Link>
+<Link asChild><NextLink href="/about">About</NextLink></Link>
+```
+
+## Gotchas
+- Use asChild with framework-specific Link components (e.g. Next.js Link)
+
+## Changes
+### v0.18.0
+- **Fixed** Color tokens — `text-info-9` changed to `text-accent-11` (links are interactive = accent scale)
+
+### v0.1.0
+- **Added** Initial release

package/docs/components/ui/menubar.md

@@ -0,0 +1,44 @@
+# Menubar
+
+- Import: @devalok/shilp-sutra/ui/menubar
+- Server-safe: No
+- Category: ui
+
+## Compound Components
+    Menubar (root)
+      MenubarMenu
+        MenubarTrigger
+        MenubarContent
+          MenubarItem (+ MenubarShortcut)
+          MenubarCheckboxItem
+          MenubarRadioGroup > MenubarRadioItem
+          MenubarLabel
+          MenubarSeparator
+          MenubarSub > MenubarSubTrigger, MenubarSubContent
+
+## Example
+```jsx
+<Menubar>
+  <MenubarMenu>
+    <MenubarTrigger>File</MenubarTrigger>
+    <MenubarContent>
+      <MenubarItem>New<MenubarShortcut>Ctrl+N</MenubarShortcut></MenubarItem>
+      <MenubarSeparator />
+      <MenubarItem>Exit</MenubarItem>
+    </MenubarContent>
+  </MenubarMenu>
+</Menubar>
+```
+
+## Gotchas
+- Follows the standard Radix Menubar compound pattern
+
+## Changes
+### v0.18.0
+- **Added** `MenubarContentProps`, `MenubarItemProps` type exports
+
+### v0.14.0
+- **Changed** z-index promoted from `z-dropdown` (1000) to `z-popover` (1400) — fixes content rendering behind Sheet/Dialog overlays
+
+### v0.1.0
+- **Added** Initial release

package/docs/components/ui/navigation-menu.md

@@ -0,0 +1,46 @@
+# NavigationMenu
+
+- Import: @devalok/shilp-sutra/ui/navigation-menu
+- Server-safe: No
+- Category: ui
+
+## Compound Components
+    NavigationMenu (root)
+      NavigationMenuList
+        NavigationMenuItem
+          NavigationMenuTrigger (for items with content panels)
+          NavigationMenuContent (dropdown panel)
+          NavigationMenuLink (for direct links)
+      NavigationMenuIndicator
+      NavigationMenuViewport
+
+## Example
+```jsx
+<NavigationMenu>
+  <NavigationMenuList>
+    <NavigationMenuItem>
+      <NavigationMenuTrigger>Products</NavigationMenuTrigger>
+      <NavigationMenuContent>
+        <ul>...</ul>
+      </NavigationMenuContent>
+    </NavigationMenuItem>
+    <NavigationMenuItem>
+      <NavigationMenuLink href="/about">About</NavigationMenuLink>
+    </NavigationMenuItem>
+  </NavigationMenuList>
+</NavigationMenu>
+```
+
+## Gotchas
+- Uses Framer Motion for enter/exit animations (v0.18.0)
+
+## Changes
+### v0.18.0
+- **Changed** Migrated to Framer Motion for enter/exit animations
+- **Added** `NavigationMenuProps`, `NavigationMenuContentProps` type exports
+
+### v0.1.1
+- **Fixed** Token compliance — icon sizes replaced with `h-ico-sm w-ico-sm`
+
+### v0.1.0
+- **Added** Initial release

package/docs/components/ui/number-input.md

@@ -0,0 +1,44 @@
+# NumberInput
+
+- Import: @devalok/shilp-sutra/ui/number-input
+- Server-safe: No
+- Category: ui
+
+## Props
+    value: number (default: 0)
+    onValueChange: (value: number) => void
+    min: number
+    max: number
+    step: number (default: 1)
+    disabled: boolean
+
+## Defaults
+    value: 0
+    step: 1
+    min: Number.MIN_SAFE_INTEGER
+    max: Number.MAX_SAFE_INTEGER
+
+## Example
+```jsx
+<NumberInput value={qty} onValueChange={setQty} min={1} max={99} />
+```
+
+## Gotchas
+- Controlled only — buttons won't work without onValueChange
+
+## Changes
+### v0.18.0
+- **Fixed** Replaced `parseInt` with `Number()`, handle empty input
+
+### v0.15.0
+- **Changed** `md` size font standardized to `text-ds-md` (14px)
+
+### v0.8.0
+- **Fixed** FormField context consumption, `aria-label` fallback, `parseInt` radix parameter
+
+### v0.3.0
+- **Changed** (BREAKING) `onChange` renamed to `onValueChange`
+- **Changed** Now extends HTMLAttributes — accepts all standard HTML props
+
+### v0.1.0
+- **Added** Initial release

package/docs/components/ui/pagination.md

@@ -0,0 +1,48 @@
+# Pagination
+
+- Import: @devalok/shilp-sutra/ui/pagination
+- Server-safe: No
+- Category: ui
+
+## Compound Components
+    PaginationRoot (nav)
+      PaginationContent (ul)
+        PaginationItem (li)
+          PaginationLink (isActive: boolean, asChild: boolean)
+          PaginationPrevious
+          PaginationNext
+          PaginationEllipsis
+    PaginationNav (convenience wrapper)
+
+## Utility
+    generatePagination(current: number, total: number, siblingCount: number) => (number | 'ellipsis')[]
+
+## Example
+```jsx
+<PaginationRoot>
+  <PaginationContent>
+    <PaginationItem><PaginationPrevious onClick={() => setPage(p - 1)} /></PaginationItem>
+    {generatePagination(page, totalPages, 1).map((item, i) =>
+      item === 'ellipsis'
+        ? <PaginationItem key={i}><PaginationEllipsis /></PaginationItem>
+        : <PaginationItem key={i}>
+            <PaginationLink isActive={item === page} onClick={() => setPage(item)}>
+              {item}
+            </PaginationLink>
+          </PaginationItem>
+    )}
+    <PaginationItem><PaginationNext onClick={() => setPage(p + 1)} /></PaginationItem>
+  </PaginationContent>
+</PaginationRoot>
+```
+
+## Gotchas
+- Root component is PaginationRoot (NOT Pagination)
+
+## Changes
+### v0.1.1
+- **Fixed** Pagination link padding uses `ds-*` tokens instead of Tailwind arbitrary values
+
+### v0.1.0
+- **Added** Initial release
+- **Added** PaginationNav compound wrapper with `generatePagination` helper