@nimbus-ds/patterns 1.39.1 → 1.40.0

package/dist/index.d.ts

@@ -1864,6 +1864,13 @@ export interface SummaryStatsItemProperties {
 	 * Brief text that identifies the metric.
 	 */
 	description: string;
+	/**
+	 * Whether this stat is expandable (interactive). When unset, the stat
+	 * inherits the `expandable` value of the SummaryStats container. An explicit
+	 * `true` or `false` overrides the container value. Ignored in the "grid"
+	 * layout. Set it to `false` on stats without children so they stay static.
+	 */
+	expandable?: boolean;
 	/**
 	 * Trend indicator showing the change direction.
 	 */
@@ -1925,6 +1932,8 @@ export interface SummaryStatsProperties {
 	layout?: SummaryStatsLayout;
 	/**
 	 * Enables expandable mode where stats can be clicked to show additional content.
+	 * This is the default for every SummaryStats.Item; an item can override it with
+	 * its own `expandable` prop. Ignored in the "grid" layout.
 	 * @default false
 	 */
 	expandable?: boolean;
@@ -1935,8 +1944,10 @@ export interface SummaryStatsProperties {
 	 */
 	activeStatId?: string | null;
 	/**
-	 * Callback fired when the active stat changes (controlled mode).
-	 * Receives the new active stat id, or `null` when the active stat is deselected.
+	 * Callback fired when the user toggles a stat, in both controlled and
+	 * uncontrolled modes. Receives the new active stat id, or `null` when the
+	 * active stat is deselected. It is not fired when the active stat unmounts,
+	 * loses its children, or becomes static.
 	 */
 	onActiveStatIdChange?: (activeStatId: string | null) => void;
 }
@@ -1953,6 +1964,9 @@ export type SummaryStatsProps = SummaryStatsProperties & Omit<HTMLAttributes<HTM
  * Layout can be horizontal (single row, optionally with scroll/expand) or grid
  * (2-column). When layout is "horizontal" and expandable is true, clicking a
  * stat toggles an expanded area below showing that stat's extra content.
+ * Each SummaryStats.Item can override the container value with its own
+ * `expandable` prop, so static and interactive stats can share a row. Arrow
+ * keys move focus between the interactive stats of the same row.
  *
  * @param props - See SummaryStatsProps
  * @param props.className - Optional CSS class for the root element