@krizaka/charts 0.0.0-stage → 0.2.0

package/registry/sankey.json

@@ -0,0 +1,503 @@
+{
+  "name": "sankey",
+  "package": "@krizaka/charts",
+  "type": "chart",
+  "title": "Sankey",
+  "summary": "Flows between stages — credits from plans to models to outcomes — with widths proportional to the amounts.",
+  "description": "Flows between stages — credits from plans to models to outcomes — with widths proportional to the amounts.",
+  "status": "beta",
+  "category": "charts",
+  "platforms": "web",
+  "engine": "echarts",
+  "tier": "advanced",
+  "whenToUse": [
+    "Where an amount goes, in two or three steps: credits by plan, then by model, then by outcome.",
+    "A journey with branches: viewers from sources to subscriptions."
+  ],
+  "whenNotToUse": [
+    {
+      "when": "A single sequence of stages that only loses people.",
+      "use": "funnel"
+    },
+    {
+      "when": "A split at one level.",
+      "use": "pie-chart"
+    }
+  ],
+  "bestPractices": [
+    "Keep to about a dozen nodes; group the small flows.",
+    "Use `vertical` on narrow screens."
+  ],
+  "accessibility": {
+    "keyboard": [
+      {
+        "keys": "Tab",
+        "action": "Moves the focus to the plot (one tab stop), then to the data and export buttons."
+      },
+      {
+        "keys": "Arrow keys",
+        "action": "Walk the items one by one: each is announced and highlighted, its tooltip shown."
+      },
+      {
+        "keys": "Home / End",
+        "action": "Jump to the first or the last item."
+      },
+      {
+        "keys": "Esc",
+        "action": "Hides the tooltip and clears the highlight."
+      }
+    ],
+    "notes": [
+      "The plot is a group named by the title and described by a summary written from the data, read before anything else.",
+      "The data table is always in the page for assistive technology; “Show data” reveals it for everyone.",
+      "The engine (ECharts core and this one chart type) loads when the chart nears the screen; a skeleton of the same height holds its place, so nothing shifts.",
+      "Under reduced motion the chart is drawn without animation.",
+      "The keyboard walks the flows; the table lists every source, target and amount."
+    ]
+  },
+  "related": [
+    "funnel",
+    "treemap",
+    "pie-chart"
+  ],
+  "source": "packages/charts/src/meta/sankey.ts",
+  "install": {
+    "web": "npm install @krizaka/charts",
+    "native": "npx expo install react-native-svg\nnpm install @krizaka/charts"
+  },
+  "web": {
+    "entry": "@krizaka/charts/sankey",
+    "import": "import { Sankey } from \"@krizaka/charts/sankey\";",
+    "props": [
+      {
+        "component": "Sankey",
+        "description": "",
+        "props": [
+          {
+            "name": "data",
+            "type": "readonly T[]",
+            "default": null,
+            "description": "One row per flow.",
+            "required": true
+          },
+          {
+            "name": "source",
+            "type": "string | ((datum: T, index: number) => string)",
+            "default": null,
+            "description": "The fields (or functions) naming where the flow comes from and where it goes.",
+            "required": true
+          },
+          {
+            "name": "target",
+            "type": "string | ((datum: T, index: number) => string)",
+            "default": null,
+            "description": "The field (or function) naming where the flow goes.",
+            "required": true
+          },
+          {
+            "name": "title",
+            "type": "string",
+            "default": null,
+            "description": "What the chart shows, in a few words: its accessible name, and its heading unless `hideTitle`.",
+            "required": true
+          },
+          {
+            "name": "value",
+            "type": "string | ((datum: T, index: number) => number)",
+            "default": null,
+            "description": "The field of its amount.",
+            "required": true
+          },
+          {
+            "name": "brand",
+            "type": "BrandId",
+            "default": null,
+            "description": "The brand whose palette the charts use. Without it, a chart follows a `.brand-<id>` ancestor, else Krizaka. Set it\nwhen the app loads a brand stylesheet on `:root` (`@krizaka/tokens/brands/orazaka.css`).",
+            "required": false
+          },
+          {
+            "name": "className",
+            "type": "string",
+            "default": null,
+            "description": "A class on the figure (layout: margins, grid placement).",
+            "required": false
+          },
+          {
+            "name": "dataTable",
+            "type": "boolean",
+            "default": null,
+            "description": "The \"Show data\" button (the table is in the page for screen readers either way). Default true.",
+            "required": false
+          },
+          {
+            "name": "description",
+            "type": "ReactNode",
+            "default": null,
+            "description": "A sentence under the title: the period, the unit, the source.",
+            "required": false
+          },
+          {
+            "name": "empty",
+            "type": "ReactNode",
+            "default": null,
+            "description": "What to show when there is nothing to draw (default: the `empty` label). An `EmptyState` of\n@krizaka /ui fits.",
+            "required": false
+          },
+          {
+            "name": "error",
+            "type": "ReactNode",
+            "default": null,
+            "description": "The data could not be loaded: `true` says the default words, a node says yours (a retry button…).",
+            "required": false
+          },
+          {
+            "name": "exportable",
+            "type": "boolean | readonly ExportFormat[]",
+            "default": null,
+            "description": "Export buttons: `true` for PNG, SVG and CSV, or the formats you want.",
+            "required": false
+          },
+          {
+            "name": "format",
+            "type": "ValueFormat",
+            "default": null,
+            "description": "How the amounts are written.",
+            "required": false
+          },
+          {
+            "name": "height",
+            "type": "number",
+            "default": null,
+            "description": "The height of the plot in pixels. Default 280 (a sparkline: 32).",
+            "required": false
+          },
+          {
+            "name": "hideTitle",
+            "type": "boolean",
+            "default": null,
+            "description": "Visually hide the title (it stays the chart's accessible name): a card that already has its heading.",
+            "required": false
+          },
+          {
+            "name": "id",
+            "type": "string",
+            "default": null,
+            "description": "The id of the figure.",
+            "required": false
+          },
+          {
+            "name": "labels",
+            "type": "ChartLabelsInput",
+            "default": null,
+            "description": "The words, translated: the buttons, the states, the written summary.",
+            "required": false
+          },
+          {
+            "name": "live",
+            "type": "boolean",
+            "default": null,
+            "description": "Streaming data (a job queue, an auction): no entrance on updates, no announcement of every new point.",
+            "required": false
+          },
+          {
+            "name": "loading",
+            "type": "boolean",
+            "default": null,
+            "description": "The data is on its way: a skeleton of the chart, announced once.",
+            "required": false
+          },
+          {
+            "name": "locale",
+            "type": "Locale",
+            "default": null,
+            "description": "The locale of every figure and date (`\"fr-FR\"`). Default `\"en-US\"`.",
+            "required": false
+          },
+          {
+            "name": "renderer",
+            "type": "Renderer",
+            "default": null,
+            "description": "`svg` (default): sharp, exportable as SVG. `canvas`: for tens of thousands of marks.",
+            "required": false
+          },
+          {
+            "name": "sourceLabel",
+            "type": "string",
+            "default": null,
+            "description": "The headers of the data table.",
+            "required": false
+          },
+          {
+            "name": "style",
+            "type": "CSSProperties",
+            "default": null,
+            "description": "Inline style on the figure (layout only: colours come from the tokens).",
+            "required": false
+          },
+          {
+            "name": "summary",
+            "type": "\"hidden\" | \"visible\"",
+            "default": null,
+            "description": "The written summary: read by screen readers only (`\"hidden\"`, default), or shown under the chart (`\"visible\"`).",
+            "required": false
+          },
+          {
+            "name": "summaryText",
+            "type": "string",
+            "default": null,
+            "description": "Your own summary instead of the generated one (still read first by screen readers).",
+            "required": false
+          },
+          {
+            "name": "targetLabel",
+            "type": "string",
+            "default": null,
+            "description": "The header of the targets.",
+            "required": false
+          },
+          {
+            "name": "valueLabel",
+            "type": "string",
+            "default": null,
+            "description": "The header of the amounts.",
+            "required": false
+          },
+          {
+            "name": "vertical",
+            "type": "boolean",
+            "default": null,
+            "description": "Lay the stages out top to bottom (narrow screens). Default: left to right.",
+            "required": false
+          }
+        ]
+      }
+    ],
+    "examples": [
+      {
+        "name": "credit-flow",
+        "title": "Credit flow",
+        "description": "A month of Orazaka credits, from plans to models to outcomes.",
+        "path": "examples/sankey/credit-flow.tsx",
+        "module": "@krizaka/charts/registry/examples/sankey/credit-flow",
+        "code": "import { Sankey } from \"@krizaka/charts/sankey\";\n\n// Thousands of credits in September.\nconst flows = [\n  { from: \"Pro plans\", to: \"Chat\", credits: 182 },\n  { from: \"Pro plans\", to: \"Image\", credits: 64 },\n  { from: \"Studio plans\", to: \"Video\", credits: 121 },\n  { from: \"Studio plans\", to: \"Image\", credits: 48 },\n  { from: \"Studio plans\", to: \"Chat\", credits: 37 },\n  { from: \"Chat\", to: \"Delivered\", credits: 211 },\n  { from: \"Chat\", to: \"Refunded\", credits: 8 },\n  { from: \"Image\", to: \"Delivered\", credits: 104 },\n  { from: \"Image\", to: \"Refunded\", credits: 8 },\n  { from: \"Video\", to: \"Delivered\", credits: 109 },\n  { from: \"Video\", to: \"Refunded\", credits: 12 },\n];\n\nexport default function CreditFlow() {\n  return (\n    <Sankey\n      title=\"Where the credits went (k)\"\n      data={flows}\n      source=\"from\"\n      target=\"to\"\n      value=\"credits\"\n      format=\"integer\"\n      sourceLabel=\"From\"\n      targetLabel=\"To\"\n      valueLabel=\"Credits (k)\"\n    />\n  );\n}\n"
+      }
+    ]
+  },
+  "native": null,
+  "files": [],
+  "dependencies": [
+    "@krizaka/intl@workspace:^",
+    "d3-geo@^3.1.1",
+    "echarts@^6.1.0",
+    "topojson-client@^3.1.0"
+  ],
+  "registryDependencies": [],
+  "demo": {
+    "path": "examples/sankey/credit-flow.tsx",
+    "content": "import { Sankey } from \"@krizaka/charts/sankey\";\n\n// Thousands of credits in September.\nconst flows = [\n  { from: \"Pro plans\", to: \"Chat\", credits: 182 },\n  { from: \"Pro plans\", to: \"Image\", credits: 64 },\n  { from: \"Studio plans\", to: \"Video\", credits: 121 },\n  { from: \"Studio plans\", to: \"Image\", credits: 48 },\n  { from: \"Studio plans\", to: \"Chat\", credits: 37 },\n  { from: \"Chat\", to: \"Delivered\", credits: 211 },\n  { from: \"Chat\", to: \"Refunded\", credits: 8 },\n  { from: \"Image\", to: \"Delivered\", credits: 104 },\n  { from: \"Image\", to: \"Refunded\", credits: 8 },\n  { from: \"Video\", to: \"Delivered\", credits: 109 },\n  { from: \"Video\", to: \"Refunded\", credits: 12 },\n];\n\nexport default function CreditFlow() {\n  return (\n    <Sankey\n      title=\"Where the credits went (k)\"\n      data={flows}\n      source=\"from\"\n      target=\"to\"\n      value=\"credits\"\n      format=\"integer\"\n      sourceLabel=\"From\"\n      targetLabel=\"To\"\n      valueLabel=\"Credits (k)\"\n    />\n  );\n}\n"
+  },
+  "props": [
+    {
+      "component": "Sankey",
+      "description": "",
+      "props": [
+        {
+          "name": "data",
+          "type": "readonly T[]",
+          "default": null,
+          "description": "One row per flow.",
+          "required": true
+        },
+        {
+          "name": "source",
+          "type": "string | ((datum: T, index: number) => string)",
+          "default": null,
+          "description": "The fields (or functions) naming where the flow comes from and where it goes.",
+          "required": true
+        },
+        {
+          "name": "target",
+          "type": "string | ((datum: T, index: number) => string)",
+          "default": null,
+          "description": "The field (or function) naming where the flow goes.",
+          "required": true
+        },
+        {
+          "name": "title",
+          "type": "string",
+          "default": null,
+          "description": "What the chart shows, in a few words: its accessible name, and its heading unless `hideTitle`.",
+          "required": true
+        },
+        {
+          "name": "value",
+          "type": "string | ((datum: T, index: number) => number)",
+          "default": null,
+          "description": "The field of its amount.",
+          "required": true
+        },
+        {
+          "name": "brand",
+          "type": "BrandId",
+          "default": null,
+          "description": "The brand whose palette the charts use. Without it, a chart follows a `.brand-<id>` ancestor, else Krizaka. Set it\nwhen the app loads a brand stylesheet on `:root` (`@krizaka/tokens/brands/orazaka.css`).",
+          "required": false
+        },
+        {
+          "name": "className",
+          "type": "string",
+          "default": null,
+          "description": "A class on the figure (layout: margins, grid placement).",
+          "required": false
+        },
+        {
+          "name": "dataTable",
+          "type": "boolean",
+          "default": null,
+          "description": "The \"Show data\" button (the table is in the page for screen readers either way). Default true.",
+          "required": false
+        },
+        {
+          "name": "description",
+          "type": "ReactNode",
+          "default": null,
+          "description": "A sentence under the title: the period, the unit, the source.",
+          "required": false
+        },
+        {
+          "name": "empty",
+          "type": "ReactNode",
+          "default": null,
+          "description": "What to show when there is nothing to draw (default: the `empty` label). An `EmptyState` of\n@krizaka /ui fits.",
+          "required": false
+        },
+        {
+          "name": "error",
+          "type": "ReactNode",
+          "default": null,
+          "description": "The data could not be loaded: `true` says the default words, a node says yours (a retry button…).",
+          "required": false
+        },
+        {
+          "name": "exportable",
+          "type": "boolean | readonly ExportFormat[]",
+          "default": null,
+          "description": "Export buttons: `true` for PNG, SVG and CSV, or the formats you want.",
+          "required": false
+        },
+        {
+          "name": "format",
+          "type": "ValueFormat",
+          "default": null,
+          "description": "How the amounts are written.",
+          "required": false
+        },
+        {
+          "name": "height",
+          "type": "number",
+          "default": null,
+          "description": "The height of the plot in pixels. Default 280 (a sparkline: 32).",
+          "required": false
+        },
+        {
+          "name": "hideTitle",
+          "type": "boolean",
+          "default": null,
+          "description": "Visually hide the title (it stays the chart's accessible name): a card that already has its heading.",
+          "required": false
+        },
+        {
+          "name": "id",
+          "type": "string",
+          "default": null,
+          "description": "The id of the figure.",
+          "required": false
+        },
+        {
+          "name": "labels",
+          "type": "ChartLabelsInput",
+          "default": null,
+          "description": "The words, translated: the buttons, the states, the written summary.",
+          "required": false
+        },
+        {
+          "name": "live",
+          "type": "boolean",
+          "default": null,
+          "description": "Streaming data (a job queue, an auction): no entrance on updates, no announcement of every new point.",
+          "required": false
+        },
+        {
+          "name": "loading",
+          "type": "boolean",
+          "default": null,
+          "description": "The data is on its way: a skeleton of the chart, announced once.",
+          "required": false
+        },
+        {
+          "name": "locale",
+          "type": "Locale",
+          "default": null,
+          "description": "The locale of every figure and date (`\"fr-FR\"`). Default `\"en-US\"`.",
+          "required": false
+        },
+        {
+          "name": "renderer",
+          "type": "Renderer",
+          "default": null,
+          "description": "`svg` (default): sharp, exportable as SVG. `canvas`: for tens of thousands of marks.",
+          "required": false
+        },
+        {
+          "name": "sourceLabel",
+          "type": "string",
+          "default": null,
+          "description": "The headers of the data table.",
+          "required": false
+        },
+        {
+          "name": "style",
+          "type": "CSSProperties",
+          "default": null,
+          "description": "Inline style on the figure (layout only: colours come from the tokens).",
+          "required": false
+        },
+        {
+          "name": "summary",
+          "type": "\"hidden\" | \"visible\"",
+          "default": null,
+          "description": "The written summary: read by screen readers only (`\"hidden\"`, default), or shown under the chart (`\"visible\"`).",
+          "required": false
+        },
+        {
+          "name": "summaryText",
+          "type": "string",
+          "default": null,
+          "description": "Your own summary instead of the generated one (still read first by screen readers).",
+          "required": false
+        },
+        {
+          "name": "targetLabel",
+          "type": "string",
+          "default": null,
+          "description": "The header of the targets.",
+          "required": false
+        },
+        {
+          "name": "valueLabel",
+          "type": "string",
+          "default": null,
+          "description": "The header of the amounts.",
+          "required": false
+        },
+        {
+          "name": "vertical",
+          "type": "boolean",
+          "default": null,
+          "description": "Lay the stages out top to bottom (narrow screens). Default: left to right.",
+          "required": false
+        }
+      ]
+    }
+  ]
+}