@krizaka/charts 0.3.1 → 0.5.0

package/registry/heatmap.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": [
@@ -80,13 +93,6 @@
             "description": "One row per cell.",
             "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)",
@@ -108,6 +114,13 @@
             "description": "The field of the row (a weekday, a team).",
             "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",
@@ -126,7 +139,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
           },
           {
@@ -154,7 +167,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
           },
           {
@@ -185,6 +198,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",
@@ -241,6 +261,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": "xCategories",
             "type": "readonly unknown[]",
@@ -322,13 +349,6 @@
           "description": "One row per cell.",
           "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)",
@@ -350,6 +370,13 @@
           "description": "The field of the row (a weekday, a team).",
           "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",
@@ -368,7 +395,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
         },
         {
@@ -396,7 +423,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
         },
         {
@@ -427,6 +454,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",
@@ -483,6 +517,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": "xCategories",
           "type": "readonly unknown[]",

package/registry/index.json

@@ -1,6 +1,6 @@
 {
   "name": "@krizaka/charts",
-  "version": "0.3.1",
+  "version": "0.5.0",
   "items": [
     {
       "name": "area-chart",
@@ -14,6 +14,17 @@
       "status": "beta",
       "category": "charts",
       "platforms": "both",
+      "parity": {
+        "web": {
+          "state": "yes"
+        },
+        "native": {
+          "state": "yes"
+        },
+        "desktop": {
+          "state": "yes"
+        }
+      },
       "examples": {
         "web": 2,
         "native": 1
@@ -38,6 +49,17 @@
       "status": "beta",
       "category": "charts",
       "platforms": "both",
+      "parity": {
+        "web": {
+          "state": "yes"
+        },
+        "native": {
+          "state": "yes"
+        },
+        "desktop": {
+          "state": "yes"
+        }
+      },
       "examples": {
         "web": 3,
         "native": 1
@@ -62,6 +84,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"
+        }
+      },
       "examples": {
         "web": 1,
         "native": 0
@@ -86,6 +121,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"
+        }
+      },
       "examples": {
         "web": 1,
         "native": 0
@@ -110,6 +158,19 @@
       "status": "beta",
       "category": "charts",
       "platforms": "web",
+      "parity": {
+        "web": {
+          "state": "yes"
+        },
+        "native": {
+          "state": "n/a",
+          "reason": "The ECharts escape hatch needs the DOM; a phone draws the SVG charts of the native entry.",
+          "use": "line-chart"
+        },
+        "desktop": {
+          "state": "yes"
+        }
+      },
       "examples": {
         "web": 1,
         "native": 0
@@ -122,6 +183,43 @@
       ],
       "registryDependencies": []
     },
+    {
+      "name": "chart-card",
+      "type": "chart",
+      "package": "@krizaka/charts",
+      "engine": null,
+      "tier": "ready-made",
+      "title": "Chart card",
+      "summary": "The frame of a chart: title, one line of insight, the chart, a footer, and the actions menu (view as table, download, copy) — used everywhere a chart is shown.",
+      "description": "The frame of a chart: title, one line of insight, the chart, a footer, and the actions menu (view as table, download, copy) — used everywhere a chart is shown.",
+      "status": "beta",
+      "category": "charts",
+      "platforms": "web",
+      "parity": {
+        "web": {
+          "state": "yes"
+        },
+        "native": {
+          "state": "gap",
+          "reason": "A phone dashboard frames its charts in a Card by hand today.",
+          "issue": "krizaka/krizaka-ui#275"
+        },
+        "desktop": {
+          "state": "yes"
+        }
+      },
+      "examples": {
+        "web": 4,
+        "native": 0
+      },
+      "dependencies": [
+        "@krizaka/intl@workspace:^",
+        "d3-geo@^3.1.1",
+        "echarts@^6.1.0",
+        "topojson-client@^3.1.0"
+      ],
+      "registryDependencies": []
+    },
     {
       "name": "charts-provider",
       "type": "chart",
@@ -134,6 +232,17 @@
       "status": "beta",
       "category": "charts",
       "platforms": "both",
+      "parity": {
+        "web": {
+          "state": "yes"
+        },
+        "native": {
+          "state": "yes"
+        },
+        "desktop": {
+          "state": "yes"
+        }
+      },
       "examples": {
         "web": 1,
         "native": 1
@@ -158,6 +267,17 @@
       "status": "beta",
       "category": "charts",
       "platforms": "both",
+      "parity": {
+        "web": {
+          "state": "yes"
+        },
+        "native": {
+          "state": "yes"
+        },
+        "desktop": {
+          "state": "yes"
+        }
+      },
       "examples": {
         "web": 2,
         "native": 1
@@ -182,6 +302,17 @@
       "status": "beta",
       "category": "charts",
       "platforms": "both",
+      "parity": {
+        "web": {
+          "state": "yes"
+        },
+        "native": {
+          "state": "yes"
+        },
+        "desktop": {
+          "state": "yes"
+        }
+      },
       "examples": {
         "web": 2,
         "native": 1
@@ -206,6 +337,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"
+        }
+      },
       "examples": {
         "web": 1,
         "native": 0
@@ -230,6 +374,17 @@
       "status": "beta",
       "category": "charts",
       "platforms": "both",
+      "parity": {
+        "web": {
+          "state": "yes"
+        },
+        "native": {
+          "state": "yes"
+        },
+        "desktop": {
+          "state": "yes"
+        }
+      },
       "examples": {
         "web": 2,
         "native": 1
@@ -254,6 +409,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"
+        }
+      },
       "examples": {
         "web": 1,
         "native": 0
@@ -278,6 +446,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."
+        }
+      },
       "examples": {
         "web": 1,
         "native": 0
@@ -302,6 +484,17 @@
       "status": "beta",
       "category": "charts",
       "platforms": "both",
+      "parity": {
+        "web": {
+          "state": "yes"
+        },
+        "native": {
+          "state": "yes"
+        },
+        "desktop": {
+          "state": "yes"
+        }
+      },
       "examples": {
         "web": 2,
         "native": 1
@@ -326,6 +519,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"
+        }
+      },
       "examples": {
         "web": 1,
         "native": 0
@@ -350,6 +556,17 @@
       "status": "beta",
       "category": "charts",
       "platforms": "both",
+      "parity": {
+        "web": {
+          "state": "yes"
+        },
+        "native": {
+          "state": "yes"
+        },
+        "desktop": {
+          "state": "yes"
+        }
+      },
       "examples": {
         "web": 2,
         "native": 1
@@ -362,6 +579,43 @@
       ],
       "registryDependencies": []
     },
+    {
+      "name": "kpi-stat",
+      "type": "chart",
+      "package": "@krizaka/charts",
+      "engine": null,
+      "tier": "ready-made",
+      "title": "KPI stat",
+      "summary": "A key figure with its change against the previous period and a sparkline of the period, on the kit's Stat.",
+      "description": "A key figure with its change against the previous period and a sparkline of the period, on the kit's Stat.",
+      "status": "beta",
+      "category": "charts",
+      "platforms": "web",
+      "parity": {
+        "web": {
+          "state": "yes"
+        },
+        "native": {
+          "state": "gap",
+          "reason": "A phone dashboard's head writes its figures by hand today.",
+          "issue": "krizaka/krizaka-ui#275"
+        },
+        "desktop": {
+          "state": "yes"
+        }
+      },
+      "examples": {
+        "web": 2,
+        "native": 0
+      },
+      "dependencies": [
+        "@krizaka/intl@workspace:^",
+        "d3-geo@^3.1.1",
+        "echarts@^6.1.0",
+        "topojson-client@^3.1.0"
+      ],
+      "registryDependencies": []
+    },
     {
       "name": "latency-chart",
       "type": "chart",
@@ -374,6 +628,17 @@
       "status": "beta",
       "category": "charts",
       "platforms": "both",
+      "parity": {
+        "web": {
+          "state": "yes"
+        },
+        "native": {
+          "state": "yes"
+        },
+        "desktop": {
+          "state": "yes"
+        }
+      },
       "examples": {
         "web": 2,
         "native": 1
@@ -398,6 +663,17 @@
       "status": "beta",
       "category": "charts",
       "platforms": "both",
+      "parity": {
+        "web": {
+          "state": "yes"
+        },
+        "native": {
+          "state": "yes"
+        },
+        "desktop": {
+          "state": "yes"
+        }
+      },
       "examples": {
         "web": 4,
         "native": 1
@@ -422,6 +698,17 @@
       "status": "beta",
       "category": "charts",
       "platforms": "both",
+      "parity": {
+        "web": {
+          "state": "yes"
+        },
+        "native": {
+          "state": "yes"
+        },
+        "desktop": {
+          "state": "yes"
+        }
+      },
       "examples": {
         "web": 2,
         "native": 1
@@ -446,6 +733,17 @@
       "status": "beta",
       "category": "charts",
       "platforms": "both",
+      "parity": {
+        "web": {
+          "state": "yes"
+        },
+        "native": {
+          "state": "yes"
+        },
+        "desktop": {
+          "state": "yes"
+        }
+      },
       "examples": {
         "web": 2,
         "native": 1
@@ -470,6 +768,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"
+        }
+      },
       "examples": {
         "web": 1,
         "native": 0
@@ -494,6 +805,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"
+        }
+      },
       "examples": {
         "web": 1,
         "native": 0
@@ -518,6 +842,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"
+        }
+      },
       "examples": {
         "web": 1,
         "native": 0
@@ -542,6 +879,17 @@
       "status": "beta",
       "category": "charts",
       "platforms": "both",
+      "parity": {
+        "web": {
+          "state": "yes"
+        },
+        "native": {
+          "state": "yes"
+        },
+        "desktop": {
+          "state": "yes"
+        }
+      },
       "examples": {
         "web": 3,
         "native": 1
@@ -566,6 +914,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"
+        }
+      },
       "examples": {
         "web": 1,
         "native": 0