@antscorp/ui 0.1.3 → 0.1.5

package/src/organisms/HourOfDayRow.doc.ts

@@ -1,43 +0,0 @@
-import type { ComponentDoc } from "../doc/schema";
-
-/** Usage guidance for HourOfDayRow. */
-export const doc = {
-  category: "Selection",
-  keywords: ["hours", "day", "schedule", "drag"],
-  usage: {
-    description:
-      "Pick hours in one day by toggling cells or dragging a run. Use HourOfWeekGrid when selections vary by weekday.",
-    bestPractices: [
-      {
-        guidance: true,
-        description:
-          "Pass hours from 0 to 23 and format names through labels.hour; store the sorted unique result from onChange.",
-      },
-      {
-        guidance: false,
-        description:
-          "Do not compress the cells to fit a narrow panel; the row keeps its cell size and scrolls horizontally.",
-      },
-    ],
-    anatomy: [
-      {
-        name: "Hour cells",
-        required: true,
-        description: "Twenty-four cells showing picked hours and drag preview.",
-      },
-      {
-        name: "Hour labels",
-        required: true,
-        description: "Every third hour named below the row.",
-      },
-      {
-        name: "Error",
-        required: false,
-        description: "A translated problem below the selection.",
-      },
-    ],
-  },
-  accessibility: [
-    "label names the row; arrow keys move between hours and Space or Enter toggles the focused hour.",
-  ],
-} satisfies ComponentDoc;

package/src/organisms/HourOfWeekGrid.doc.ts

@@ -1,48 +0,0 @@
-import type { ComponentDoc } from "../doc/schema";
-
-/** Usage guidance for HourOfWeekGrid. */
-export const doc = {
-  category: "Selection",
-  keywords: ["hours", "week", "schedule", "grid"],
-  usage: {
-    description:
-      "Pick hours across seven days by dragging a rectangle, toggling a day, or using the everyday row. Use HourOfDayRow when one daily selection is sufficient.",
-    bestPractices: [
-      {
-        guidance: true,
-        description:
-          "Supply seven day labels Monday first and store cells as day * 24 + hour, from 0 to 167.",
-      },
-      {
-        guidance: false,
-        description:
-          "Do not assume read-only matches disabled presentation; read-only hides the everyday editing row while disabled keeps it.",
-      },
-    ],
-    anatomy: [
-      {
-        name: "Day rows",
-        required: true,
-        description: "Seven rows of twenty-four hour cells, with day-name actions.",
-      },
-      {
-        name: "Everyday row",
-        required: false,
-        description: "Controls that toggle whole hours across all days, hidden when read-only.",
-      },
-      {
-        name: "Hour axis",
-        required: true,
-        description: "Formatted hour names along the grid.",
-      },
-      {
-        name: "Error",
-        required: false,
-        description: "A translated problem below the grid.",
-      },
-    ],
-  },
-  accessibility: [
-    "label names the grid even when visually hidden; cells expose selection, arrow keys move focus, and Space or Enter toggles a cell.",
-  ],
-} satisfies ComponentDoc;

package/src/organisms/RepeatableList.doc.ts

@@ -1,49 +0,0 @@
-import type { ComponentDoc } from "../doc/schema";
-
-/** Usage guidance for RepeatableList. */
-export const doc = {
-  category: "Inputs",
-  keywords: ["list", "repeatable", "add", "rows"],
-  usage: {
-    description:
-      "Compose an editable list whose items and removal controls are supplied by the host. Use RuleList when every item should have a RuleRow and first/rest joining words.",
-    bestPractices: [
-      {
-        guidance: true,
-        description:
-          "Provide stable itemKey values and pass disabled or read-only state into the controls rendered by renderItem.",
-      },
-      {
-        guidance: false,
-        description:
-          "Do not hide the add button yourself at max; the list keeps it disabled with labels.maxReached when supplied.",
-      },
-    ],
-    anatomy: [
-      {
-        name: "Items",
-        required: false,
-        description:
-          "Host-rendered rows when items exist, optionally sharing column headings and tracks.",
-      },
-      {
-        name: "Separators",
-        required: false,
-        description: "Joint words or labeled dividers between items.",
-      },
-      {
-        name: "Add row",
-        required: false,
-        description: "A named add button, optionally placed by renderAdd.",
-      },
-      {
-        name: "Feedback",
-        required: false,
-        description: "Empty, maximum and validation messages.",
-      },
-    ],
-  },
-  accessibility: [
-    "label names the list's group; supply labels.add for its add action and accessible names inside rendered items.",
-  ],
-} satisfies ComponentDoc;

package/src/organisms/ResizableDrawer.doc.ts

@@ -1,48 +0,0 @@
-import type { ComponentDoc } from "../doc/schema";
-
-/** Usage guidance for ResizableDrawer. */
-export const doc = {
-  category: "Overlays",
-  keywords: ["drawer", "resize", "panel", "expand"],
-  usage: {
-    description:
-      "Place a resizable panel at the bottom of its parent, with a fixed header and scrolling body. Expansion covers that parent and Escape shrinks an expanded drawer.",
-    bestPractices: [
-      {
-        guidance: true,
-        description:
-          "Keep isExpanded controlled through onExpandedChange and provide labels and glyphs for expand and shrink.",
-      },
-      {
-        guidance: false,
-        description:
-          "Do not expect the drawer to cover the browser viewport unless its parent is sized for that purpose.",
-      },
-    ],
-    anatomy: [
-      {
-        name: "Resize bar",
-        required: true,
-        description: "The handle for changing the local drawer height.",
-      },
-      {
-        name: "Header",
-        required: true,
-        description: "Host title, optional end content, expand and close buttons.",
-      },
-      {
-        name: "Banners",
-        required: false,
-        description: "Host messages above the body.",
-      },
-      {
-        name: "Body",
-        required: true,
-        description: "Scrolling host content.",
-      },
-    ],
-  },
-  accessibility: [
-    "label names the drawer; labels names the expand, shrink, close and optional resize controls; Escape shrinks when expanded.",
-  ],
-} satisfies ComponentDoc;

package/src/organisms/RuleGroups.doc.ts

@@ -1,49 +0,0 @@
-import type { ComponentDoc } from "../doc/schema";
-
-/** Usage guidance for RuleGroups. */
-export const doc = {
-  category: "Inputs",
-  keywords: ["rules", "groups", "conditions", "and", "or"],
-  usage: {
-    description:
-      "Edit alternative groups of rules, where all rules in one group must hold. Use RuleList for a single flat conjunction of rules.",
-    bestPractices: [
-      {
-        guidance: true,
-        description:
-          "Keep groups controlled and configure controls returned by renderRule for the same disabled or read-only state as the groups.",
-      },
-      {
-        guidance: false,
-        description:
-          "Do not expect a disabled add at maxRules or maxGroups; this view hides adds at their limits and protects the final rule from removal.",
-      },
-    ],
-    anatomy: [
-      {
-        name: "Rule cards",
-        required: false,
-        description:
-          "Titled accent cards containing host controls and optional close actions when groups contain rules.",
-      },
-      {
-        name: "And joints",
-        required: false,
-        description: "Words and add-rule buttons within each group.",
-      },
-      {
-        name: "Or dividers",
-        required: false,
-        description: "Dashed separators and the add-group action.",
-      },
-      {
-        name: "Error",
-        required: false,
-        description: "A translated problem with all groups.",
-      },
-    ],
-  },
-  accessibility: [
-    "label names the whole group and labels.remove names rule-card close actions; supplied controls keep their own labels.",
-  ],
-} satisfies ComponentDoc;

package/src/organisms/RuleList.doc.ts

@@ -1,43 +0,0 @@
-import type { ComponentDoc } from "../doc/schema";
-
-/** Usage guidance for RuleList. */
-export const doc = {
-  category: "Inputs",
-  keywords: ["rules", "list", "conditions", "joint"],
-  usage: {
-    description:
-      "Edit rules that all must hold, with one joining word on the first row and another on later rows. Use RuleGroups when alternatives need separate groups of rule cards.",
-    bestPractices: [
-      {
-        guidance: true,
-        description:
-          "Provide stable itemKey values and pass the list's size and lock state to controls returned by renderControls.",
-      },
-      {
-        guidance: false,
-        description:
-          "Do not expect isReadOnly to change host-rendered controls; it hides the list's add and remove actions.",
-      },
-    ],
-    anatomy: [
-      {
-        name: "Rule rows",
-        required: true,
-        description: "RuleRow controls with first/rest joint labels and removal actions.",
-      },
-      {
-        name: "Add row",
-        required: false,
-        description: "An optional add action, with a joint when hasAddJoint is enabled.",
-      },
-      {
-        name: "Feedback",
-        required: false,
-        description: "Empty, maximum and validation messages.",
-      },
-    ],
-  },
-  accessibility: [
-    "label names the list; labels.remove and labels.add name editing actions, and each supplied control needs its own label.",
-  ],
-} satisfies ComponentDoc;

package/src/organisms/SearchableGroupedList.doc.ts

@@ -1,49 +0,0 @@
-import type { ComponentDoc } from "../doc/schema";
-
-/** Usage guidance for SearchableGroupedList. */
-export const doc = {
-  category: "Selection",
-  keywords: ["search", "groups", "list", "tiles"],
-  usage: {
-    description:
-      "Browse host-rendered items in titled groups, filtering locally as text is typed. Use TreeSelect when the result must be a single leaf chosen from two-level groups.",
-    bestPractices: [
-      {
-        guidance: true,
-        description:
-          "Provide stable group keys and globally unique item keys; use itemText for the text to match and placeholder for independently loading groups.",
-      },
-      {
-        guidance: false,
-        description:
-          "Do not expect isDisabled to block host-rendered item actions; it only affects the uncapped list's search control.",
-      },
-    ],
-    anatomy: [
-      {
-        name: "Search",
-        required: true,
-        description: "The local query input with clear action.",
-      },
-      {
-        name: "Group headings",
-        required: true,
-        description: "Titles, optionally toggling collapsed groups.",
-      },
-      {
-        name: "Items",
-        required: true,
-        description:
-          "Host rows or three-column tiles, replaced by group placeholders when supplied.",
-      },
-      {
-        name: "No-match message",
-        required: false,
-        description: "Shown when there are no matching items.",
-      },
-    ],
-  },
-  accessibility: [
-    "Supply labels.search and labels.clear, and scroll.label when using a scrolling region; item renderers supply their own accessible controls.",
-  ],
-} satisfies ComponentDoc;

package/src/organisms/TokenPickerDialog.doc.ts

@@ -1,54 +0,0 @@
-import type { ComponentDoc } from "../doc/schema";
-
-/** Usage guidance for TokenPickerDialog. */
-export const doc = {
-  category: "Overlays",
-  keywords: ["token", "picker", "definition", "dialog"],
-  usage: {
-    description:
-      "Compose a token definition from a group, a leaf, a display name and fallback text. Use TokenTextField to edit the resulting raw token string inline.",
-    bestPractices: [
-      {
-        guidance: true,
-        description:
-          "Keep the definition controlled and reset its draft and items when onGroupChange selects a different group.",
-      },
-      {
-        guidance: false,
-        description:
-          "Do not expect confirmation while loading, without a picked item or with a blank display name; read-only mode hides confirmation.",
-      },
-    ],
-    anatomy: [
-      {
-        name: "Dialog heading",
-        required: true,
-        description: "The supplied title.",
-      },
-      {
-        name: "Group and item selectors",
-        required: true,
-        description:
-          "A group choice and a searchable flat or two-level leaf choice, with a loading skeleton when needed.",
-      },
-      {
-        name: "Fallback text",
-        required: true,
-        description: "The controlled defaultValue field.",
-      },
-      {
-        name: "Display name",
-        required: true,
-        description: "A required name, defaulted from the picked leaf until customized.",
-      },
-      {
-        name: "Actions",
-        required: true,
-        description: "Cancel and, when editable, Insert or Save according to mode.",
-      },
-    ],
-  },
-  accessibility: [
-    "Provide the translated group, item, displayName and defaultValue field labels; the dialog uses Astryx Dialog behavior.",
-  ],
-} satisfies ComponentDoc;

package/src/organisms/TransferPicker.doc.ts

@@ -1,69 +0,0 @@
-import type { ComponentDoc } from "../doc/schema";
-
-/** Usage guidance for TransferPicker. */
-export const doc = {
-  category: "Selection",
-  keywords: ["transfer", "multiple", "picked", "paging"],
-  related: [
-    {
-      name: "ChipListAddPopover",
-      when: "Use compact removable chips and apply checkbox changes as one draft.",
-    },
-  ],
-  usage: {
-    description:
-      "Pick several options in two columns, keeping available rows and removable picks visible together. Use ChipListAddPopover when a compact chip list with an Apply draft is more appropriate.",
-    bestPractices: [
-      {
-        guidance: true,
-        description:
-          "Supply labels.loadMoreError, labels.retry and onRetryLoadMore together for paging recovery. The error pauses automatic loading; clear it and set isLoadingMore while retrying, then update options and hasMore after success.",
-      },
-      {
-        guidance: false,
-        description:
-          "Do not treat select-all as only adding visible rows: when picks already exist, it clears the entire selection, including unknown picks.",
-      },
-      {
-        guidance: true,
-        description:
-          "Supply pickedOptions or pickedLabels for values absent from the loaded options and use onSearchChange when the host performs search.",
-      },
-      {
-        guidance: false,
-        description:
-          "Do not replace the current pick with only the visible options after search or paging; unknown picks are intentionally retained.",
-      },
-    ],
-    anatomy: [
-      {
-        name: "Available column",
-        required: true,
-        description: "Search, a title and checkbox rows, with optional details and select-all.",
-      },
-      {
-        name: "Picked column",
-        required: true,
-        description: "Framed picked rows with optional remove-all and row actions.",
-      },
-      {
-        name: "Loading and paging rows",
-        required: false,
-        description: "Skeletons or a failed-page retry row that preserve loaded content.",
-      },
-      {
-        name: "Host slots",
-        required: false,
-        description: "Toolbar, end header and footer content.",
-      },
-      {
-        name: "Error",
-        required: false,
-        description: "A translated selection problem below the picker.",
-      },
-    ],
-  },
-  accessibility: [
-    "Supply search, clearSearch, picked and remove labels; disabled and read-only states block picking while search remains usable.",
-  ],
-} satisfies ComponentDoc;

package/src/organisms/TreeSearchPanel.doc.ts

@@ -1,43 +0,0 @@
-import type { ComponentDoc } from "../doc/schema";
-
-/** Usage guidance for TreeSearchPanel. */
-export const doc = {
-  category: "Selection",
-  keywords: ["tree", "search", "panel", "paging"],
-  usage: {
-    description:
-      "Compose the search and results panel used inside TreeSelect. Use TreeSelect for a complete trigger and popover around this panel.",
-    bestPractices: [
-      {
-        guidance: true,
-        description:
-          "Keep search value and selectedValue controlled, and use isSearchedByHost when items are already filtered remotely.",
-      },
-      {
-        guidance: false,
-        description:
-          "Do not expect the panel to close a surrounding popover after onPick; its host owns that behavior.",
-      },
-    ],
-    anatomy: [
-      {
-        name: "Search input",
-        required: true,
-        description: "A controlled query that focuses a frame after mounting.",
-      },
-      {
-        name: "Results",
-        required: true,
-        description: "TreeOptions, loading rows or a no-match message.",
-      },
-      {
-        name: "Paging row",
-        required: false,
-        description: "A load-more sentinel, loading placeholders or a retry action.",
-      },
-    ],
-  },
-  accessibility: [
-    "label names the tree and labels supplies the search and clear names; TreeOptions handles row focus and keyboard activation.",
-  ],
-} satisfies ComponentDoc;

package/src/organisms/TreeSelect.doc.ts

@@ -1,56 +0,0 @@
-import type { ComponentDoc } from "../doc/schema";
-
-/** Usage guidance for TreeSelect. */
-export const doc = {
-  category: "Selection",
-  keywords: ["tree", "select", "search", "leaf"],
-  related: [
-    { name: "Select", when: "Choose one value from flat options or sections without a tree." },
-  ],
-  usage: {
-    description:
-      "Choose a single leaf through a searchable two-level tree in a popover. Use Select for a conventional flat or sectioned options list.",
-    bestPractices: [
-      {
-        guidance: true,
-        description:
-          "Supply labels.search, labels.noMatch and labels.clear for the panel. For paging recovery, supply labels.loadMoreError, labels.retry and onRetryLoadMore together; clear the error and set isLoadingMore while retrying, then update items and hasMore after success.",
-      },
-      {
-        guidance: true,
-        description:
-          "Keep item values unique and supply labels.value for a selected leaf that is absent from the loaded items.",
-      },
-      {
-        guidance: false,
-        description:
-          "Do not expect group rows to become selected values or nesting deeper than two levels to render.",
-      },
-    ],
-    anatomy: [
-      {
-        name: "Trigger",
-        required: true,
-        description: "The selected label or placeholder, with loading or read-only presentation.",
-      },
-      {
-        name: "Start addon",
-        required: false,
-        description: "A separate host control sharing the frame, outside the trigger button.",
-      },
-      {
-        name: "Panel",
-        required: false,
-        description: "Search, a tree, and optional paging or retry rows while the popover is open.",
-      },
-      {
-        name: "Error",
-        required: false,
-        description: "A translated problem below the trigger.",
-      },
-    ],
-  },
-  accessibility: [
-    "Supply label even when hidden; the tree supports Up and Down, Enter and Space, and Escape closes the popover.",
-  ],
-} satisfies ComponentDoc;

package/src/theme/AntsomiTheme.doc.ts

@@ -1,23 +0,0 @@
-import type { ComponentDoc } from "../doc/schema";
-
-/** Usage guidance for AntsomiTheme. */
-export const doc = {
-  category: "Theme",
-  keywords: ["theme", "provider", "tokens", "icons", "mode"],
-  usage: {
-    description:
-      "Apply the Antsomi base theme to a subtree and forward Astryx's light, dark or system mode. Extend antsomiTheme with defineTheme and pass the result through theme for a scoped override.",
-    bestPractices: [
-      {
-        guidance: true,
-        description:
-          "Import @antscorp/ui/theme.css separately and load Roboto in the host; nest providers when an override should affect only a subtree.",
-      },
-      {
-        guidance: false,
-        description:
-          "Do not expect the provider to load CSS or fonts, or replace theme tokens with hard-coded colors in consuming views.",
-      },
-    ],
-  },
-} satisfies ComponentDoc;