cleanplate 0.3.32 → 0.3.34

package/docs/Statistic.md

@@ -1,6 +1,6 @@
 # Statistic Component
 
-Purpose: Displays a labeled numeric metric for dashboards and summary tiles — optional title, formatted value, prefix/suffix, loading state, and semantic value coloring. Use it to highlight KPIs; not for inline tags (`Badge`) or general text (`Typography`). **Margin** uses the **framework-wide spacing suffix rule** (same for all components); see `llms.txt`.
+Purpose: Displays a labeled numeric metric for dashboards and summary tiles — optional title, formatted value, prefix/suffix, loading state, semantic value coloring, and optional card-style layout with icon, progress, description, and footer badge. Use it to highlight KPIs; not for inline tags (`Badge`) or general text (`Typography`). **Margin** uses the **framework-wide spacing suffix rule** (same for all components); see `llms.txt`.
 
 **Note:** `Statistic.Timer` (countdown/countup) is planned for a future release — not in v1.
 
@@ -8,14 +8,19 @@ Purpose: Displays a labeled numeric metric for dashboards and summary tiles —
 
 | Prop | Type | Required | Default | Description |
 | --- | --- | --- | --- | --- |
-| title | ReactNode | no | — | Label above the value row. |
+| title | ReactNode | no | — | Label above the value row (or in the header row when `icon` or `variant="card"`). |
 | value | string \| number | no | — | Metric value; see formatting rules below. |
 | precision | number | no | — | Fixed decimal places when `value` is a number. |
 | groupSeparator | string | no | `","` | Thousands separator for numeric values. |
 | decimalSeparator | string | no | `"."` | Decimal separator for numeric values. |
 | prefix | ReactNode | no | — | Node before value; hidden when `loading`. |
 | suffix | ReactNode | no | — | Node after value; hidden when `loading`. |
-| valueTone | `"default"` \| `"positive"` \| `"negative"` | no | `"default"` | Semantic color on the value text only. |
+| icon | ReactNode | no | — | Node in the header row beside `title` (often `<Icon />`). |
+| description | ReactNode | no | — | Subtext below value/progress (e.g. "8 active members"); hidden when `loading`. |
+| progress | `StatisticProgress` | no | — | Progress bar below value; composes `ProgressBar`. Hidden when `loading`. |
+| footer | `StatisticFooter` | no | — | Bottom row with optional label and badge; hidden when `loading`. |
+| variant | `"plain"` \| `"card"` | no | `"plain"` | `"card"` adds border, padding, and white background. |
+| tone | `"neutral"` \| `"success"` \| `"warning"` \| `"danger"` \| `"muted"` | no | `"neutral"` | Semantic tone for icon accent, value color, card surface (when `variant="card"`), and default `progress` / `footer.badge` variants. |
 | size | `"small"` \| `"medium"` \| `"large"` | no | `"medium"` | Title and value typographic scale. |
 | loading | boolean | no | `false` | Show `Spinner` in value row; title stays visible. |
 | margin | string \| string[] | no | `"0"` | Spacing **suffix** for outer margin. The component adds the `m-` prefix (e.g. `"0"` → m-0, `"b-2"` → m-b-2). |
@@ -29,9 +34,51 @@ Purpose: Displays a labeled numeric metric for dashboards and summary tiles —
 type StatisticSize = "small" | "medium" | "large";
 ```
 
-### StatisticValueTone
+### StatisticTone
 ```typescript
-type StatisticValueTone = "default" | "positive" | "negative";
+type StatisticTone = "neutral" | "success" | "warning" | "danger" | "muted";
+```
+
+| Tone | Use for | Card surface | Value color | Default progress | Default badge |
+| --- | --- | --- | --- | --- | --- |
+| `neutral` | Totals / informational | White | Default | `default` | `default` |
+| `success` | Completed / positive | Green tint | Default | `success` | `success` |
+| `warning` | Attention needed | Orange tint | Default | `warning` | `warning` |
+| `danger` | Critical / overdue | Red tint | Red | `error` | `error` |
+| `muted` | Zero-state / inactive | Gray tint | Muted | `info` | `info` |
+
+Override progress or badge colors with `progress.variant` or `footer.badgeVariant` when needed.
+
+### StatisticVariant
+```typescript
+type StatisticVariant = "plain" | "card";
+```
+
+### StatisticProgress
+```typescript
+type StatisticProgressVariant =
+  | "default"
+  | "primary"
+  | "secondary"
+  | "success"
+  | "info"
+  | "error"
+  | "warning";
+
+interface StatisticProgress {
+  value: number; // 0–100, passed to ProgressBar
+  variant?: StatisticProgressVariant;
+  size?: "small" | "medium" | "large";
+}
+```
+
+### StatisticFooter
+```typescript
+interface StatisticFooter {
+  label?: React.ReactNode;
+  badge?: React.ReactNode; // string renders Badge; ReactNode renders as-is
+  badgeVariant?: BadgeVariant;
+}
 ```
 
 ### SpacingOption
@@ -54,7 +101,12 @@ interface StatisticProps {
   decimalSeparator?: string;
   prefix?: React.ReactNode;
   suffix?: React.ReactNode;
-  valueTone?: StatisticValueTone;
+  icon?: React.ReactNode;
+  description?: React.ReactNode;
+  progress?: StatisticProgress;
+  footer?: StatisticFooter;
+  variant?: StatisticVariant;
+  tone?: StatisticTone;
   size?: StatisticSize;
   loading?: boolean;
   margin?: StatisticMargin;
@@ -106,27 +158,31 @@ import { Statistic, Icon } from "cleanplate";
 <Statistic title="Active Users" value={112893} loading />
 ```
 
-### Value tones
+### Semantic tones
+
+```jsx
+<Statistic variant="card" tone="neutral" title="Total billed" value={9000} prefix="₹" />
+<Statistic variant="card" tone="success" title="Collected" value={3375} progress={{ value: 38 }} />
+<Statistic variant="card" tone="warning" title="Outstanding" value={5625} prefix="₹" />
+<Statistic variant="card" tone="danger" title="Overdue (>30d)" value={0} prefix="₹" />
+<Statistic variant="card" tone="muted" title="Waived" value={0} progress={{ value: 0 }} />
+```
+
+### Value emphasis (plain)
 
 ```jsx
 import { Statistic, Icon } from "cleanplate";
 
 <Statistic
+  variant="card"
+  tone="success"
   title="Active"
   value={11.28}
   precision={2}
-  valueTone="positive"
   prefix={<Icon name="arrow_upward" size="small" />}
   suffix="%"
 />
-<Statistic
-  title="Idle"
-  value={9.3}
-  precision={2}
-  valueTone="negative"
-  prefix={<Icon name="arrow_downward" size="small" />}
-  suffix="%"
-/>
+<Statistic variant="card" tone="danger" title="Overdue" value={0} prefix="₹" />
 ```
 
 ### Pre-formatted string value
@@ -135,22 +191,73 @@ import { Statistic, Icon } from "cleanplate";
 <Statistic title="Revenue" value="¥1.2M" />
 ```
 
-### In a card (composition)
+### Card variant with icon and description
+
+```jsx
+import { Statistic, Icon } from "cleanplate";
+
+<Statistic
+  variant="card"
+  icon={<Icon name="group" size="small" />}
+  title="Total billed"
+  value={9000}
+  prefix="₹"
+  description="8 active members"
+/>
+```
+
+### Progress and footer badge
+
+```jsx
+<Statistic
+  variant="card"
+  tone="success"
+  icon={<Icon name="check_circle" size="small" />}
+  title="Paid dues"
+  value={3}
+  progress={{ value: 38 }}
+  footer={{ label: "of 8 total", badge: "38%" }}
+/>
+```
+
+### Dashboard grid (composition)
 
-CleanPlate has no `Card` component — wrap with `Container` or app markup:
+Use `Container` for multi-card layouts — no built-in grid component:
 
 ```jsx
-import { Statistic, Container, Icon } from "cleanplate";
-
-<Container padding="4" display="block">
-  <Statistic
-    title="Active"
-    value={11.28}
-    precision={2}
-    valueTone="positive"
-    prefix={<Icon name="arrow_upward" size="small" />}
-    suffix="%"
-  />
+import { Statistic, Container, Icon, Typography } from "cleanplate";
+
+<Container padding="4" display="block" gap="4">
+  <Container display="flex" gap="4" style={{ flexWrap: "wrap" }}>
+    <Container display="block" style={{ flex: "1 1 200px" }}>
+      <Statistic
+        variant="card"
+        icon={<Icon name="group" size="small" />}
+        title="Total billed"
+        value={9000}
+        prefix="₹"
+        description="8 active members"
+      />
+    </Container>
+    <Container display="block" style={{ flex: "1 1 200px" }}>
+      <Statistic
+        variant="card"
+        icon={<Icon name="check_circle" size="small" />}
+        title="Collected"
+        value={3375}
+        prefix="₹"
+        progress={{ value: 38, variant: "success", size: "small" }}
+        description="38% collection rate"
+      />
+    </Container>
+  </Container>
+
+  <Typography variant="h5" margin="b-2">
+    Due status breakdown
+  </Typography>
+  <Container display="flex" gap="4" style={{ flexWrap: "wrap" }}>
+    {/* more Statistic cards */}
+  </Container>
 </Container>
 ```
 
@@ -164,21 +271,32 @@ import { Statistic, Container, Icon } from "cleanplate";
 
 ## Behavior Notes
 
-- **Loading:** Title remains visible. The value row shows a `Spinner` sized to match `size`. `prefix` and `suffix` are not rendered while loading. The content row sets `aria-busy={true}` (no `--loading` CSS modifier on the root).
-- **Layout:** Title stacked above a horizontal row (`prefix` + value + `suffix`), baseline-aligned with tabular numerals (`font-variant-numeric: tabular-nums` on the content row).
+- **Loading:** Title and icon remain visible. The value row shows a `Spinner` sized to match `size`. `prefix`, `suffix`, `progress`, `description`, and `footer` are not rendered while loading. The content row sets `aria-busy={true}`.
+- **Header row:** When `variant="card"` or `icon` is set, `title` renders in a horizontal header row with the icon. Otherwise `title` stacks above the value row as before.
+- **Layout:** Value row is horizontal (`prefix` + value + `suffix`), baseline-aligned with tabular numerals (`font-variant-numeric: tabular-nums` on the content row).
+- **Progress:** Composes `ProgressBar` with `progress.value` (0–100). Default bar size is `small`; override via `progress.size`.
+- **Footer badge:** When `footer.badge` is a string, renders `Badge` using `footer.badgeVariant` or the tone default. Pass a `ReactNode` for custom badge content.
 - **Accessibility:** Title renders in a `div` (not a heading) — parent owns page heading hierarchy. Value formatting is skipped while `loading`.
-- **Customization:** Override via root `className` or target documented `cp-` slot classes in CSS (no per-slot `className` or `style` props in v1).
+- **Customization:** Override via root `className` or target documented `cp-` slot classes in CSS (no per-slot `className` or `style` props).
 
 ### Documented slot classes
 
 - `cp-statistic` — root
+- `cp-statistic-card`
 - `cp-statistic-small` | `cp-statistic-medium` | `cp-statistic-large`
+- `cp-statistic-header`
+- `cp-statistic-icon`
 - `cp-statistic-title`
 - `cp-statistic-content`
 - `cp-statistic-prefix`
 - `cp-statistic-value`
-- `cp-statistic-value-positive` | `cp-statistic-value-negative`
+- `cp-statistic-tone-neutral` | `cp-statistic-tone-success` | `cp-statistic-tone-warning` | `cp-statistic-tone-danger` | `cp-statistic-tone-muted`
 - `cp-statistic-suffix`
+- `cp-statistic-progress`
+- `cp-statistic-description`
+- `cp-statistic-footer`
+- `cp-statistic-footer-label`
+- `cp-statistic-footer-badge`
 
 Example override:
 
@@ -191,7 +309,9 @@ Example override:
 ## Related Components / Links
 
 - Spinner (loading state inside value row)
-- Icon (often used in `prefix` / `suffix`)
-- Container (layout and card-style wrappers)
-- Badge (short status labels — not KPI metrics)
+- Icon (header icon, or `prefix` / `suffix`)
+- ProgressBar (composed when `progress` is set)
+- Badge (composed for string `footer.badge`)
+- Container (multi-card dashboard layouts)
+- Typography (section headings above stat groups)
 - Table (tabular data; Statistic for dashboard tiles)

package/llms.txt

@@ -117,10 +117,10 @@ All component documentation is located in the `docs/` folder. The following docu
 
 ### Statistic Component
 - File: `docs/Statistic.md`
-- Purpose: Displays a labeled numeric metric (title + formatted value) with optional prefix/suffix, loading state, and semantic value coloring. For dashboard KPIs and summary tiles.
-- Key Features: `value` string|number (grouping via `groupSeparator`/`decimalSeparator`, `precision`; non-finite numbers → `—`), prefix/suffix ReactNode (hidden when `loading`), `valueTone` default|positive|negative, sizes small|medium|large, `loading` (Spinner in value row; `aria-busy` on content), `margin` suffix API, `className`, `dataTestId`, documented `cp-` slot classes for CSS overrides
-- Types: StatisticProps, StatisticSize, StatisticValueTone, StatisticMargin, SpacingOption
-- Related Components: Spinner (loading), Icon (prefix/suffix), Container (card/grid layout), Badge (status labels — not KPIs), Table (tabular data vs KPI tiles)
+- Purpose: Displays a labeled numeric metric (title + formatted value) with optional prefix/suffix, loading state, semantic value coloring, and card-style dashboard tiles. For dashboard KPIs and summary tiles.
+- Key Features: `value` string|number (grouping via `groupSeparator`/`decimalSeparator`, `precision`; non-finite numbers → `—`), prefix/suffix ReactNode (hidden when `loading`), `variant` plain|card, `tone` neutral|success|warning|danger|muted (icon, value, card surface, default progress/badge), `icon` header slot, `description` subtext, `progress` (composes ProgressBar), `footer` label+badge (composes Badge), sizes small|medium|large, `loading` (Spinner in value row; `aria-busy` on content), `margin` suffix API, `className`, `dataTestId`, documented `cp-` slot classes for CSS overrides
+- Types: StatisticProps, StatisticSize, StatisticTone, StatisticVariant, StatisticProgress, StatisticProgressVariant, StatisticFooter, StatisticMargin, SpacingOption
+- Related Components: Spinner (loading), Icon (header/prefix/suffix), ProgressBar (progress slot), Badge (footer badge), Container (multi-card grid layout), Typography (section headings), Table (tabular data vs KPI tiles)
 - **Not** in v1: `Statistic.Timer` (countdown/countup), `formatter` prop, per-slot `className`/`style` — planned or use string `value` / slot class overrides instead
 
 ### Stepper Component

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cleanplate",
-  "version": "0.3.32",
+  "version": "0.3.34",
   "description": "CleanPlate - A Headless React UI Framework",
   "files": [
     "dist",