@krizaka/charts 0.0.0-stage → 0.2.0

package/registry/funnel.json

@@ -0,0 +1,487 @@
+{
+  "name": "funnel",
+  "package": "@krizaka/charts",
+  "type": "chart",
+  "title": "Funnel",
+  "summary": "Stages that lose people on the way, with the conversion from each stage to the next and from the first written beside it.",
+  "description": "Stages that lose people on the way, with the conversion from each stage to the next and from the first written beside it.",
+  "status": "beta",
+  "category": "charts",
+  "platforms": "web",
+  "engine": "echarts",
+  "tier": "advanced",
+  "whenToUse": [
+    "A sign-up or purchase journey: visit, sign-up, verification, first video, first sale."
+  ],
+  "whenNotToUse": [
+    {
+      "when": "Flows that branch.",
+      "use": "sankey"
+    },
+    {
+      "when": "Stages that do not contain each other.",
+      "use": "bar-chart"
+    }
+  ],
+  "bestPractices": [
+    "Order the stages as the journey goes; each count includes the next.",
+    "Name the columns of the table in your language (`fromFirstLabel`, `fromPreviousLabel`)."
+  ],
+  "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 summary says each step's conversion and the overall one."
+    ]
+  },
+  "related": [
+    "sankey",
+    "bar-chart"
+  ],
+  "source": "packages/charts/src/meta/funnel.ts",
+  "install": {
+    "web": "npm install @krizaka/charts",
+    "native": "npx expo install react-native-svg\nnpm install @krizaka/charts"
+  },
+  "web": {
+    "entry": "@krizaka/charts/funnel",
+    "import": "import { Funnel } from \"@krizaka/charts/funnel\";",
+    "props": [
+      {
+        "component": "Funnel",
+        "description": "",
+        "props": [
+          {
+            "name": "data",
+            "type": "readonly T[]",
+            "default": null,
+            "description": "One row per stage, first stage first.",
+            "required": true
+          },
+          {
+            "name": "label",
+            "type": "string | ((datum: T, index: number) => string)",
+            "default": null,
+            "description": "The field (or function) naming the stage.",
+            "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 how many reached it.",
+            "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 counts are written. Default `\"integer\"`.",
+            "required": false
+          },
+          {
+            "name": "fromFirstLabel",
+            "type": "string",
+            "default": null,
+            "description": "The header of the share of the first stage. Default “% first”.",
+            "required": false
+          },
+          {
+            "name": "fromPreviousLabel",
+            "type": "string",
+            "default": null,
+            "description": "The header of the share of the previous stage. Default “% previous”.",
+            "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": "stageLabel",
+            "type": "string",
+            "default": null,
+            "description": "The headers of the data table: the stage, the count, the share of the first, of the previous.",
+            "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": "valueLabel",
+            "type": "string",
+            "default": null,
+            "description": "The header of the counts.",
+            "required": false
+          }
+        ]
+      }
+    ],
+    "examples": [
+      {
+        "name": "signup",
+        "title": "Sign-up funnel",
+        "description": "Orochia's creator sign-up, from visit to first sale.",
+        "path": "examples/funnel/signup.tsx",
+        "module": "@krizaka/charts/registry/examples/funnel/signup",
+        "code": "import { Funnel } from \"@krizaka/charts/funnel\";\n\nconst stages = [\n  { stage: \"Visited the creator page\", people: 48_200 },\n  { stage: \"Created an account\", people: 9_640 },\n  { stage: \"Verified their identity\", people: 6_170 },\n  { stage: \"Published a first video\", people: 3_210 },\n  { stage: \"Made a first sale\", people: 1_180 },\n];\n\nexport default function Signup() {\n  return (\n    <Funnel\n      title=\"Creator sign-up, September\"\n      data={stages}\n      label=\"stage\"\n      value=\"people\"\n      stageLabel=\"Stage\"\n      valueLabel=\"Creators\"\n      fromFirstLabel=\"% of visits\"\n      fromPreviousLabel=\"% of previous\"\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/funnel/signup.tsx",
+    "content": "import { Funnel } from \"@krizaka/charts/funnel\";\n\nconst stages = [\n  { stage: \"Visited the creator page\", people: 48_200 },\n  { stage: \"Created an account\", people: 9_640 },\n  { stage: \"Verified their identity\", people: 6_170 },\n  { stage: \"Published a first video\", people: 3_210 },\n  { stage: \"Made a first sale\", people: 1_180 },\n];\n\nexport default function Signup() {\n  return (\n    <Funnel\n      title=\"Creator sign-up, September\"\n      data={stages}\n      label=\"stage\"\n      value=\"people\"\n      stageLabel=\"Stage\"\n      valueLabel=\"Creators\"\n      fromFirstLabel=\"% of visits\"\n      fromPreviousLabel=\"% of previous\"\n    />\n  );\n}\n"
+  },
+  "props": [
+    {
+      "component": "Funnel",
+      "description": "",
+      "props": [
+        {
+          "name": "data",
+          "type": "readonly T[]",
+          "default": null,
+          "description": "One row per stage, first stage first.",
+          "required": true
+        },
+        {
+          "name": "label",
+          "type": "string | ((datum: T, index: number) => string)",
+          "default": null,
+          "description": "The field (or function) naming the stage.",
+          "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 how many reached it.",
+          "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 counts are written. Default `\"integer\"`.",
+          "required": false
+        },
+        {
+          "name": "fromFirstLabel",
+          "type": "string",
+          "default": null,
+          "description": "The header of the share of the first stage. Default “% first”.",
+          "required": false
+        },
+        {
+          "name": "fromPreviousLabel",
+          "type": "string",
+          "default": null,
+          "description": "The header of the share of the previous stage. Default “% previous”.",
+          "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": "stageLabel",
+          "type": "string",
+          "default": null,
+          "description": "The headers of the data table: the stage, the count, the share of the first, of the previous.",
+          "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": "valueLabel",
+          "type": "string",
+          "default": null,
+          "description": "The header of the counts.",
+          "required": false
+        }
+      ]
+    }
+  ]
+}