# BurstGraph

A radial burst drawn on a canvas, with category-colored points spraying outward distributed by value, for decorative categorical texture.

Version: 0.2.0-preview.1 (preview)
Content digest: 70ac710f4d22dce040e7ac593379ba8aca9dcb59a0b9c0f839819cae0e2bb721
Contract kind: source-derived
Source: packages/design-system/src/components/visualizations/BurstGraph/BurstGraph.tsx

## Guidance

{
  "summary": "A radial burst drawn on a canvas, with category-colored points spraying outward distributed by value, for decorative categorical texture.",
  "guidance": [
    {
      "heading": "Overview",
      "body": "A radial burst around a single headline stat: the `value` + `label` sit in the center while\ncategory points spray outward."
    },
    {
      "heading": "When to use",
      "body": "Use BurstGraph as a hero KPI when you want one big number with categorical texture behind it -\nthe points distribute by each `items` value and take their category `color` (falling back to\n`accentColor` when a category has none). Like `BubbleMatrix`, it conveys feel, not precise\nreads.\n\nPick `BubbleMatrix` instead for a scan-field layout, or `CategoryBars`/`ActionOrbs` when the\ncategory magnitudes must be read precisely rather than felt. For a headline number paired with\na real trend line, use `MetricLineChartCard`.\n\nNot currently used in the app."
    }
  ],
  "usage": [],
  "examples": [],
  "source": "packages/design-system/src/components/visualizations/BurstGraph/BurstGraph.mdx",
  "status": "local-preview",
  "note": "Guidance is read from local documentation, originally imported from the frozen source. Platform assertions in guidance are not parity verification."
}

## Contract and public API

```json
{
  "props": [
    {
      "name": "items",
      "type": "readonly CategoryDatum[]",
      "declared_type": "readonly CategoryDatum[]",
      "required": true,
      "description": "Category values used to distribute and color burst points.",
      "source": {
        "path": "packages/design-system/src/components/visualizations/types.ts",
        "line": 103
      }
    },
    {
      "name": "accentColor",
      "type": "string | undefined",
      "declared_type": "string",
      "required": false,
      "description": "Optional accent color used when no category color is available.",
      "source": {
        "path": "packages/design-system/src/components/visualizations/types.ts",
        "line": 105
      }
    },
    {
      "name": "ariaLabel",
      "type": "string | undefined",
      "declared_type": "string",
      "required": false,
      "description": "Accessible label for meaningful chart content.",
      "source": {
        "path": "packages/design-system/src/components/visualizations/types.ts",
        "line": 107
      }
    },
    {
      "name": "testId",
      "type": "string | undefined",
      "declared_type": "string",
      "required": false,
      "description": "Optional test selector.",
      "source": {
        "path": "packages/design-system/src/components/visualizations/types.ts",
        "line": 109
      }
    }
  ],
  "prop_shapes": {},
  "api": {
    "method": "typescript-type-checker",
    "typescript_version": "5.9.3",
    "public_export": "BurstGraph",
    "public_path": "BurstGraph",
    "import_path": "@cloakedinc/design-system",
    "root_kind": "component",
    "entrypoints": [
      {
        "name": "BurstGraph",
        "signature": 1,
        "visibility": "public",
        "source": {
          "path": "packages/design-system/src/components/visualizations/BurstGraph/BurstGraph.tsx",
          "line": 12
        },
        "props_type": "BurstGraphProps",
        "props": [
          {
            "name": "items",
            "type": "readonly CategoryDatum[]",
            "declared_type": "readonly CategoryDatum[]",
            "required": true,
            "description": "Category values used to distribute and color burst points.",
            "source": {
              "path": "packages/design-system/src/components/visualizations/types.ts",
              "line": 103
            }
          },
          {
            "name": "accentColor",
            "type": "string | undefined",
            "declared_type": "string",
            "required": false,
            "description": "Optional accent color used when no category color is available.",
            "source": {
              "path": "packages/design-system/src/components/visualizations/types.ts",
              "line": 105
            }
          },
          {
            "name": "ariaLabel",
            "type": "string | undefined",
            "declared_type": "string",
            "required": false,
            "description": "Accessible label for meaningful chart content.",
            "source": {
              "path": "packages/design-system/src/components/visualizations/types.ts",
              "line": 107
            }
          },
          {
            "name": "testId",
            "type": "string | undefined",
            "declared_type": "string",
            "required": false,
            "description": "Optional test selector.",
            "source": {
              "path": "packages/design-system/src/components/visualizations/types.ts",
              "line": 109
            }
          }
        ],
        "branches": [],
        "constraints": [],
        "extraction_status": "extracted"
      }
    ],
    "type_sources": [
      {
        "path": "packages/design-system/src/components/visualizations/types.ts",
        "line": 46,
        "name": "CategoryDatum",
        "code": "export interface CategoryDatum {\n    /** Stable category identifier. */\n    id: string;\n    label: React.ReactNode;\n    /** Non-negative category count or magnitude. */\n    value: number;\n    color?: string;\n}"
      },
      {
        "path": "packages/design-system/src/components/visualizations/types.ts",
        "line": 101,
        "name": "BurstGraphProps",
        "code": "export interface BurstGraphProps {\n    /** Category values used to distribute and color burst points. */\n    items: readonly CategoryDatum[];\n    /** Optional accent color used when no category color is available. */\n    accentColor?: string;\n    /** Accessible label for meaningful chart content. */\n    ariaLabel?: string;\n    /** Optional test selector. */\n    testId?: string;\n}"
      }
    ],
    "defaults_policy": "Only explicit destructured parameter initializers are extracted. Other runtime defaults remain in implementation source."
  },
  "spec": {
    "$schema": "../../../specs/component-spec.schema.json",
    "identity": {
      "name": "BurstGraph",
      "status": "preview",
      "version": "2.0.0",
      "summary": "A radial burst drawn on a canvas, with category-colored points spraying outward distributed by value, for decorative categorical texture."
    },
    "parts": [
      {
        "id": "canvas",
        "label": "Canvas",
        "description": "The square canvas the burst is drawn onto.",
        "required": true
      },
      {
        "id": "ray",
        "label": "Ray",
        "description": "A structural line radiating from the hub."
      },
      {
        "id": "particle",
        "label": "Particle",
        "description": "A category-colored point spraying outward from the center."
      }
    ],
    "allowedDesignChoices": {
      "variants": {
        "base": {
          "label": "Base",
          "description": "Category data changes the reading without changing the burst treatment."
        }
      },
      "sizes": {}
    },
    "variants": [
      {
        "id": "base",
        "label": "Base",
        "description": "A canvas radial burst of category particles.",
        "platforms": [
          "ios",
          "android",
          "web"
        ]
      }
    ],
    "sizes": [],
    "measurements": [
      {
        "id": "particle-size",
        "label": "Particle size",
        "kind": "example-only",
        "token": "--cds-size-8",
        "value": 8,
        "unit": "px",
        "appliesTo": [
          "particle"
        ],
        "notes": "Particles peak at an 8-unit radius, matching the --cds-size-8 token; the value is a canvas constant rather than a CSS-token binding, and the drawn size is depth- and life-driven, so this is example-only."
      }
    ],
    "layout": {
      "alignment": "The canvas is centered up to its width cap and keeps a square aspect.",
      "flow": "Rays and particles radiate from the hub.",
      "notes": [
        "The burst is drawn on a canvas, so its geometry is expressed in canvas units, not CSS tokens."
      ]
    },
    "typographyAndColor": {
      "typography": [],
      "colors": [
        {
          "label": "Rays",
          "description": "Structural rays and their endpoints.",
          "token": "--cds-divider"
        }
      ]
    },
    "states": [
      {
        "id": "bursting",
        "label": "Bursting",
        "description": "With motion allowed particles continuously spawn, travel, and fade."
      },
      {
        "id": "static",
        "label": "Static",
        "description": "Under reduced motion a single settled frame is drawn with no further spawning."
      },
      {
        "id": "empty",
        "label": "Empty",
        "description": "No items shows the empty burst state."
      }
    ],
    "behavior": [
      {
        "label": "Value distribution",
        "description": "Particle colors are weighted by each category value so bigger categories spray more."
      },
      {
        "label": "Accent fallback",
        "description": "Categories with no color fall back to the accent color, then to a default accent."
      }
    ],
    "accessibility": [
      {
        "label": "Meaningful chart",
        "description": "Pass an accessible label so the burst is announced as a meaningful image."
      },
      {
        "label": "Decorative burst",
        "description": "Omit the label to hide the canvas from assistive technology when nearby text carries the meaning."
      }
    ],
    "contentAdaptation": [
      {
        "label": "Decorative texture",
        "description": "Use BurstGraph for categorical texture; surface any headline count in nearby copy."
      },
      {
        "label": "Precision elsewhere",
        "description": "Use CategoryBars or ActionOrbs when category magnitudes must be read precisely."
      }
    ],
    "motionHaptics": {
      "motion": [
        {
          "label": "Radial burst",
          "description": "The structure rotates gently while particles spawn, travel outward, and fade."
        },
        {
          "label": "Reduced motion",
          "description": "When reduced motion is set a single settled frame is drawn and no further frames are scheduled."
        }
      ],
      "haptics": [
        {
          "label": "No feedback",
          "description": "The chart is a display and requests no haptic feedback."
        }
      ]
    },
    "platformDifferences": []
  },
  "platforms": {
    "implemented": [
      "web"
    ],
    "native": "Imported design guidance only; no native implementation or parity verification in this preview.",
    "react": {
      "implementation": "local",
      "status": "preview",
      "parity": "web-reference"
    },
    "vue": {
      "implementation": "absent",
      "parity": "not-verified",
      "status": "reference-only"
    },
    "swift": {
      "implementation": "absent",
      "parity": "not-verified",
      "status": "reference-only"
    },
    "kotlin": {
      "implementation": "absent",
      "parity": "not-verified",
      "status": "reference-only"
    }
  },
  "tokens": [
    {
      "name": "--cds-size-8",
      "light": "8px",
      "dark": "8px"
    },
    {
      "name": "--cds-divider",
      "light": "#e0ddd6",
      "dark": "#ffffff1a"
    }
  ],
  "review": {
    "local_status": "not-reviewed",
    "source_approval": null,
    "imported_spec_status": "approved",
    "spec_origin": "imported-adapted",
    "local_spec_source_status": "approved",
    "imported_source_revision": "f96f416e1c3bfbfaffcd155a88b87b18b8bb25f1",
    "note": "Inherited specification status is provenance, not approval of the current local implementation or extracted contract."
  },
  "missing_facts": [
    {
      "code": "human-review-pending",
      "detail": "This local preview has no recorded human design or engineering sign-off."
    },
    {
      "code": "platform-parity-unverified",
      "detail": "Vue, Swift and Kotlin implementations are absent from this package; platform parity has not been verified."
    },
    {
      "code": "figma-mapping-unverified",
      "detail": "No current component-level Figma node and immutable revision have been verified for this contract."
    }
  ]
}
```

## Visual states

- [Default](/storybook/iframe.html?id=cloaked-design-system-visualizations-burstgraph--default&viewMode=story) | export: Default | source: packages/design-system/src/components/visualizations/BurstGraph/BurstGraph.stories.tsx

- [Accent Color Fallback](/storybook/iframe.html?id=cloaked-design-system-visualizations-burstgraph--accent-color-fallback&viewMode=story) | export: AccentColorFallback | source: packages/design-system/src/components/visualizations/BurstGraph/BurstGraph.stories.tsx

- [Empty](/storybook/iframe.html?id=cloaked-design-system-visualizations-burstgraph--empty&viewMode=story) | export: Empty | source: packages/design-system/src/components/visualizations/BurstGraph/BurstGraph.stories.tsx

- [Dense](/storybook/iframe.html?id=cloaked-design-system-visualizations-burstgraph--dense&viewMode=story) | export: Dense | source: packages/design-system/src/components/visualizations/BurstGraph/BurstGraph.stories.tsx

- [Dark Theme](/storybook/iframe.html?id=cloaked-design-system-visualizations-burstgraph--dark-theme&viewMode=story) | export: DarkTheme | source: packages/design-system/src/components/visualizations/BurstGraph/BurstGraph.stories.tsx

Preview pending human sign-off. Source-derived APIs and successful checks do not certify accessibility, native parity or approval.