@squadbase/vantage 0.7.0-dev1.5d49eae → 0.7.0-dev1.6e23119

package/registry/ui/chart-frame.tsx

@@ -1428,6 +1428,8 @@ export interface ChartFrameProps extends Omit<HTMLAttributes<HTMLElement>, "titl
   plotRole?: "img" | "group"
   /** 値の表。画面には出さず(`sr-only`)、スクリーンリーダー向けに図の中に置く。`chartDataTable` で作る。 */
   dataTable?: ChartDataTable
+  /** プロットの下に常に出す小さな注記(近似値である旨など)。読み込み中・空のときも出す。 */
+  footnote?: string
   /** プロット(チャート本体)。読み込み中・空のときは描かない。 */
   children?: ReactNode
 }
@@ -1448,6 +1450,7 @@ export const ChartFrame = forwardRef<HTMLDivElement, ChartFrameProps>(function C
     ariaLabel,
     plotRole = "img",
     dataTable,
+    footnote,
     className,
     children,
     ...props
@@ -1496,6 +1499,11 @@ export const ChartFrame = forwardRef<HTMLDivElement, ChartFrameProps>(function C
           <ChartFrameContext.Provider value>{children}</ChartFrameContext.Provider>
         )}
       </div>
+      {footnote && (
+        <p data-slot="chart-frame-footnote" className="text-xs leading-snug text-muted-foreground">
+          {footnote}
+        </p>
+      )}
       {state === "ready" && dataTable && dataTable.rows.length > 0 && (
         <ChartDataTableView table={dataTable} fallbackCaption={title ?? ariaLabel} />
       )}

package/registry/ui/combo-chart.tsx

@@ -3,7 +3,8 @@
 "use client"
 
 /**
- * ComboChart — bars, lines and areas on one category / time axis, with up to two value axes (left and right).
+ * ComboChart — bars, lines and areas on one category / time axis, with up to two value axes (left and right); use it only to migrate a Tableau dual-axis sheet, and use `PairedChart` for a new dashboard.
+ *
  * It exists to reproduce a Tableau dual-axis sheet faithfully (a Pareto: sales as bars, the cumulative share as a
  * line on the right). For a new dashboard prefer PairedChart, which stacks the two measures in panels over a
  * shared axis instead of reading two scales off one plot.

package/registry/ui/dashboard-card.tsx

@@ -3,7 +3,9 @@
 "use client"
 
 /**
- * DashboardCard — the tighter card used for dashboard tiles: smaller padding
+ * DashboardCardPreset — a card (title, description, action, content) for one tile that holds a chart, ranking or table; not for a single KPI, since `KpiCard` is itself a card.
+ *
+ * `DashboardCard` is the tighter card used for dashboard tiles: smaller padding
  * than the plain `Card`, a title/description/action header, and a matching
  * skeleton for the loading state. `DashboardCardPreset` wires the common
  * arrangement in one prop-driven component.

package/registry/ui/data-table.tsx

@@ -3,7 +3,9 @@
 "use client"
 
 /**
- * DataTable — a compound table over TanStack Table. `<DataTable>` owns the
+ * DataTablePreset — a table (toolbar, body, pagination) over TanStack Table.
+ *
+ * `DataTable` is the compound form: `<DataTable>` owns the
  * table instance and publishes it on context; the toolbar, body, pagination and
  * column-visibility parts read from that context, so a page composes only the
  * pieces it wants. `DataTablePreset` assembles the usual arrangement.

package/registry/ui/delta.tsx

@@ -3,7 +3,9 @@
 "use client"
 
 /**
- * Delta — the change of a value against a comparison, rendered as arrow + signed
+ * Delta — the change of a value against a comparison, as arrow + signed change + comparison label on one line; it is not a card, so place it beside a value.
+ *
+ * It renders as arrow + signed
  * change + comparison label ("↑ +12.4% vs. prior month"; ja: "↑ +12.4% 前月比") on one line, in the page's
  * language (`<html lang>`) unless `locale` is given.
  *

package/registry/ui/filter-bar.tsx

@@ -3,7 +3,9 @@
 "use client"
 
 /**
- * FilterBar — a compound filter row. `<FilterBar>` holds the (always
+ * FilterBarPreset — a whole filter row built from a `FilterConfig[]`, placed at the top of a page or section.
+ *
+ * `FilterBar` is the compound form: `<FilterBar>` holds the (always
  * controlled) filter values on context; the select, multi-select, active-chip
  * and clear parts read and update them. `FilterBarPreset` builds the whole row
  * from a `FilterConfig[]`.