@krizaka/charts 0.3.1 → 0.5.0

package/registry/pie-chart.json

@@ -8,6 +8,17 @@
   "status": "beta",
   "category": "charts",
   "platforms": "both",
+  "parity": {
+    "web": {
+      "state": "yes"
+    },
+    "native": {
+      "state": "yes"
+    },
+    "desktop": {
+      "state": "yes"
+    }
+  },
   "engine": "svg",
   "tier": "core",
   "whenToUse": [
@@ -96,13 +107,6 @@
             "description": "The field (or function) naming the part.",
             "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)",
@@ -110,6 +114,13 @@
             "description": "The field (or function) of its amount (≥ 0).",
             "required": true
           },
+          {
+            "name": "actionsMenu",
+            "type": "boolean",
+            "default": null,
+            "description": "The ⋯ actions menu of the kit. `false`: the former “Show data” and export buttons, drawn in line. Default true.",
+            "required": false
+          },
           {
             "name": "brand",
             "type": "BrandId",
@@ -149,7 +160,7 @@
             "name": "dataTable",
             "type": "boolean",
             "default": null,
-            "description": "The \"Show data\" button (the table is in the page for screen readers either way). Default true.",
+            "description": "“View as table” in the actions menu (the table is in the page for screen readers either way). Default true.",
             "required": false
           },
           {
@@ -177,7 +188,7 @@
             "name": "exportable",
             "type": "boolean | readonly ExportFormat[]",
             "default": null,
-            "description": "Export buttons: `true` for PNG, SVG and CSV, or the formats you want.",
+            "description": "The downloads of the actions menu: all three by default, or the formats you want, or `false` for none.",
             "required": false
           },
           {
@@ -208,6 +219,13 @@
             "description": "The id of the figure.",
             "required": false
           },
+          {
+            "name": "insight",
+            "type": "ReactNode",
+            "default": null,
+            "description": "One line that says what the chart shows, between the title and the chart: “100 jobs · +100 % vs last week”.",
+            "required": false
+          },
           {
             "name": "labelHeader",
             "type": "string",
@@ -285,6 +303,13 @@
             "description": "Your own summary instead of the generated one (still read first by screen readers).",
             "required": false
           },
+          {
+            "name": "title",
+            "type": "string",
+            "default": null,
+            "description": "What the chart shows, in a few words: its accessible name, and its heading unless `hideTitle`. Inside a `ChartCard`, the card's title is the default.",
+            "required": false
+          },
           {
             "name": "valueHeader",
             "type": "string",
@@ -312,13 +337,6 @@
             "description": "The field (or function) naming the part.",
             "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)",
@@ -326,6 +344,13 @@
             "description": "The field (or function) of its amount (≥ 0).",
             "required": true
           },
+          {
+            "name": "actionsMenu",
+            "type": "boolean",
+            "default": null,
+            "description": "The ⋯ actions menu of the kit. `false`: the former “Show data” and export buttons, drawn in line. Default true.",
+            "required": false
+          },
           {
             "name": "brand",
             "type": "BrandId",
@@ -365,7 +390,7 @@
             "name": "dataTable",
             "type": "boolean",
             "default": null,
-            "description": "The \"Show data\" button (the table is in the page for screen readers either way). Default true.",
+            "description": "“View as table” in the actions menu (the table is in the page for screen readers either way). Default true.",
             "required": false
           },
           {
@@ -400,7 +425,7 @@
             "name": "exportable",
             "type": "boolean | readonly ExportFormat[]",
             "default": null,
-            "description": "Export buttons: `true` for PNG, SVG and CSV, or the formats you want.",
+            "description": "The downloads of the actions menu: all three by default, or the formats you want, or `false` for none.",
             "required": false
           },
           {
@@ -431,6 +456,13 @@
             "description": "The id of the figure.",
             "required": false
           },
+          {
+            "name": "insight",
+            "type": "ReactNode",
+            "default": null,
+            "description": "One line that says what the chart shows, between the title and the chart: “100 jobs · +100 % vs last week”.",
+            "required": false
+          },
           {
             "name": "labelHeader",
             "type": "string",
@@ -508,6 +540,13 @@
             "description": "Your own summary instead of the generated one (still read first by screen readers).",
             "required": false
           },
+          {
+            "name": "title",
+            "type": "string",
+            "default": null,
+            "description": "What the chart shows, in a few words: its accessible name, and its heading unless `hideTitle`. Inside a `ChartCard`, the card's title is the default.",
+            "required": false
+          },
           {
             "name": "valueHeader",
             "type": "string",
@@ -863,13 +902,6 @@
           "description": "The field (or function) naming the part.",
           "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)",
@@ -877,6 +909,13 @@
           "description": "The field (or function) of its amount (≥ 0).",
           "required": true
         },
+        {
+          "name": "actionsMenu",
+          "type": "boolean",
+          "default": null,
+          "description": "The ⋯ actions menu of the kit. `false`: the former “Show data” and export buttons, drawn in line. Default true.",
+          "required": false
+        },
         {
           "name": "brand",
           "type": "BrandId",
@@ -916,7 +955,7 @@
           "name": "dataTable",
           "type": "boolean",
           "default": null,
-          "description": "The \"Show data\" button (the table is in the page for screen readers either way). Default true.",
+          "description": "“View as table” in the actions menu (the table is in the page for screen readers either way). Default true.",
           "required": false
         },
         {
@@ -944,7 +983,7 @@
           "name": "exportable",
           "type": "boolean | readonly ExportFormat[]",
           "default": null,
-          "description": "Export buttons: `true` for PNG, SVG and CSV, or the formats you want.",
+          "description": "The downloads of the actions menu: all three by default, or the formats you want, or `false` for none.",
           "required": false
         },
         {
@@ -975,6 +1014,13 @@
           "description": "The id of the figure.",
           "required": false
         },
+        {
+          "name": "insight",
+          "type": "ReactNode",
+          "default": null,
+          "description": "One line that says what the chart shows, between the title and the chart: “100 jobs · +100 % vs last week”.",
+          "required": false
+        },
         {
           "name": "labelHeader",
           "type": "string",
@@ -1052,6 +1098,13 @@
           "description": "Your own summary instead of the generated one (still read first by screen readers).",
           "required": false
         },
+        {
+          "name": "title",
+          "type": "string",
+          "default": null,
+          "description": "What the chart shows, in a few words: its accessible name, and its heading unless `hideTitle`. Inside a `ChartCard`, the card's title is the default.",
+          "required": false
+        },
         {
           "name": "valueHeader",
           "type": "string",
@@ -1079,13 +1132,6 @@
           "description": "The field (or function) naming the part.",
           "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)",
@@ -1093,6 +1139,13 @@
           "description": "The field (or function) of its amount (≥ 0).",
           "required": true
         },
+        {
+          "name": "actionsMenu",
+          "type": "boolean",
+          "default": null,
+          "description": "The ⋯ actions menu of the kit. `false`: the former “Show data” and export buttons, drawn in line. Default true.",
+          "required": false
+        },
         {
           "name": "brand",
           "type": "BrandId",
@@ -1132,7 +1185,7 @@
           "name": "dataTable",
           "type": "boolean",
           "default": null,
-          "description": "The \"Show data\" button (the table is in the page for screen readers either way). Default true.",
+          "description": "“View as table” in the actions menu (the table is in the page for screen readers either way). Default true.",
           "required": false
         },
         {
@@ -1167,7 +1220,7 @@
           "name": "exportable",
           "type": "boolean | readonly ExportFormat[]",
           "default": null,
-          "description": "Export buttons: `true` for PNG, SVG and CSV, or the formats you want.",
+          "description": "The downloads of the actions menu: all three by default, or the formats you want, or `false` for none.",
           "required": false
         },
         {
@@ -1198,6 +1251,13 @@
           "description": "The id of the figure.",
           "required": false
         },
+        {
+          "name": "insight",
+          "type": "ReactNode",
+          "default": null,
+          "description": "One line that says what the chart shows, between the title and the chart: “100 jobs · +100 % vs last week”.",
+          "required": false
+        },
         {
           "name": "labelHeader",
           "type": "string",
@@ -1275,6 +1335,13 @@
           "description": "Your own summary instead of the generated one (still read first by screen readers).",
           "required": false
         },
+        {
+          "name": "title",
+          "type": "string",
+          "default": null,
+          "description": "What the chart shows, in a few words: its accessible name, and its heading unless `hideTitle`. Inside a `ChartCard`, the card's title is the default.",
+          "required": false
+        },
         {
           "name": "valueHeader",
           "type": "string",

package/registry/price-ticker.json

@@ -8,6 +8,17 @@
   "status": "beta",
   "category": "charts",
   "platforms": "both",
+  "parity": {
+    "web": {
+      "state": "yes"
+    },
+    "native": {
+      "state": "yes"
+    },
+    "desktop": {
+      "state": "yes"
+    }
+  },
   "engine": "svg",
   "tier": "ready-made",
   "whenToUse": [
@@ -85,11 +96,18 @@
             "required": true
           },
           {
-            "name": "title",
-            "type": "string",
+            "name": "actionsMenu",
+            "type": "boolean",
             "default": null,
-            "description": "What the chart shows, in a few words: its accessible name, and its heading unless `hideTitle`.",
-            "required": true
+            "description": "The ⋯ actions menu of the kit. `false`: the former “Show data” and export buttons, drawn in line. Default true.",
+            "required": false
+          },
+          {
+            "name": "autoRange",
+            "type": "boolean",
+            "default": null,
+            "description": "Zoom the time axis on the period that has data: the empty days before the first and after the last value are\nleft out (never fewer than `minPoints`), and a sparse period says so under the chart instead of drawing 13 empty\ndays around one bar. Default false.",
+            "required": false
           },
           {
             "name": "brand",
@@ -109,7 +127,7 @@
             "name": "dataTable",
             "type": "boolean",
             "default": null,
-            "description": "The \"Show data\" button (the table is in the page for screen readers either way). Default true.",
+            "description": "“View as table” in the actions menu (the table is in the page for screen readers either way). Default true.",
             "required": false
           },
           {
@@ -151,7 +169,14 @@
             "name": "exportable",
             "type": "boolean | readonly ExportFormat[]",
             "default": null,
-            "description": "Export buttons: `true` for PNG, SVG and CSV, or the formats you want.",
+            "description": "The downloads of the actions menu: all three by default, or the formats you want, or `false` for none.",
+            "required": false
+          },
+          {
+            "name": "filterable",
+            "type": "boolean",
+            "default": null,
+            "description": "The legend chips switch the series on and off. Default true.",
             "required": false
           },
           {
@@ -175,6 +200,13 @@
             "description": "The id of the figure.",
             "required": false
           },
+          {
+            "name": "insight",
+            "type": "ReactNode",
+            "default": null,
+            "description": "One line that says what the chart shows, between the title and the chart: “100 jobs · +100 % vs last week”.",
+            "required": false
+          },
           {
             "name": "labels",
             "type": "Partial<TickerLabels>",
@@ -217,6 +249,13 @@
             "description": "Vertical markers at a category: a launch, an incident.",
             "required": false
           },
+          {
+            "name": "minPoints",
+            "type": "number",
+            "default": null,
+            "description": "With `autoRange`, the fewest categories to keep so a short burst still has a time scale. Default 7.",
+            "required": false
+          },
           {
             "name": "onSelect",
             "type": "((datum: Point, index: number) => void)",
@@ -266,6 +305,13 @@
             "description": "How the times are written. Default `\"time\"` (`14:30`); `\"datetime\"` for auctions over several days.",
             "required": false
           },
+          {
+            "name": "title",
+            "type": "string",
+            "default": null,
+            "description": "What the chart shows, in a few words: its accessible name, and its heading unless `hideTitle`. Inside a `ChartCard`, the card's title is the default.",
+            "required": false
+          },
           {
             "name": "xLabel",
             "type": "string",
@@ -483,11 +529,18 @@
           "required": true
         },
         {
-          "name": "title",
-          "type": "string",
+          "name": "actionsMenu",
+          "type": "boolean",
           "default": null,
-          "description": "What the chart shows, in a few words: its accessible name, and its heading unless `hideTitle`.",
-          "required": true
+          "description": "The ⋯ actions menu of the kit. `false`: the former “Show data” and export buttons, drawn in line. Default true.",
+          "required": false
+        },
+        {
+          "name": "autoRange",
+          "type": "boolean",
+          "default": null,
+          "description": "Zoom the time axis on the period that has data: the empty days before the first and after the last value are\nleft out (never fewer than `minPoints`), and a sparse period says so under the chart instead of drawing 13 empty\ndays around one bar. Default false.",
+          "required": false
         },
         {
           "name": "brand",
@@ -507,7 +560,7 @@
           "name": "dataTable",
           "type": "boolean",
           "default": null,
-          "description": "The \"Show data\" button (the table is in the page for screen readers either way). Default true.",
+          "description": "“View as table” in the actions menu (the table is in the page for screen readers either way). Default true.",
           "required": false
         },
         {
@@ -549,7 +602,14 @@
           "name": "exportable",
           "type": "boolean | readonly ExportFormat[]",
           "default": null,
-          "description": "Export buttons: `true` for PNG, SVG and CSV, or the formats you want.",
+          "description": "The downloads of the actions menu: all three by default, or the formats you want, or `false` for none.",
+          "required": false
+        },
+        {
+          "name": "filterable",
+          "type": "boolean",
+          "default": null,
+          "description": "The legend chips switch the series on and off. Default true.",
           "required": false
         },
         {
@@ -573,6 +633,13 @@
           "description": "The id of the figure.",
           "required": false
         },
+        {
+          "name": "insight",
+          "type": "ReactNode",
+          "default": null,
+          "description": "One line that says what the chart shows, between the title and the chart: “100 jobs · +100 % vs last week”.",
+          "required": false
+        },
         {
           "name": "labels",
           "type": "Partial<TickerLabels>",
@@ -615,6 +682,13 @@
           "description": "Vertical markers at a category: a launch, an incident.",
           "required": false
         },
+        {
+          "name": "minPoints",
+          "type": "number",
+          "default": null,
+          "description": "With `autoRange`, the fewest categories to keep so a short burst still has a time scale. Default 7.",
+          "required": false
+        },
         {
           "name": "onSelect",
           "type": "((datum: Point, index: number) => void)",
@@ -664,6 +738,13 @@
           "description": "How the times are written. Default `\"time\"` (`14:30`); `\"datetime\"` for auctions over several days.",
           "required": false
         },
+        {
+          "name": "title",
+          "type": "string",
+          "default": null,
+          "description": "What the chart shows, in a few words: its accessible name, and its heading unless `hideTitle`. Inside a `ChartCard`, the card's title is the default.",
+          "required": false
+        },
         {
           "name": "xLabel",
           "type": "string",

package/registry/radar-chart.json

@@ -8,6 +8,19 @@
   "status": "beta",
   "category": "charts",
   "platforms": "web",
+  "parity": {
+    "web": {
+      "state": "yes"
+    },
+    "native": {
+      "state": "gap",
+      "reason": "Advanced tier: no phone screen needs it yet.",
+      "issue": "krizaka/krizaka-ui#280"
+    },
+    "desktop": {
+      "state": "yes"
+    }
+  },
   "engine": "echarts",
   "tier": "advanced",
   "whenToUse": [
@@ -85,13 +98,6 @@
             "description": "The entities compared, one value per axis each.",
             "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": "x",
             "type": "string | ((datum: T, index: number) => string)",
@@ -99,6 +105,13 @@
             "description": "The field (or function) naming the axis.",
             "required": true
           },
+          {
+            "name": "actionsMenu",
+            "type": "boolean",
+            "default": null,
+            "description": "The ⋯ actions menu of the kit. `false`: the former “Show data” and export buttons, drawn in line. Default true.",
+            "required": false
+          },
           {
             "name": "brand",
             "type": "BrandId",
@@ -117,7 +130,7 @@
             "name": "dataTable",
             "type": "boolean",
             "default": null,
-            "description": "The \"Show data\" button (the table is in the page for screen readers either way). Default true.",
+            "description": "“View as table” in the actions menu (the table is in the page for screen readers either way). Default true.",
             "required": false
           },
           {
@@ -145,7 +158,7 @@
             "name": "exportable",
             "type": "boolean | readonly ExportFormat[]",
             "default": null,
-            "description": "Export buttons: `true` for PNG, SVG and CSV, or the formats you want.",
+            "description": "The downloads of the actions menu: all three by default, or the formats you want, or `false` for none.",
             "required": false
           },
           {
@@ -176,6 +189,13 @@
             "description": "The id of the figure.",
             "required": false
           },
+          {
+            "name": "insight",
+            "type": "ReactNode",
+            "default": null,
+            "description": "One line that says what the chart shows, between the title and the chart: “100 jobs · +100 % vs last week”.",
+            "required": false
+          },
           {
             "name": "labels",
             "type": "ChartLabelsInput",
@@ -239,6 +259,13 @@
             "description": "Your own summary instead of the generated one (still read first by screen readers).",
             "required": false
           },
+          {
+            "name": "title",
+            "type": "string",
+            "default": null,
+            "description": "What the chart shows, in a few words: its accessible name, and its heading unless `hideTitle`. Inside a `ChartCard`, the card's title is the default.",
+            "required": false
+          },
           {
             "name": "xLabel",
             "type": "string",
@@ -292,13 +319,6 @@
           "description": "The entities compared, one value per axis each.",
           "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": "x",
           "type": "string | ((datum: T, index: number) => string)",
@@ -306,6 +326,13 @@
           "description": "The field (or function) naming the axis.",
           "required": true
         },
+        {
+          "name": "actionsMenu",
+          "type": "boolean",
+          "default": null,
+          "description": "The ⋯ actions menu of the kit. `false`: the former “Show data” and export buttons, drawn in line. Default true.",
+          "required": false
+        },
         {
           "name": "brand",
           "type": "BrandId",
@@ -324,7 +351,7 @@
           "name": "dataTable",
           "type": "boolean",
           "default": null,
-          "description": "The \"Show data\" button (the table is in the page for screen readers either way). Default true.",
+          "description": "“View as table” in the actions menu (the table is in the page for screen readers either way). Default true.",
           "required": false
         },
         {
@@ -352,7 +379,7 @@
           "name": "exportable",
           "type": "boolean | readonly ExportFormat[]",
           "default": null,
-          "description": "Export buttons: `true` for PNG, SVG and CSV, or the formats you want.",
+          "description": "The downloads of the actions menu: all three by default, or the formats you want, or `false` for none.",
           "required": false
         },
         {
@@ -383,6 +410,13 @@
           "description": "The id of the figure.",
           "required": false
         },
+        {
+          "name": "insight",
+          "type": "ReactNode",
+          "default": null,
+          "description": "One line that says what the chart shows, between the title and the chart: “100 jobs · +100 % vs last week”.",
+          "required": false
+        },
         {
           "name": "labels",
           "type": "ChartLabelsInput",
@@ -446,6 +480,13 @@
           "description": "Your own summary instead of the generated one (still read first by screen readers).",
           "required": false
         },
+        {
+          "name": "title",
+          "type": "string",
+          "default": null,
+          "description": "What the chart shows, in a few words: its accessible name, and its heading unless `hideTitle`. Inside a `ChartCard`, the card's title is the default.",
+          "required": false
+        },
         {
           "name": "xLabel",
           "type": "string",