@krizaka/charts 0.3.1 → 0.5.0

package/registry/gauge.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": [
@@ -56,13 +67,6 @@
         "component": "Gauge",
         "description": "One figure against its range — credits used of a plan, a challenge's progress, a load.",
         "props": [
-          {
-            "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": "number",
@@ -70,6 +74,13 @@
             "description": "The value.",
             "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",
@@ -140,6 +151,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",
@@ -210,6 +228,13 @@
             "description": "A tick on the arc: the objective.",
             "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": "tone",
             "type": "Tone",
@@ -426,13 +451,6 @@
       "component": "Gauge",
       "description": "One figure against its range — credits used of a plan, a challenge's progress, a load.",
       "props": [
-        {
-          "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": "number",
@@ -440,6 +458,13 @@
           "description": "The value.",
           "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",
@@ -510,6 +535,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",
@@ -580,6 +612,13 @@
           "description": "A tick on the arc: the objective.",
           "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": "tone",
           "type": "Tone",

package/registry/geo-map.json

@@ -8,6 +8,19 @@
   "status": "beta",
   "category": "charts",
   "platforms": "web",
+  "parity": {
+    "web": {
+      "state": "yes"
+    },
+    "native": {
+      "state": "n/a",
+      "reason": "A choropleth over the world; a phone shows the MapLibre map of @krizaka/ui/native/map or a ranked list.",
+      "use": "bar-chart"
+    },
+    "desktop": {
+      "state": "yes"
+    }
+  },
   "engine": "svg",
   "tier": "advanced",
   "whenToUse": [
@@ -82,13 +95,6 @@
             "description": "The field (or function) of the region's ISO 3166-1 alpha-2 code (`\"FR\"`, `\"US\"`).",
             "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)",
@@ -96,6 +102,13 @@
             "description": "The field (or function) of its value.",
             "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",
@@ -114,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
           },
           {
@@ -142,7 +155,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
           },
           {
@@ -173,6 +186,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",
@@ -250,6 +270,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": "valueLabel",
             "type": "string",
@@ -303,13 +330,6 @@
           "description": "The field (or function) of the region's ISO 3166-1 alpha-2 code (`\"FR\"`, `\"US\"`).",
           "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)",
@@ -317,6 +337,13 @@
           "description": "The field (or function) of its value.",
           "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",
@@ -335,7 +362,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
         },
         {
@@ -363,7 +390,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
         },
         {
@@ -394,6 +421,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",
@@ -471,6 +505,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": "valueLabel",
           "type": "string",

package/registry/globe.json

@@ -8,6 +8,20 @@
   "status": "beta",
   "category": "charts",
   "platforms": "web",
+  "parity": {
+    "web": {
+      "state": "yes"
+    },
+    "native": {
+      "state": "n/a",
+      "reason": "A WebGL globe for a site's hero; a phone shows a map or a list.",
+      "use": "bar-chart"
+    },
+    "desktop": {
+      "state": "n/a",
+      "reason": "A public site's page, not a window of the Mac app."
+    }
+  },
   "engine": "svg",
   "tier": "advanced",
   "whenToUse": [
@@ -75,11 +89,11 @@
             "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": "arcs",
@@ -120,7 +134,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
           },
           {
@@ -148,7 +162,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
           },
           {
@@ -179,6 +193,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",
@@ -242,6 +263,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": "valueLabel",
             "type": "string",
@@ -289,11 +317,11 @@
           "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": "arcs",
@@ -334,7 +362,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
         },
         {
@@ -362,7 +390,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
         },
         {
@@ -393,6 +421,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",
@@ -456,6 +491,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": "valueLabel",
           "type": "string",

package/registry/goal-progress.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": [
@@ -76,11 +87,11 @@
             "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": "brand",
@@ -138,6 +149,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<GoalLabels>",
@@ -200,6 +218,13 @@
             "default": null,
             "description": "The time left, written by the app (a `Countdown`, “2 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
           }
         ]
       }
@@ -389,11 +414,11 @@
           "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": "brand",
@@ -451,6 +476,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<GoalLabels>",
@@ -513,6 +545,13 @@
           "default": null,
           "description": "The time left, written by the app (a `Countdown`, “2 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
         }
       ]
     }