@krizaka/charts 0.1.0 → 0.2.0

package/registry/price-ticker.json

@@ -0,0 +1,684 @@
+{
+  "name": "price-ticker",
+  "package": "@krizaka/charts",
+  "type": "chart",
+  "title": "Price ticker",
+  "summary": "A live auction's price: the current bid in large, the change since the opening and the number of bids, the bids as steps, the reserve as a line.",
+  "description": "A live auction's price: the current bid in large, the change since the opening and the number of bids, the bids as steps, the reserve as a line.",
+  "status": "beta",
+  "category": "charts",
+  "platforms": "both",
+  "engine": "svg",
+  "tier": "ready-made",
+  "whenToUse": [
+    "Orochia's auction room, on the web and in the app: the bids as they arrive.",
+    "Any price that moves by discrete steps: a bid, a quote, an offer."
+  ],
+  "whenNotToUse": [
+    {
+      "when": "A price series over days with open, high, low and close.",
+      "use": "candlestick"
+    },
+    {
+      "when": "Money per period.",
+      "use": "earnings-chart"
+    }
+  ],
+  "bestPractices": [
+    "Pass every bid with its time; the opening price and time give the first step.",
+    "Keep `live` on (the default) while the auction runs: no entrance, no announcement of every bid.",
+    "Announce a new bid in the app's own live region (who outbid whom): the chart does not."
+  ],
+  "accessibility": {
+    "keyboard": [
+      {
+        "keys": "Tab",
+        "action": "Moves the focus to the plot, then to the data and export buttons."
+      },
+      {
+        "keys": "Arrow keys",
+        "action": "Walk the bids: each price and time is announced."
+      }
+    ],
+    "notes": [
+      "The current price and the change are written above the plot; the arrow is decorative.",
+      "The reserve is drawn and named until it is met."
+    ]
+  },
+  "related": [
+    "line-chart",
+    "goal-progress",
+    "sparkline"
+  ],
+  "source": "packages/charts/src/meta/price-ticker.ts",
+  "install": {
+    "web": "npm install @krizaka/charts",
+    "native": "npx expo install react-native-svg\nnpm install @krizaka/charts"
+  },
+  "web": {
+    "entry": "@krizaka/charts/ticker",
+    "import": "import { PriceTicker } from \"@krizaka/charts/ticker\";",
+    "props": [
+      {
+        "component": "PriceTicker",
+        "description": "A live auction's price: the current bid, the change since the opening, the steps of the bids, the reserve.",
+        "props": [
+          {
+            "name": "bids",
+            "type": "readonly Bid[]",
+            "default": null,
+            "description": "The bids, in any order: when and how much (minor units).",
+            "required": true
+          },
+          {
+            "name": "currency",
+            "type": "string",
+            "default": null,
+            "description": "The ISO 4217 currency.",
+            "required": true
+          },
+          {
+            "name": "opening",
+            "type": "number",
+            "default": null,
+            "description": "The opening price, in minor units.",
+            "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": "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": "dots",
+            "type": "boolean",
+            "default": null,
+            "description": "A dot on every point (short series). Default false: the end of each line carries one.",
+            "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": "endLabels",
+            "type": "boolean",
+            "default": null,
+            "description": "Write the last value at the end of each line (up to three series). Default true.",
+            "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": "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": "Partial<TickerLabels>",
+            "default": null,
+            "description": "The words, passed translated; English by default.",
+            "required": false
+          },
+          {
+            "name": "legend",
+            "type": "boolean",
+            "default": null,
+            "description": "Show the legend (from two series). Default true.",
+            "required": false
+          },
+          {
+            "name": "live",
+            "type": "boolean",
+            "default": "true",
+            "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": "markers",
+            "type": "readonly Marker[]",
+            "default": null,
+            "description": "Vertical markers at a category: a launch, an incident.",
+            "required": false
+          },
+          {
+            "name": "onSelect",
+            "type": "((datum: Point, index: number) => void)",
+            "default": null,
+            "description": "Called with the row when a point or a bar is clicked (or Enter is pressed on it).",
+            "required": false
+          },
+          {
+            "name": "openedAt",
+            "type": "string | Date",
+            "default": null,
+            "description": "When the auction opened: the first point of the line.",
+            "required": false
+          },
+          {
+            "name": "reserve",
+            "type": "number",
+            "default": null,
+            "description": "The reserve price, drawn as a line until it is met.",
+            "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": "timeFormat",
+            "type": "CategoryFormat",
+            "default": "time",
+            "description": "How the times are written. Default `\"time\"` (`14:30`); `\"datetime\"` for auctions over several days.",
+            "required": false
+          },
+          {
+            "name": "xLabel",
+            "type": "string",
+            "default": null,
+            "description": "The header of the categories in the data table (`Month`).",
+            "required": false
+          },
+          {
+            "name": "zero",
+            "type": "boolean",
+            "default": null,
+            "description": "Start the value axis at zero. Default: true for bars and areas; for lines, unless the values sit far from zero.",
+            "required": false
+          }
+        ]
+      }
+    ],
+    "examples": [
+      {
+        "name": "auction-room",
+        "title": "Auction room",
+        "description": "Eight bids in an Orochia auction, the reserve met.",
+        "path": "examples/price-ticker/auction-room.tsx",
+        "module": "@krizaka/charts/registry/examples/price-ticker/auction-room",
+        "code": "import { PriceTicker } from \"@krizaka/charts/ticker\";\n\n// An Orochia auction: the bids in cents, as they arrived.\nconst bids = [\n  { at: \"2026-10-11T18:02:00Z\", amount: 25_00 },\n  { at: \"2026-10-11T18:05:00Z\", amount: 30_00 },\n  { at: \"2026-10-11T18:11:00Z\", amount: 35_00 },\n  { at: \"2026-10-11T18:12:00Z\", amount: 42_00 },\n  { at: \"2026-10-11T18:20:00Z\", amount: 50_00 },\n  { at: \"2026-10-11T18:26:00Z\", amount: 55_00 },\n  { at: \"2026-10-11T18:31:00Z\", amount: 65_00 },\n  { at: \"2026-10-11T18:33:00Z\", amount: 72_00 },\n];\n\nexport default function AuctionRoom() {\n  return <PriceTicker title=\"Signed first take\" bids={bids} opening={20_00} openedAt=\"2026-10-11T18:00:00Z\" currency=\"USD\" reserve={60_00} height={220} />;\n}\n"
+      },
+      {
+        "name": "no-bid-yet",
+        "title": "No bid yet",
+        "description": "The opening price, the reserve ahead.",
+        "path": "examples/price-ticker/no-bid-yet.tsx",
+        "module": "@krizaka/charts/registry/examples/price-ticker/no-bid-yet",
+        "code": "import { PriceTicker } from \"@krizaka/charts/ticker\";\n\n// The auction has just opened: the opening price, the reserve ahead.\nexport default function NoBidYet() {\n  return <PriceTicker title=\"Studio session, one hour\" bids={[]} opening={40_00} openedAt=\"2026-10-11T18:00:00Z\" currency=\"USD\" reserve={90_00} height={180} />;\n}\n"
+      }
+    ]
+  },
+  "native": {
+    "entry": "@krizaka/charts/native",
+    "import": "import { PriceTicker } from \"@krizaka/charts/native\";",
+    "differences": [
+      "The current price and the change are a headline above the plot.",
+      "No dots on the steps; no data table or export."
+    ],
+    "props": [
+      {
+        "component": "PriceTicker",
+        "description": "A live auction's price (React Native): the current bid in large, the change since the opening, the steps of the bids.",
+        "props": [
+          {
+            "name": "bids",
+            "type": "readonly Bid[]",
+            "default": null,
+            "description": "The bids, in any order.",
+            "required": true
+          },
+          {
+            "name": "currency",
+            "type": "string",
+            "default": null,
+            "description": "The ISO 4217 currency.",
+            "required": true
+          },
+          {
+            "name": "opening",
+            "type": "number",
+            "default": null,
+            "description": "The opening price, in minor units.",
+            "required": true
+          },
+          {
+            "name": "title",
+            "type": "string",
+            "default": null,
+            "description": "What the chart shows: its heading and accessible name.",
+            "required": true
+          },
+          {
+            "name": "brand",
+            "type": "BrandId",
+            "default": null,
+            "description": "The brand whose palette leads. Default Krizaka.",
+            "required": false
+          },
+          {
+            "name": "empty",
+            "type": "ReactNode",
+            "default": null,
+            "description": "Shown instead of the plot when there is nothing to draw. Default: the `empty` label.",
+            "required": false
+          },
+          {
+            "name": "height",
+            "type": "number",
+            "default": null,
+            "description": "The plot's height.",
+            "required": false
+          },
+          {
+            "name": "hideTitle",
+            "type": "boolean",
+            "default": null,
+            "description": "Hide the heading (it stays the accessible name).",
+            "required": false
+          },
+          {
+            "name": "labels",
+            "type": "Partial<TickerLabels>",
+            "default": null,
+            "description": "The words, passed translated.",
+            "required": false
+          },
+          {
+            "name": "locale",
+            "type": "Locale",
+            "default": null,
+            "description": "The locale of every figure and date. Default `\"en-US\"`.",
+            "required": false
+          },
+          {
+            "name": "openedAt",
+            "type": "string | Date",
+            "default": null,
+            "description": "When the auction opened.",
+            "required": false
+          },
+          {
+            "name": "reserve",
+            "type": "number",
+            "default": null,
+            "description": "The reserve price, drawn as a line until it is met.",
+            "required": false
+          },
+          {
+            "name": "scheme",
+            "type": "Mode",
+            "default": null,
+            "description": "Dark or light. Default: the device's (pass `useTheme().scheme` of\n@krizaka /ui/native to follow the app).",
+            "required": false
+          },
+          {
+            "name": "style",
+            "type": "ViewStyle",
+            "default": null,
+            "description": "The style of the chart's container (layout only: colours come from the theme).",
+            "required": false
+          },
+          {
+            "name": "theme",
+            "type": "Partial<ChartTheme>",
+            "default": null,
+            "description": "The app's colour roles (`useTheme().theme` of\n@krizaka /ui/native): a product's brand overrides apply.",
+            "required": false
+          },
+          {
+            "name": "timeFormat",
+            "type": "CategoryFormat",
+            "default": "time",
+            "description": "How the times are written. Default `\"time\"`.",
+            "required": false
+          }
+        ]
+      }
+    ],
+    "examples": [
+      {
+        "name": "auction-room",
+        "title": "Auction room",
+        "description": "The auction screen of the app.",
+        "path": "examples/price-ticker/native/auction-room.tsx",
+        "module": "@krizaka/charts/registry/examples/price-ticker/native/auction-room",
+        "code": "import { PriceTicker } from \"@krizaka/charts/native\";\n\nconst bids = [\n  { at: \"2026-10-11T18:02:00Z\", amount: 25_00 },\n  { at: \"2026-10-11T18:05:00Z\", amount: 30_00 },\n  { at: \"2026-10-11T18:11:00Z\", amount: 35_00 },\n  { at: \"2026-10-11T18:20:00Z\", amount: 50_00 },\n  { at: \"2026-10-11T18:31:00Z\", amount: 65_00 },\n  { at: \"2026-10-11T18:33:00Z\", amount: 72_00 },\n];\n\n// The auction screen of the app: the current bid first.\nexport default function NativeAuctionRoom() {\n  return <PriceTicker title=\"Signed first take\" bids={bids} opening={20_00} openedAt=\"2026-10-11T18:00:00Z\" currency=\"USD\" reserve={60_00} height={160} />;\n}\n",
+        "screenshots": {
+          "dark": "examples/price-ticker/native/auction-room.dark.png",
+          "light": "examples/price-ticker/native/auction-room.light.png"
+        }
+      }
+    ]
+  },
+  "files": [],
+  "dependencies": [
+    "@krizaka/intl@workspace:^",
+    "d3-geo@^3.1.1",
+    "echarts@^6.1.0",
+    "topojson-client@^3.1.0"
+  ],
+  "registryDependencies": [],
+  "demo": {
+    "path": "examples/price-ticker/auction-room.tsx",
+    "content": "import { PriceTicker } from \"@krizaka/charts/ticker\";\n\n// An Orochia auction: the bids in cents, as they arrived.\nconst bids = [\n  { at: \"2026-10-11T18:02:00Z\", amount: 25_00 },\n  { at: \"2026-10-11T18:05:00Z\", amount: 30_00 },\n  { at: \"2026-10-11T18:11:00Z\", amount: 35_00 },\n  { at: \"2026-10-11T18:12:00Z\", amount: 42_00 },\n  { at: \"2026-10-11T18:20:00Z\", amount: 50_00 },\n  { at: \"2026-10-11T18:26:00Z\", amount: 55_00 },\n  { at: \"2026-10-11T18:31:00Z\", amount: 65_00 },\n  { at: \"2026-10-11T18:33:00Z\", amount: 72_00 },\n];\n\nexport default function AuctionRoom() {\n  return <PriceTicker title=\"Signed first take\" bids={bids} opening={20_00} openedAt=\"2026-10-11T18:00:00Z\" currency=\"USD\" reserve={60_00} height={220} />;\n}\n"
+  },
+  "props": [
+    {
+      "component": "PriceTicker",
+      "description": "A live auction's price: the current bid, the change since the opening, the steps of the bids, the reserve.",
+      "props": [
+        {
+          "name": "bids",
+          "type": "readonly Bid[]",
+          "default": null,
+          "description": "The bids, in any order: when and how much (minor units).",
+          "required": true
+        },
+        {
+          "name": "currency",
+          "type": "string",
+          "default": null,
+          "description": "The ISO 4217 currency.",
+          "required": true
+        },
+        {
+          "name": "opening",
+          "type": "number",
+          "default": null,
+          "description": "The opening price, in minor units.",
+          "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": "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": "dots",
+          "type": "boolean",
+          "default": null,
+          "description": "A dot on every point (short series). Default false: the end of each line carries one.",
+          "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": "endLabels",
+          "type": "boolean",
+          "default": null,
+          "description": "Write the last value at the end of each line (up to three series). Default true.",
+          "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": "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": "Partial<TickerLabels>",
+          "default": null,
+          "description": "The words, passed translated; English by default.",
+          "required": false
+        },
+        {
+          "name": "legend",
+          "type": "boolean",
+          "default": null,
+          "description": "Show the legend (from two series). Default true.",
+          "required": false
+        },
+        {
+          "name": "live",
+          "type": "boolean",
+          "default": "true",
+          "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": "markers",
+          "type": "readonly Marker[]",
+          "default": null,
+          "description": "Vertical markers at a category: a launch, an incident.",
+          "required": false
+        },
+        {
+          "name": "onSelect",
+          "type": "((datum: Point, index: number) => void)",
+          "default": null,
+          "description": "Called with the row when a point or a bar is clicked (or Enter is pressed on it).",
+          "required": false
+        },
+        {
+          "name": "openedAt",
+          "type": "string | Date",
+          "default": null,
+          "description": "When the auction opened: the first point of the line.",
+          "required": false
+        },
+        {
+          "name": "reserve",
+          "type": "number",
+          "default": null,
+          "description": "The reserve price, drawn as a line until it is met.",
+          "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": "timeFormat",
+          "type": "CategoryFormat",
+          "default": "time",
+          "description": "How the times are written. Default `\"time\"` (`14:30`); `\"datetime\"` for auctions over several days.",
+          "required": false
+        },
+        {
+          "name": "xLabel",
+          "type": "string",
+          "default": null,
+          "description": "The header of the categories in the data table (`Month`).",
+          "required": false
+        },
+        {
+          "name": "zero",
+          "type": "boolean",
+          "default": null,
+          "description": "Start the value axis at zero. Default: true for bars and areas; for lines, unless the values sit far from zero.",
+          "required": false
+        }
+      ]
+    }
+  ]
+}