@buildcanada/charts 0.1.0

package/LICENSE.md

@@ -0,0 +1,8 @@
+The MIT License (MIT)  
+Copyright (c) 2024 Our World in Data
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,113 @@
+# @buildcanada/charts
+
+Part of the [Build Canada Design System](https://github.com/BuildCanada/bcds) monorepo.
+
+A configurable data visualization library for creating interactive charts. Extracted from [Our World in Data's](https://ourworldindata.org) Grapher.
+
+## Installation
+
+```bash
+npm install @buildcanada/charts
+# or
+bun add @buildcanada/charts
+```
+
+## Peer Dependencies
+
+This library requires the following peer dependencies:
+
+```json
+{
+  "react": "^19.0.0",
+  "react-dom": "^19.0.0",
+  "mobx": "^6.13.0",
+  "mobx-react": "^7.6.0"
+}
+```
+
+## Quick Start
+
+```tsx
+import {
+  ChartsProvider,
+  Grapher,
+  GrapherState,
+  GRAPHER_CHART_TYPES,
+  DimensionProperty,
+  createOwidTestDataset,
+  legacyToOwidTableAndDimensionsWithMandatorySlug,
+} from "@buildcanada/charts"
+import "@buildcanada/charts/styles.css"
+
+// Define your data
+const myData = [
+  { year: 2020, entity: { id: 1, name: "Canada" }, value: 100 },
+  { year: 2021, entity: { id: 1, name: "Canada" }, value: 120 },
+]
+
+const metadata = { id: 1, display: { name: "My Metric" } }
+const dimensions = [{ variableId: 1, property: DimensionProperty.y }]
+
+const dataset = createOwidTestDataset([{ data: myData, metadata }])
+const table = legacyToOwidTableAndDimensionsWithMandatorySlug(dataset, dimensions, {})
+
+const grapherState = new GrapherState({
+  title: "My Chart",
+  chartTypes: [GRAPHER_CHART_TYPES.LineChart],
+  dimensions,
+})
+grapherState.inputTable = table
+
+function App() {
+  return (
+    <ChartsProvider>
+      <div style={{ width: "800px", height: "600px" }}>
+        <Grapher grapherState={grapherState} />
+      </div>
+    </ChartsProvider>
+  )
+}
+```
+
+## Documentation
+
+- **[Data Loading Guide](docs/DATA_LOADING_GUIDE.md)** - Complete guide on loading CSV/JSON data
+- **[Publishing Guide](docs/PUBLISHING.md)** - How to publish to npm
+
+## Development
+
+```bash
+bun install              # Install dependencies
+bun run storybook        # Run Storybook on port 6006
+bun run build            # Build Storybook for production
+bun test                 # Run tests
+bun run typecheck        # TypeScript check
+```
+
+## Components
+
+### Grapher
+
+The main charting component supporting multiple visualization types:
+- Line charts
+- Bar charts (discrete and stacked)
+- Scatter plots
+- World and regional maps
+- Stacked area charts
+- Slope charts
+- Marimekko charts
+
+### Explorer
+
+A data explorer that wraps Grapher and adds additional controls for exploring complex datasets.
+
+## Architecture
+
+- Built with **React 19** and **MobX 6** for state management
+- Uses TC-39 stage 3 decorators
+- TypeScript throughout
+- SCSS for styling with BEM conventions
+
+## License
+
+MIT

package/package.json

@@ -0,0 +1,137 @@
+{
+  "name": "@buildcanada/charts",
+  "version": "0.1.0",
+  "description": "A configurable data visualization library for creating interactive charts. Extracted from Our World in Data's Grapher.",
+  "type": "module",
+  "main": "src/index.ts",
+  "types": "src/index.ts",
+  "exports": {
+    ".": {
+      "types": "./src/index.ts",
+      "import": "./src/index.ts"
+    },
+    "./styles.css": "./src/styles/charts.scss",
+    "./src/styles/charts.scss": "./src/styles/charts.scss",
+    "./src/*": "./src/*"
+  },
+  "files": [
+    "src",
+    "!src/**/*.test.ts",
+    "!src/**/*.test.tsx",
+    "!src/**/*.stories.tsx"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/BuildCanada/bcds.git",
+    "directory": "packages/charts"
+  },
+  "bugs": {
+    "url": "https://github.com/BuildCanada/bcds/issues"
+  },
+  "homepage": "https://github.com/BuildCanada/bcds#readme",
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=22.0"
+  },
+  "scripts": {
+    "build": "storybook build -o storybook-static",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "storybook": "storybook dev -p 6006",
+    "serve-storybook": "serve storybook-static -p 6006"
+  },
+  "keywords": [
+    "charts",
+    "data-visualization",
+    "react",
+    "d3",
+    "grapher",
+    "explorer"
+  ],
+  "author": "Build Canada",
+  "license": "MIT",
+  "peerDependencies": {
+    "mobx": "^6.13.0",
+    "mobx-react": "^7.6.0",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0"
+  },
+  "dependencies": {
+    "@fortawesome/fontawesome-svg-core": "^6.7.2",
+    "@fortawesome/free-brands-svg-icons": "^6.7.2",
+    "@fortawesome/free-solid-svg-icons": "^6.7.2",
+    "@fortawesome/react-fontawesome": "^0.2.2",
+    "@tippyjs/react": "^4.2.6",
+    "@turf/boolean-intersects": "^7.2.0",
+    "@turf/center": "^7.2.0",
+    "classnames": "^2.5.1",
+    "colorbrewer": "^1.3.0",
+    "d3": "^7.9.0",
+    "dayjs": "^1.11.11",
+    "fparser": "^3.1.0",
+    "fuzzysort": "^3.1.0",
+    "indefinite": "^2.5.1",
+    "js-cookie": "^3.0.5",
+    "lodash-es": "^4.17.21",
+    "mdast-util-find-and-replace": "^3.0.2",
+    "mdast-util-from-markdown": "^2.0.2",
+    "mousetrap": "^1.6.5",
+    "papaparse": "^5.5.3",
+    "react-aria-components": "^1.13.0",
+    "react-flip-toolkit": "^7.2.4",
+    "react-markdown": "^10.1.0",
+    "react-move": "^6.5.0",
+    "react-select": "^5.10.2",
+    "remeda": "^2.32.0",
+    "simple-statistics": "^7.8.8",
+    "string-pixel-width": "^1.10.0",
+    "striptags": "^3.2.0",
+    "topojson-client": "^3.1.0",
+    "ts-pattern": "^5.8.0",
+    "unist-util-visit": "^5.0.0",
+    "url-join": "^5.0.0",
+    "url-parse": "^1.5.10",
+    "url-slug": "^4.0.1",
+    "uuidv7": "^1.0.1",
+    "versor": "^0.2.0"
+  },
+  "devDependencies": {
+    "@storybook/addon-docs": "^10.1.11",
+    "@storybook/react": "^10.1.11",
+    "@storybook/react-vite": "^10.1.11",
+    "@testing-library/dom": "^10.4.1",
+    "@testing-library/jest-dom": "^6.9.1",
+    "@testing-library/react": "^16.3.0",
+    "@types/colorbrewer": "^1.0.29",
+    "@types/d3": "^7.4.3",
+    "@types/geojson": "^7946.0.10",
+    "@types/indefinite": "^2.3.4",
+    "@types/js-cookie": "^3.0.6",
+    "@types/lodash-es": "^4",
+    "@types/mousetrap": "^1.6.9",
+    "@types/papaparse": "^5.3.16",
+    "@types/react": "^19.2.2",
+    "@types/react-dom": "^19.2.2",
+    "@types/string-pixel-width": "^1.7.2",
+    "@types/topojson-client": "^3.1.1",
+    "@types/url-parse": "^1.4.8",
+    "@vitejs/plugin-react": "^5.1.1",
+    "eslint": "^9.37.0",
+    "eslint-plugin-react-hooks": "^5.2.0",
+    "happy-dom": "^20.1.0",
+    "jsdom": "^27.4.0",
+    "mobx": "^6.13.7",
+    "mobx-react": "^7.6.0",
+    "react": "^19.2.0",
+    "react-dom": "^19.2.0",
+    "sass": "^1.77.0",
+    "serve": "^14.2.5",
+    "storybook": "^10.1.11",
+    "typescript": "~5.9.2",
+    "vite": "^6.0.0",
+    "vitest": "^4.0.15"
+  }
+}

package/src/components/BodyPortal/BodyPortal.tsx

@@ -0,0 +1,40 @@
+import * as React from "react"
+import ReactDOM from "react-dom"
+
+interface BodyPortalProps {
+    children: React.ReactNode
+    containerClassName?: string
+}
+
+/**
+ * Renders a component on Body instead of inside the current tree.
+ * See https://react.dev/reference/react-dom/createPortal
+ */
+export class BodyPortal extends React.Component<BodyPortalProps> {
+    private element: HTMLDivElement | null = null
+
+    override componentDidMount(): void {
+        if (typeof document !== "undefined") {
+            this.element = document.createElement("div")
+            if (this.props.containerClassName)
+                this.element.className = this.props.containerClassName
+
+            document.body.appendChild(this.element)
+            // Force a re-render now that `this.el` is available for the portal
+            this.forceUpdate()
+        }
+    }
+
+    override componentWillUnmount(): void {
+        // Remove the element from the body if it was added
+        if (this.element && this.element.parentNode === document.body) {
+            document.body.removeChild(this.element)
+        }
+        this.element = null // Clean up the reference
+    }
+
+    override render(): React.ReactPortal | null {
+        if (!this.element) return null
+        return ReactDOM.createPortal(this.props.children, this.element)
+    }
+}

package/src/components/Button/Button.scss

@@ -0,0 +1,110 @@
+.owid-btn {
+    @include body-3-medium;
+    padding: 8.5px 24px;
+    border: 1px solid transparent;
+    border-radius: 0;
+    text-align: center;
+    display: block;
+    cursor: pointer;
+
+    &.owid-btn--icon-only {
+        padding: 4.5px 9px;
+    }
+
+    &:disabled {
+        cursor: default;
+
+        &.owid-btn--solid-blue,
+        &.owid-btn--solid-dark-blue,
+        &.owid-btn--solid-light-blue,
+        &.owid-btn--solid-vermillion {
+            color: $blue-50;
+            background-color: $blue-10;
+        }
+
+        &.owid-btn--outline-vermillion,
+        &.owid-btn--outline-white {
+            color: $blue-40;
+            border-color: $blue-40;
+        }
+    }
+
+    svg {
+        font-size: 0.75rem;
+    }
+}
+
+.owid-btn--icon-right {
+    margin-left: 0.5rem;
+}
+
+.owid-btn--icon-left {
+    margin-right: 0.5rem;
+}
+
+.owid-btn--solid-vermillion {
+    background-color: $vermillion;
+    color: #fff;
+
+    &:hover {
+        background-color: $accent-vermillion;
+    }
+}
+
+.owid-btn--outline-vermillion {
+    border-color: $vermillion;
+    color: $vermillion;
+
+    &:hover {
+        border-color: $accent-vermillion;
+        color: $accent-vermillion;
+    }
+}
+
+.owid-btn--solid-blue {
+    background-color: $blue-60;
+    color: #fff;
+
+    &:hover {
+        background-color: $blue-90;
+    }
+}
+
+.owid-btn--solid-dark-blue {
+    background-color: $blue-95;
+    color: #fff;
+
+    &:hover {
+        background-color: #164377;
+    }
+}
+
+.owid-btn--solid-light-blue {
+    background-color: $blue-20;
+    color: $blue-90;
+
+    &:hover {
+        background-color: $blue-10;
+    }
+}
+
+.owid-btn--outline-white {
+    background-color: transparent;
+    border-color: $white;
+    color: $white;
+
+    &:hover {
+        background-color: $white;
+        color: $blue-90;
+    }
+}
+
+.owid-btn--outline-light-blue {
+    border-color: $blue-20;
+    color: $blue-90;
+
+    &:hover {
+        background-color: $white;
+        color: $blue-90;
+    }
+}

package/src/components/Button/Button.tsx

@@ -0,0 +1,101 @@
+import cx from "classnames"
+import { FontAwesomeIcon } from "@fortawesome/react-fontawesome"
+import { IconDefinition, faArrowRight } from "@fortawesome/free-solid-svg-icons"
+
+type ButtonCommonProps = {
+    text?: string
+    className?: string
+    style?: React.CSSProperties
+    theme:
+        | "solid-vermillion"
+        | "solid-blue"
+        | "solid-dark-blue"
+        | "solid-light-blue"
+        | "outline-vermillion"
+        | "outline-light-blue"
+        | "outline-white"
+    /** Set to null to hide the icon */
+    icon?: IconDefinition | null
+    iconPosition?: "left" | "right"
+    dataTrackNote?: string
+    disabled?: boolean
+    ariaLabel?: string
+}
+
+type WithHrefProps = {
+    href: string
+    onClick?: never
+    type?: never
+}
+
+type WithOnClickProps = {
+    onClick?: () => void
+    href?: never
+    type?: "button" | "submit"
+}
+
+export type ButtonProps =
+    | (ButtonCommonProps & WithHrefProps)
+    | (ButtonCommonProps & WithOnClickProps)
+
+export const Button = ({
+    theme = "solid-vermillion",
+    className,
+    style,
+    href,
+    onClick,
+    text,
+    ariaLabel,
+    type = "button",
+    icon = faArrowRight,
+    iconPosition = "right",
+    dataTrackNote,
+    disabled,
+}: ButtonProps) => {
+    const classes = cx("owid-btn", `owid-btn--${theme}`, className, {
+        "owid-btn--icon-only": icon && !text,
+    })
+    const content = (
+        <>
+            {iconPosition === "left" && icon && (
+                <FontAwesomeIcon
+                    className={cx({ "owid-btn--icon-left": text })}
+                    icon={icon}
+                />
+            )}
+            {text && <span>{text}</span>}
+            {iconPosition !== "left" && icon && (
+                <FontAwesomeIcon
+                    className={cx({ "owid-btn--icon-right": text })}
+                    icon={icon}
+                />
+            )}
+        </>
+    )
+
+    if (href) {
+        const aProps = {
+            href: disabled ? undefined : href,
+            className: classes,
+            style,
+            "data-track-note": dataTrackNote,
+            onClick: disabled
+                ? (e: React.MouseEvent) => e.preventDefault()
+                : undefined,
+            "aria-label": ariaLabel,
+            "aria-disabled": disabled,
+        }
+        return <a {...aProps}>{content}</a>
+    }
+
+    const buttonProps = {
+        type,
+        className: classes,
+        style,
+        onClick,
+        "aria-label": ariaLabel,
+        "data-track-note": dataTrackNote,
+        disabled,
+    }
+    return <button {...buttonProps}>{content}</button>
+}

package/src/components/Checkbox.scss

@@ -0,0 +1,93 @@
+.checkbox {
+    $checkbox-size: 16px;
+
+    $light-stroke: $gray-30;
+    $hover-stroke: $blue-30;
+    $active-fill: $blue-30;
+
+    position: relative;
+
+    label {
+        margin: 0; // style leak in admin
+    }
+
+    input {
+        position: absolute;
+        opacity: 0;
+        left: 0;
+        cursor: pointer;
+        pointer-events: none;
+    }
+
+    .custom {
+        position: absolute;
+        left: 0;
+        top: 0;
+        content: " ";
+        width: $checkbox-size;
+        height: $checkbox-size;
+
+        background: white;
+        pointer-events: none;
+        border-radius: 2px;
+        border: 1px solid $light-stroke;
+        color: #fff;
+
+        display: flex;
+        align-items: center;
+        justify-content: center;
+
+        svg {
+            font-size: 10px;
+            padding-left: 0.75px;
+        }
+    }
+
+    input:focus-visible + .custom {
+        outline: 2px solid $controls-color;
+    }
+
+    input:active + .custom {
+        background: $active-fill;
+    }
+
+    input:checked + .custom {
+        background: $active-fill;
+        border-color: $active-fill;
+    }
+
+    input:checked:active + .custom {
+        background: white;
+    }
+
+    input:disabled {
+        + .custom {
+            background: $blue-10;
+            border-color: $blue-20;
+            color: $blue-50;
+        }
+
+        &:active + .custom {
+            background: $blue-10;
+        }
+
+        ~ .label {
+            color: $blue-50;
+            cursor: not-allowed;
+        }
+    }
+
+    .label {
+        @include grapher_label-2-regular;
+        padding-left: $checkbox-size + 8px;
+        cursor: pointer;
+        user-select: none;
+        color: $dark-text;
+    }
+
+    &:hover {
+        input:not(:checked) + .custom {
+            border-color: $hover-stroke;
+        }
+    }
+}

package/src/components/Checkbox.tsx

@@ -0,0 +1,47 @@
+import * as React from "react"
+import { FontAwesomeIcon } from "@fortawesome/react-fontawesome"
+import { faCheck } from "@fortawesome/free-solid-svg-icons"
+import cx from "classnames"
+
+export const Checkbox = ({
+    className,
+    checked,
+    onChange,
+    label,
+    disabled,
+    id,
+    "data-test": testHook,
+}: {
+    className?: string
+    checked: boolean
+    onChange: React.ChangeEventHandler<HTMLInputElement>
+    label: React.ReactNode
+    disabled?: boolean
+    id?: string
+    "data-test"?: string
+}) => {
+    return (
+        <div
+            className={cx(
+                "checkbox",
+                { "checkbox--disabled": disabled },
+                className
+            )}
+        >
+            <label>
+                <input
+                    id={id}
+                    type="checkbox"
+                    data-test={testHook}
+                    checked={checked}
+                    onChange={onChange}
+                    disabled={disabled}
+                />
+                <div className="custom">
+                    {checked && <FontAwesomeIcon icon={faCheck} />}
+                </div>
+                <div className="label">{label}</div>
+            </label>
+        </div>
+    )
+}