@bitforgehq/ui 0.3.0 → 0.3.2

package/ai/REFERENCE.index.json

@@ -1,6 +1,13 @@
 {
   "generatedFrom": "tools/gen-ai-docs.ts",
   "symbols": [
+    {
+      "name": "BF_COLOR_SCHEME_STORAGE",
+      "slug": "bf_color_scheme_storage",
+      "kind": "token",
+      "entryPoint": "@bitforgehq/ui",
+      "summary": "Injection token for the store that keeps the colour scheme choice between visits"
+    },
     {
       "name": "BF_DEFAULT_LABELS",
       "slug": "bf_default_labels",
@@ -29,6 +36,13 @@
       "entryPoint": "@bitforgehq/ui",
       "summary": "Injection token holding the user-facing strings in effect for an injector"
     },
+    {
+      "name": "BF_SIDEBAR_STATE_STORAGE",
+      "slug": "bf_sidebar_state_storage",
+      "kind": "token",
+      "entryPoint": "@bitforgehq/ui",
+      "summary": "Injection token for the store that keeps the collapsed sidebar between visits"
+    },
     {
       "name": "BF_TAB_BAR",
       "slug": "bf_tab_bar",
@@ -64,6 +78,20 @@
       "entryPoint": "@bitforgehq/ui",
       "summary": "The four tones of an alert, from neutral information to a danger message"
     },
+    {
+      "name": "BfAppFrameBreakpoint",
+      "slug": "bf-app-frame-breakpoint",
+      "kind": "type",
+      "entryPoint": "@bitforgehq/ui",
+      "summary": "The breakpoint where an app frame switches from its header bar to the sidebar"
+    },
+    {
+      "name": "BfAppFrameContentWidth",
+      "slug": "bf-app-frame-content-width",
+      "kind": "type",
+      "entryPoint": "@bitforgehq/ui",
+      "summary": "The maximum width of an app frame's content column, from medium to full"
+    },
     {
       "name": "BfAutocapitalize",
       "slug": "bf-autocapitalize",
@@ -85,6 +113,13 @@
       "entryPoint": "@bitforgehq/ui",
       "summary": "The four colour schemes of an avatar behind its initials or icon"
     },
+    {
+      "name": "BfBadgeAppearance",
+      "slug": "bf-badge-appearance",
+      "kind": "type",
+      "entryPoint": "@bitforgehq/ui",
+      "summary": "Every badge tone, the five variants plus the informational info tone"
+    },
     {
       "name": "BfBadgeVariant",
       "slug": "bf-badge-variant",
@@ -92,6 +127,13 @@
       "entryPoint": "@bitforgehq/ui",
       "summary": "The five tones of a badge, from neutral counts to danger states"
     },
+    {
+      "name": "BfButtonAppearance",
+      "slug": "bf-button-appearance",
+      "kind": "type",
+      "entryPoint": "@bitforgehq/ui",
+      "summary": "Every button style, the five variants plus the quiet neutral ghost"
+    },
     {
       "name": "BfButtonSize",
       "slug": "bf-button-size",
@@ -113,6 +155,20 @@
       "entryPoint": "@bitforgehq/ui",
       "summary": "The five visual styles of a button, from filled primary to plain text"
     },
+    {
+      "name": "BfCalendarDisabledDate",
+      "slug": "bf-calendar-disabled-date",
+      "kind": "type",
+      "entryPoint": "@bitforgehq/ui",
+      "summary": "A function that marks an ISO date as not pickable in a calendar"
+    },
+    {
+      "name": "BfCalendarWeekday",
+      "slug": "bf-calendar-weekday",
+      "kind": "type",
+      "entryPoint": "@bitforgehq/ui",
+      "summary": "A weekday number from 0 for Sunday to 6 for Saturday, as Date counts"
+    },
     {
       "name": "BfCardPadding",
       "slug": "bf-card-padding",
@@ -141,6 +197,20 @@
       "entryPoint": "@bitforgehq/ui",
       "summary": "The two chip colours, a soft tonal tint or a dark ink fill"
     },
+    {
+      "name": "BfColorScheme",
+      "slug": "bf-color-scheme",
+      "kind": "type",
+      "entryPoint": "@bitforgehq/ui",
+      "summary": "The colour scheme choice, following the system or forcing light or dark"
+    },
+    {
+      "name": "BfColorSchemeService",
+      "slug": "bf-color-scheme-service",
+      "kind": "service",
+      "entryPoint": "@bitforgehq/ui",
+      "summary": "The app colour scheme choice and dark state, applied to html and stored"
+    },
     {
       "name": "BfCompareWith",
       "slug": "bf-compare-with",
@@ -162,6 +232,20 @@
       "entryPoint": "@bitforgehq/ui",
       "summary": "The size steps provideBfDefaults sets, each one falling back to the parent"
     },
+    {
+      "name": "BfDescriptionListLayout",
+      "slug": "bf-description-list-layout",
+      "kind": "type",
+      "entryPoint": "@bitforgehq/ui",
+      "summary": "The two description list layouts, divided label-value rows or a grid of tiles"
+    },
+    {
+      "name": "BfEmptyStateHeading",
+      "slug": "bf-empty-state-heading",
+      "kind": "type",
+      "entryPoint": "@bitforgehq/ui",
+      "summary": "The heading level of an empty state title, one for a whole page"
+    },
     {
       "name": "BfEmptyStateHeadingLevel",
       "slug": "bf-empty-state-heading-level",
@@ -253,6 +337,13 @@
       "entryPoint": "@bitforgehq/ui",
       "summary": "The strings provideBfLabels replaces, each one falling back to the parent"
     },
+    {
+      "name": "BfPageHeaderHeadingLevel",
+      "slug": "bf-page-header-heading-level",
+      "kind": "type",
+      "entryPoint": "@bitforgehq/ui",
+      "summary": "The heading level of a page header title, one for a page or two"
+    },
     {
       "name": "BfProgressSize",
       "slug": "bf-progress-size",
@@ -302,6 +393,13 @@
       "entryPoint": "@bitforgehq/ui",
       "summary": "One choice of a select with its value, its label and a disabled flag"
     },
+    {
+      "name": "BfSidebarStateService",
+      "slug": "bf-sidebar-state-service",
+      "kind": "service",
+      "entryPoint": "@bitforgehq/ui",
+      "summary": "The sidebar's collapsed state, kept in storage between visits of the app"
+    },
     {
       "name": "BfSize",
       "slug": "bf-size",
@@ -309,6 +407,13 @@
       "entryPoint": "@bitforgehq/ui",
       "summary": "The three height steps every sized field and control shares"
     },
+    {
+      "name": "BfSkeletonShape",
+      "slug": "bf-skeleton-shape",
+      "kind": "type",
+      "entryPoint": "@bitforgehq/ui",
+      "summary": "The three skeleton shapes, text lines, a rectangle or a circle"
+    },
     {
       "name": "BfSpinnerSize",
       "slug": "bf-spinner-size",
@@ -316,6 +421,34 @@
       "entryPoint": "@bitforgehq/ui",
       "summary": "The three spinner diameters, from inline text to a page loading state"
     },
+    {
+      "name": "BfStatAppearance",
+      "slug": "bf-stat-appearance",
+      "kind": "type",
+      "entryPoint": "@bitforgehq/ui",
+      "summary": "The three stat surfaces, plain, an outlined card or a sunken tile"
+    },
+    {
+      "name": "BfStatTrend",
+      "slug": "bf-stat-trend",
+      "kind": "type",
+      "entryPoint": "@bitforgehq/ui",
+      "summary": "The three directions of a stat's delta pill, up, down or no change"
+    },
+    {
+      "name": "BfStatTrendIntent",
+      "slug": "bf-stat-trend-intent",
+      "kind": "type",
+      "entryPoint": "@bitforgehq/ui",
+      "summary": "Whether a rising or a falling figure is the good news for a stat"
+    },
+    {
+      "name": "BfStatVariant",
+      "slug": "bf-stat-variant",
+      "kind": "type",
+      "entryPoint": "@bitforgehq/ui",
+      "summary": "The two stat surfaces, plain on its container or an outlined card tile"
+    },
     {
       "name": "BfTabBarController",
       "slug": "bf-tab-bar-controller",
@@ -330,6 +463,62 @@
       "entryPoint": "@bitforgehq/ui",
       "summary": "What each tab reads from its tab bar: the selection, tab stop and link mode"
     },
+    {
+      "name": "BfTableAlign",
+      "slug": "bf-table-align",
+      "kind": "type",
+      "entryPoint": "@bitforgehq/ui",
+      "summary": "The inline alignment of a table column, start for text or end for numbers"
+    },
+    {
+      "name": "BfTableCellContext",
+      "slug": "bf-table-cell-context",
+      "kind": "interface",
+      "entryPoint": "@bitforgehq/ui",
+      "summary": "The row and its index that a custom table cell template receives"
+    },
+    {
+      "name": "BfTableCellDirective",
+      "slug": "bf-table-cell-directive",
+      "kind": "directive",
+      "entryPoint": "@bitforgehq/ui",
+      "summary": "Custom template for the cells of one table column, with the row typed"
+    },
+    {
+      "name": "BfTableColumn",
+      "slug": "bf-table-column",
+      "kind": "interface",
+      "entryPoint": "@bitforgehq/ui",
+      "summary": "One table column with its row key, header label, sorting and alignment"
+    },
+    {
+      "name": "BfTableRowKey",
+      "slug": "bf-table-row-key",
+      "kind": "type",
+      "entryPoint": "@bitforgehq/ui",
+      "summary": "Function that returns the unique string key of one table row"
+    },
+    {
+      "name": "BfTableSort",
+      "slug": "bf-table-sort",
+      "kind": "interface",
+      "entryPoint": "@bitforgehq/ui",
+      "summary": "The column key and direction a table is sorted by, set by its headers"
+    },
+    {
+      "name": "BfTableSortDirection",
+      "slug": "bf-table-sort-direction",
+      "kind": "type",
+      "entryPoint": "@bitforgehq/ui",
+      "summary": "The direction a sorted table column is in, ascending or descending"
+    },
+    {
+      "name": "BfTableStack",
+      "slug": "bf-table-stack",
+      "kind": "type",
+      "entryPoint": "@bitforgehq/ui",
+      "summary": "When a table stacks its rows into cards: never, when narrow, or under touch"
+    },
     {
       "name": "BfTabLinks",
       "slug": "bf-tab-links",
@@ -358,6 +547,13 @@
       "entryPoint": "@bitforgehq/ui",
       "summary": "The default error text of each validator kind, shown under a form field"
     },
+    {
+      "name": "provideBfColorScheme",
+      "slug": "provide-bf-color-scheme",
+      "kind": "function",
+      "entryPoint": "@bitforgehq/ui",
+      "summary": "Applies the stored colour scheme choice to html, for desktop web apps"
+    },
     {
       "name": "provideBfDefaults",
       "slug": "provide-bf-defaults",
@@ -372,6 +568,13 @@
       "entryPoint": "@bitforgehq/ui",
       "summary": "Replaces built-in strings for an app or a sub-tree, such as a translation"
     },
+    {
+      "name": "provideBfSidebarState",
+      "slug": "provide-bf-sidebar-state",
+      "kind": "function",
+      "entryPoint": "@bitforgehq/ui",
+      "summary": "Remembers the collapsed sidebar between visits, for desktop web apps"
+    },
     {
       "name": "BF_DESKTOP_TOAST_DEFAULTS",
       "slug": "bf_desktop_toast_defaults",
@@ -400,6 +603,27 @@
       "entryPoint": "@bitforgehq/ui/overlay",
       "summary": "Optional injection token through which a host shell plugs into the overlay core"
     },
+    {
+      "name": "BF_SIDE_PANEL_DATA",
+      "slug": "bf_side_panel_data",
+      "kind": "token",
+      "entryPoint": "@bitforgehq/ui/overlay",
+      "summary": "Injection token carrying the data a side panel was opened with, for its content"
+    },
+    {
+      "name": "BfComboboxFilter",
+      "slug": "bf-combobox-filter",
+      "kind": "type",
+      "entryPoint": "@bitforgehq/ui/overlay",
+      "summary": "Decides whether a combobox option matches the text typed into the field"
+    },
+    {
+      "name": "BfComboboxOption",
+      "slug": "bf-combobox-option",
+      "kind": "interface",
+      "entryPoint": "@bitforgehq/ui/overlay",
+      "summary": "One combobox choice with its value, label, description, group and disabled flag"
+    },
     {
       "name": "BfComponentOverlayRef",
       "slug": "bf-component-overlay-ref",
@@ -435,6 +659,20 @@
       "entryPoint": "@bitforgehq/ui/overlay",
       "summary": "The two widths a confirm dialog comes in, small or medium"
     },
+    {
+      "name": "BfDateInputPicker",
+      "slug": "bf-date-input-picker",
+      "kind": "type",
+      "entryPoint": "@bitforgehq/ui/overlay",
+      "summary": "Whether a date input offers a calendar popover besides typing"
+    },
+    {
+      "name": "BfDateTimeInputPicker",
+      "slug": "bf-date-time-input-picker",
+      "kind": "type",
+      "entryPoint": "@bitforgehq/ui/overlay",
+      "summary": "Whether a date and time input offers a calendar and time list popover"
+    },
     {
       "name": "BfDesktopToastConfig",
       "slug": "bf-desktop-toast-config",
@@ -589,6 +827,13 @@
       "entryPoint": "@bitforgehq/ui/overlay",
       "summary": "Options of an overlay: its data, backdrop, focus, dismissal, position and motion"
     },
+    {
+      "name": "BfOverlayPlacement",
+      "slug": "bf-overlay-placement",
+      "kind": "type",
+      "entryPoint": "@bitforgehq/ui/overlay",
+      "summary": "Where an overlay panel sits: a viewport position or full height at the end"
+    },
     {
       "name": "BfOverlayPosition",
       "slug": "bf-overlay-position",
@@ -638,6 +883,55 @@
       "entryPoint": "@bitforgehq/ui/overlay",
       "summary": "The context a template opened as an overlay receives: its ref and data"
     },
+    {
+      "name": "BfPopoverPlacement",
+      "slug": "bf-popover-placement",
+      "kind": "type",
+      "entryPoint": "@bitforgehq/ui/overlay",
+      "summary": "Where a popover opens against its trigger, above or below, at either end"
+    },
+    {
+      "name": "BfPopoverTriggerDirective",
+      "slug": "bf-popover-trigger-directive",
+      "kind": "directive",
+      "entryPoint": "@bitforgehq/ui/overlay",
+      "summary": "Opens an anchored, non-modal popover panel from any element or button"
+    },
+    {
+      "name": "BfSidePanelConfig",
+      "slug": "bf-side-panel-config",
+      "kind": "interface",
+      "entryPoint": "@bitforgehq/ui/overlay",
+      "summary": "Options of a side panel: its data, width, modality, name and injector"
+    },
+    {
+      "name": "BfSidePanelRef",
+      "slug": "bf-side-panel-ref",
+      "kind": "class",
+      "entryPoint": "@bitforgehq/ui/overlay",
+      "summary": "Handle on an open side panel that closes it and resolves with its result"
+    },
+    {
+      "name": "BfSidePanelService",
+      "slug": "bf-side-panel-service",
+      "kind": "service",
+      "entryPoint": "@bitforgehq/ui/overlay",
+      "summary": "Opens a full-height panel from the end edge, modal or beside the page"
+    },
+    {
+      "name": "BfSidePanelTemplateContext",
+      "slug": "bf-side-panel-template-context",
+      "kind": "interface",
+      "entryPoint": "@bitforgehq/ui/overlay",
+      "summary": "The context a template opened as a side panel receives: its ref and its data"
+    },
+    {
+      "name": "BfSidePanelWidth",
+      "slug": "bf-side-panel-width",
+      "kind": "type",
+      "entryPoint": "@bitforgehq/ui/overlay",
+      "summary": "The side panel widths, from a 360 px detail list to a 640 px form"
+    },
     {
       "name": "BfStackedOverlay",
       "slug": "bf-stacked-overlay",
@@ -645,6 +939,20 @@
       "entryPoint": "@bitforgehq/ui/overlay",
       "summary": "What the overlay stack needs of an overlay: a way to close it"
     },
+    {
+      "name": "BfTimeInputHourCycle",
+      "slug": "bf-time-input-hour-cycle",
+      "kind": "type",
+      "entryPoint": "@bitforgehq/ui/overlay",
+      "summary": "A twelve-hour clock with AM and PM, or a twenty-four-hour clock"
+    },
+    {
+      "name": "BfTimeInputPicker",
+      "slug": "bf-time-input-picker",
+      "kind": "type",
+      "entryPoint": "@bitforgehq/ui/overlay",
+      "summary": "Whether a time input offers a popover list of times besides typing"
+    },
     {
       "name": "BfToastAction",
       "slug": "bf-toast-action",
@@ -673,6 +981,20 @@
       "entryPoint": "@bitforgehq/ui/overlay",
       "summary": "Handle on a shown or queued toast that dismisses it and reports why it ended"
     },
+    {
+      "name": "BfTooltipDirective",
+      "slug": "bf-tooltip-directive",
+      "kind": "directive",
+      "entryPoint": "@bitforgehq/ui/overlay",
+      "summary": "Adds a hover and keyboard-focus tooltip to any control on desktop"
+    },
+    {
+      "name": "BfTooltipPlacement",
+      "slug": "bf-tooltip-placement",
+      "kind": "type",
+      "entryPoint": "@bitforgehq/ui/overlay",
+      "summary": "Which side of its element a tooltip sits on: top, bottom, start or end"
+    },
     {
       "name": "fadeDown",
       "slug": "fade-down",
@@ -750,6 +1072,20 @@
       "entryPoint": "@bitforgehq/ui/overlay",
       "summary": "Slides an element down out of place, the exit animation of a bottom sheet"
     },
+    {
+      "name": "slideInFromEnd",
+      "slug": "slide-in-from-end",
+      "kind": "function",
+      "entryPoint": "@bitforgehq/ui/overlay",
+      "summary": "Slides an element in from the inline end, the enter animation of a side panel"
+    },
+    {
+      "name": "slideOutToEnd",
+      "slug": "slide-out-to-end",
+      "kind": "function",
+      "entryPoint": "@bitforgehq/ui/overlay",
+      "summary": "Slides an element out past the inline end, the exit animation of a side panel"
+    },
     {
       "name": "slideUp",
       "slug": "slide-up",
@@ -1366,6 +1702,90 @@
       "entryPoint": "@bitforgehq/ui/mobile",
       "summary": "The router setting the mobile shell's stack needs, passed to provideRouter"
     },
+    {
+      "name": "BfBarChartOrientation",
+      "slug": "bf-bar-chart-orientation",
+      "kind": "type",
+      "entryPoint": "@bitforgehq/ui/charts",
+      "summary": "The two bar directions, vertical columns or horizontal bars"
+    },
+    {
+      "name": "BfChartCardHeadingLevel",
+      "slug": "bf-chart-card-heading-level",
+      "kind": "type",
+      "entryPoint": "@bitforgehq/ui/charts",
+      "summary": "Heading level of a chart card title, two on a page or three inside"
+    },
+    {
+      "name": "BfChartCurve",
+      "slug": "bf-chart-curve",
+      "kind": "type",
+      "entryPoint": "@bitforgehq/ui/charts",
+      "summary": "The two line shapes, straight segments or a smooth monotone curve"
+    },
+    {
+      "name": "BfChartLegendPosition",
+      "slug": "bf-chart-legend-position",
+      "kind": "type",
+      "entryPoint": "@bitforgehq/ui/charts",
+      "summary": "The legend positions of a chart, above or below the plot, or none"
+    },
+    {
+      "name": "BfChartSeries",
+      "slug": "bf-chart-series",
+      "kind": "interface",
+      "entryPoint": "@bitforgehq/ui/charts",
+      "summary": "One named series of chart values, one per category, null for a gap"
+    },
+    {
+      "name": "BfChartValueFormat",
+      "slug": "bf-chart-value-format",
+      "kind": "type",
+      "entryPoint": "@bitforgehq/ui/charts",
+      "summary": "Function that formats one chart value for axes, tooltips and the table"
+    },
+    {
+      "name": "BfDonutSlice",
+      "slug": "bf-donut-slice",
+      "kind": "interface",
+      "entryPoint": "@bitforgehq/ui/charts",
+      "summary": "One labelled slice of a donut chart with its value"
+    },
+    {
+      "name": "BfCalendarHarness",
+      "slug": "bf-calendar-harness",
+      "kind": "class",
+      "entryPoint": "@bitforgehq/ui/testing",
+      "summary": "Test harness for the calendar: reads the month and picks a date by ISO string"
+    },
+    {
+      "name": "BfChartHarness",
+      "slug": "bf-chart-harness",
+      "kind": "class",
+      "entryPoint": "@bitforgehq/ui/testing",
+      "summary": "Test harness for the charts: reads the series, toggles one and reads the data table"
+    },
+    {
+      "name": "BfComboboxHarness",
+      "slug": "bf-combobox-harness",
+      "kind": "class",
+      "entryPoint": "@bitforgehq/ui/testing",
+      "summary": "Test harness for the comboboxes: types, reads and picks options and tags"
+    },
+    {
+      "name": "BfDateInputHarness",
+      "slug": "bf-date-input-harness",
+      "kind": "class",
+      "entryPoint": "@bitforgehq/ui/testing",
+      "summary": "Test harness for the date input: types a date or picks one in its calendar"
+    },
+    {
+      "name": "BfDateTimeInputHarness",
+      "slug": "bf-date-time-input-harness",
+      "kind": "class",
+      "entryPoint": "@bitforgehq/ui/testing",
+      "summary": "Test harness for the date and time input: types or picks a date and time"
+    },
     {
       "name": "BfDesktopToastHarness",
       "slug": "bf-desktop-toast-harness",
@@ -1415,6 +1835,20 @@
       "entryPoint": "@bitforgehq/ui/testing",
       "summary": "Test harness for a menu row: its text, disabled, checked and submenu state"
     },
+    {
+      "name": "BfPaginationHarness",
+      "slug": "bf-pagination-harness",
+      "kind": "class",
+      "entryPoint": "@bitforgehq/ui/testing",
+      "summary": "Test harness for pagination: reads the current page and moves between pages"
+    },
+    {
+      "name": "BfPopoverHarness",
+      "slug": "bf-popover-harness",
+      "kind": "class",
+      "entryPoint": "@bitforgehq/ui/testing",
+      "summary": "Test harness for a popover: opens and closes it and reads its panel"
+    },
     {
       "name": "BfRadioGroupHarness",
       "slug": "bf-radio-group-harness",
@@ -1436,6 +1870,34 @@
       "entryPoint": "@bitforgehq/ui/testing",
       "summary": "Test harness for the select: reads its label and options and picks one"
     },
+    {
+      "name": "BfSidebarToggleHarness",
+      "slug": "bf-sidebar-toggle-harness",
+      "kind": "class",
+      "entryPoint": "@bitforgehq/ui/testing",
+      "summary": "Test harness for a sidebar toggle: reads and flips the collapsed sidebar"
+    },
+    {
+      "name": "BfSidePanelHarness",
+      "slug": "bf-side-panel-harness",
+      "kind": "class",
+      "entryPoint": "@bitforgehq/ui/testing",
+      "summary": "Test harness for a side panel: its title, its close button and its state"
+    },
+    {
+      "name": "BfTabGroupHarness",
+      "slug": "bf-tab-group-harness",
+      "kind": "class",
+      "entryPoint": "@bitforgehq/ui/testing",
+      "summary": "Test harness for the tab group: reads its tabs and panel and selects a tab"
+    },
+    {
+      "name": "BfTableHarness",
+      "slug": "bf-table-harness",
+      "kind": "class",
+      "entryPoint": "@bitforgehq/ui/testing",
+      "summary": "Test harness for the data table: reads rows and cells, sorts and selects rows"
+    },
     {
       "name": "BfTestingOptions",
       "slug": "bf-testing-options",
@@ -1443,6 +1905,20 @@
       "entryPoint": "@bitforgehq/ui/testing",
       "summary": "Options of the test providers: the size defaults and labels a spec runs with"
     },
+    {
+      "name": "BfTimeInputHarness",
+      "slug": "bf-time-input-harness",
+      "kind": "class",
+      "entryPoint": "@bitforgehq/ui/testing",
+      "summary": "Test harness for the time input: types a time or picks one from its list"
+    },
+    {
+      "name": "BfTooltipHarness",
+      "slug": "bf-tooltip-harness",
+      "kind": "class",
+      "entryPoint": "@bitforgehq/ui/testing",
+      "summary": "Test harness for a tooltip: shows it, reads its text and whether it shows"
+    },
     {
       "name": "installBfJsdomShims",
       "slug": "install-bf-jsdom-shims",