@neo4j-ndl/react-charts 0.0.2

package/lib/esm/charts/utils.js

@@ -0,0 +1,37 @@
+/**
+ *
+ *  Copyright (c) "Neo4j"
+ *  Neo4j Sweden AB [http://neo4j.com]
+ *
+ *  This file is part of Neo4j.
+ *
+ *  Neo4j is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+import { useCallback, useRef } from 'react';
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const useThrottle = (callback, limit) => {
+    const lastCallRef = useRef(0);
+    const throttledCallback = useCallback(
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    (...args) => {
+        const now = Date.now();
+        if (now - lastCallRef.current >= limit) {
+            lastCallRef.current = now;
+            callback(...args);
+        }
+    }, [callback, limit]);
+    return throttledCallback;
+};
+export { useThrottle };
+//# sourceMappingURL=utils.js.map

package/lib/esm/charts/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/charts/utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAE5C,8DAA8D;AAC9D,MAAM,WAAW,GAAG,CAAC,QAAqC,EAAE,KAAa,EAAE,EAAE;IAC3E,MAAM,WAAW,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IAC9B,MAAM,iBAAiB,GAAG,WAAW;IACnC,8DAA8D;IAC9D,CAAC,GAAG,IAAW,EAAE,EAAE;QACjB,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,IAAI,GAAG,GAAG,WAAW,CAAC,OAAO,IAAI,KAAK,EAAE,CAAC;YACvC,WAAW,CAAC,OAAO,GAAG,GAAG,CAAC;YAC1B,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC;QACpB,CAAC;IACH,CAAC,EACD,CAAC,QAAQ,EAAE,KAAK,CAAC,CAClB,CAAC;IACF,OAAO,iBAAiB,CAAC;AAC3B,CAAC,CAAC;AAEF,OAAO,EAAE,WAAW,EAAE,CAAC"}

package/lib/esm/common/ConditionalWrap.js

@@ -0,0 +1,26 @@
+/**
+ *
+ *  Copyright (c) "Neo4j"
+ *  Neo4j Sweden AB [http://neo4j.com]
+ *
+ *  This file is part of Neo4j.
+ *
+ *  Neo4j is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+import { Fragment as _Fragment, jsx as _jsx } from "react/jsx-runtime";
+export const ConditionalWrap = ({ shouldWrap: condition, wrapper, children, }) => {
+    return condition ? _jsx(_Fragment, { children: wrapper(children) }) : _jsx(_Fragment, { children: children });
+};
+//# sourceMappingURL=ConditionalWrap.js.map

package/lib/esm/common/ConditionalWrap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConditionalWrap.js","sourceRoot":"","sources":["../../../src/common/ConditionalWrap.tsx"],"names":[],"mappings":";AA2BA,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,EAC9B,UAAU,EAAE,SAAS,EACrB,OAAO,EACP,QAAQ,GACa,EAAE,EAAE;IACzB,OAAO,SAAS,CAAC,CAAC,CAAC,4BAAG,OAAO,CAAC,QAAQ,CAAC,GAAI,CAAC,CAAC,CAAC,4BAAG,QAAQ,GAAI,CAAC;AAChE,CAAC,CAAC"}

package/lib/esm/index.js

@@ -0,0 +1,22 @@
+/**
+ *
+ *  Copyright (c) "Neo4j"
+ *  Neo4j Sweden AB [http://neo4j.com]
+ *
+ *  This file is part of Neo4j.
+ *
+ *  Neo4j is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+export * from './charts';
+//# sourceMappingURL=index.js.map

package/lib/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,cAAc,UAAU,CAAC"}

package/lib/types/charts/Chart.d.ts

@@ -0,0 +1,38 @@
+/**
+ *
+ *  Copyright (c) "Neo4j"
+ *  Neo4j Sweden AB [http://neo4j.com]
+ *
+ *  This file is part of Neo4j.
+ *
+ *  Neo4j is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+import { type CSSProperties } from 'react';
+import { type EChartsOption, type SetOptionOpts } from 'echarts';
+import { LegendProps } from './Legend';
+export interface ChartProps {
+    dataset: EChartsOption['dataset'];
+    series: EChartsOption['series'];
+    xAxis: EChartsOption['xAxis'];
+    yAxis: EChartsOption['yAxis'];
+    legend?: {
+        show?: boolean;
+        wrappingType?: LegendProps['wrappingType'];
+    };
+    option: Omit<EChartsOption, 'series' | 'dataset' | 'legend' | 'xAxis' | 'yAxis'>;
+    style?: CSSProperties;
+    settings?: SetOptionOpts;
+    loading?: boolean;
+}
+export declare function Chart({ dataset, option: userOption, xAxis, yAxis, series, style, settings, loading, legend, }: ChartProps): JSX.Element;

package/lib/types/charts/ChartTooltip.d.ts

@@ -0,0 +1,59 @@
+/**
+ *
+ *  Copyright (c) "Neo4j"
+ *  Neo4j Sweden AB [http://neo4j.com]
+ *
+ *  This file is part of Neo4j.
+ *
+ *  Neo4j is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+import React from 'react';
+export interface ChartTooltipProps {
+    children: React.ReactNode;
+    className?: string;
+    isOpen?: boolean;
+    style?: React.CSSProperties;
+    anchorPosition?: {
+        x: number;
+        y: number;
+    };
+}
+export declare const ChartTooltipComponent: React.ForwardRefExoticComponent<ChartTooltipProps & React.RefAttributes<HTMLDivElement>>;
+type ChartTooltipTitleProps = {
+    children: React.ReactNode;
+};
+export type ChartTooltipContentProps = {
+    leftElement?: React.ReactNode;
+    rightElement?: React.ReactNode;
+    indentSquareColor?: string;
+    notification?: {
+        leftElement: React.ReactNode;
+        rightElement: React.ReactNode;
+        type: 'warning' | 'danger';
+    };
+};
+declare const ChartTooltip: React.ForwardRefExoticComponent<ChartTooltipProps & React.RefAttributes<HTMLDivElement>> & {
+    Title: React.ForwardRefExoticComponent<ChartTooltipTitleProps & React.RefAttributes<HTMLSpanElement>>;
+    Content: React.ForwardRefExoticComponent<ChartTooltipContentProps & React.RefAttributes<HTMLDivElement>>;
+    Link: React.ForwardRefExoticComponent<Omit<import("@neo4j-ndl/react").TextLinkProps & {
+        as?: React.ElementType<any> | undefined;
+        htmlAttributes?: import("@neo4j-ndl/react/lib/types/_common/types").HtmlAttributes<React.ElementType<any>> | undefined;
+        className?: string;
+        style?: React.CSSProperties;
+    } & {
+        ref?: any;
+    }, "ref"> & React.RefAttributes<unknown>>;
+};
+export { ChartTooltip };

package/lib/types/charts/Legend.d.ts

@@ -0,0 +1,30 @@
+/**
+ *
+ *  Copyright (c) "Neo4j"
+ *  Neo4j Sweden AB [http://neo4j.com]
+ *
+ *  This file is part of Neo4j.
+ *
+ *  Neo4j is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+import React from 'react';
+export interface LegendProps extends React.HTMLAttributes<HTMLDivElement> {
+    wrappingType?: 'wrapping' | 'truncation' | 'overflow';
+    series: {
+        name: string;
+        color: string;
+    }[];
+    chartRef: React.RefObject<HTMLDivElement>;
+}
+export declare const Legend: React.ForwardRefExoticComponent<LegendProps & React.RefAttributes<HTMLDivElement>>;

package/lib/types/charts/index.d.ts

@@ -0,0 +1,21 @@
+/**
+ *
+ *  Copyright (c) "Neo4j"
+ *  Neo4j Sweden AB [http://neo4j.com]
+ *
+ *  This file is part of Neo4j.
+ *
+ *  Neo4j is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+export * from './Chart';

package/lib/types/charts/themes/darkTheme.d.ts

@@ -0,0 +1,55 @@
+/**
+ *
+ *  Copyright (c) "Neo4j"
+ *  Neo4j Sweden AB [http://neo4j.com]
+ *
+ *  This file is part of Neo4j.
+ *
+ *  Neo4j is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+export declare const darkTheme: {
+    version: number;
+    themeName: string;
+    theme: {
+        color: string[];
+        axes: {
+            type: string;
+            axisLineShow: boolean;
+            axisLineColor: string;
+            axisTickShow: boolean;
+            axisTickColor: string;
+            axisLabelShow: boolean;
+            axisLabelColor: string;
+            splitLineShow: boolean;
+            splitLineColor: string[];
+            splitAreaShow: boolean;
+            splitAreaColor: string[];
+        }[];
+        lineWidth: string;
+        backgroundColor: string;
+        kColor: string;
+        kColor0: string;
+        kBorderColor: string;
+        kBorderColor0: string;
+        kBorderWidth: number;
+        symbolSize: string;
+        symbol: string;
+        symbolBorderWidth: string;
+        lineSmooth: boolean;
+        graphLineWidth: number;
+        graphLineColor: string;
+        axisSeperateSetting: boolean;
+    };
+};

package/lib/types/charts/themes/defaultTheme.d.ts

@@ -0,0 +1,51 @@
+/**
+ *
+ *  Copyright (c) "Neo4j"
+ *  Neo4j Sweden AB [http://neo4j.com]
+ *
+ *  This file is part of Neo4j.
+ *
+ *  Neo4j is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+export declare const defaultTheme: {
+    color: string[];
+    axes: {
+        type: string;
+        axisLineShow: boolean;
+        axisLineColor: string;
+        axisTickShow: boolean;
+        axisTickColor: string;
+        axisLabelShow: boolean;
+        axisLabelColor: string;
+        splitLineShow: boolean;
+        splitLineColor: string[];
+        splitAreaShow: boolean;
+        splitAreaColor: string[];
+    }[];
+    lineWidth: string;
+    backgroundColor: string;
+    kColor: string;
+    kColor0: string;
+    kBorderColor: string;
+    kBorderColor0: string;
+    kBorderWidth: number;
+    symbolSize: string;
+    symbol: string;
+    symbolBorderWidth: string;
+    lineSmooth: boolean;
+    graphLineWidth: number;
+    graphLineColor: string;
+    axisSeperateSetting: boolean;
+};

package/lib/types/charts/themes/lightTheme.d.ts

@@ -0,0 +1,55 @@
+/**
+ *
+ *  Copyright (c) "Neo4j"
+ *  Neo4j Sweden AB [http://neo4j.com]
+ *
+ *  This file is part of Neo4j.
+ *
+ *  Neo4j is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+export declare const lightTheme: {
+    version: number;
+    themeName: string;
+    theme: {
+        color: string[];
+        axes: {
+            type: string;
+            axisLineShow: boolean;
+            axisLineColor: string;
+            axisTickShow: boolean;
+            axisTickColor: string;
+            axisLabelShow: boolean;
+            axisLabelColor: string;
+            splitLineShow: boolean;
+            splitLineColor: string[];
+            splitAreaShow: boolean;
+            splitAreaColor: string[];
+        }[];
+        lineWidth: string;
+        backgroundColor: string;
+        kColor: string;
+        kColor0: string;
+        kBorderColor: string;
+        kBorderColor0: string;
+        kBorderWidth: number;
+        symbolSize: string;
+        symbol: string;
+        symbolBorderWidth: string;
+        lineSmooth: boolean;
+        graphLineWidth: number;
+        graphLineColor: string;
+        axisSeperateSetting: boolean;
+    };
+};

package/lib/types/charts/utils.d.ts

@@ -0,0 +1,23 @@
+/**
+ *
+ *  Copyright (c) "Neo4j"
+ *  Neo4j Sweden AB [http://neo4j.com]
+ *
+ *  This file is part of Neo4j.
+ *
+ *  Neo4j is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+declare const useThrottle: (callback: (...args: any[]) => unknown, limit: number) => (...args: any[]) => void;
+export { useThrottle };

package/lib/types/common/ConditionalWrap.d.ts

@@ -0,0 +1,27 @@
+/**
+ *
+ *  Copyright (c) "Neo4j"
+ *  Neo4j Sweden AB [http://neo4j.com]
+ *
+ *  This file is part of Neo4j.
+ *
+ *  Neo4j is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+type ConditionalWrapProps = {
+    shouldWrap: boolean;
+    wrapper: (children: React.ReactNode) => React.ReactNode;
+    children: React.ReactNode;
+};
+export declare const ConditionalWrap: ({ shouldWrap: condition, wrapper, children, }: ConditionalWrapProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/lib/types/index.d.ts

@@ -0,0 +1,21 @@
+/**
+ *
+ *  Copyright (c) "Neo4j"
+ *  Neo4j Sweden AB [http://neo4j.com]
+ *
+ *  This file is part of Neo4j.
+ *
+ *  Neo4j is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+export * from './charts';

package/package.json

@@ -0,0 +1,76 @@
+{
+  "name": "@neo4j-ndl/react-charts",
+  "version": "0.0.2",
+  "sideEffects": false,
+  "description": "React implementation of charts from Neo4j Design System",
+  "keywords": [
+    "neo4j",
+    "react",
+    "design system",
+    "needle",
+    "ndl",
+    "chart",
+    "charts"
+  ],
+  "author": "Neo4j Inc.",
+  "homepage": "https://www.neo4j.design",
+  "license": "GPL-3.0",
+  "main": "./lib/cjs/index.js",
+  "module": "./lib/esm/index.js",
+  "types": "./lib/types/index.d.ts",
+  "exports": {
+    "./icons": {
+      "import": "./lib/esm/icons/index.js",
+      "require": "./lib/cjs/icons/index.js",
+      "types": "./lib/types/icons/index.d.ts"
+    },
+    ".": {
+      "import": "./lib/esm/index.js",
+      "require": "./lib/cjs/index.js",
+      "types": "./lib/types/index.d.ts"
+    }
+  },
+  "directories": {
+    "lib": "lib"
+  },
+  "files": [
+    "lib",
+    "icons"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@axe-core/playwright": "4.9.0",
+    "@playwright/experimental-ct-react": "1.45.0",
+    "@playwright/test": "1.45.0",
+    "@types/react": "18.2.18",
+    "@types/react-dom": "18.2.7",
+    "react": "18.2.0",
+    "typescript": "5.5.4"
+  },
+  "peerDependencies": {
+    "react": ">=16.8.0",
+    "react-dom": ">=16.8.0",
+    "@neo4j-ndl/base": "^3.0.15"
+  },
+  "dependencies": {
+    "classnames": "2.5.1",
+    "echarts": "5.5.1",
+    "usehooks-ts": "3.1.0",
+    "@neo4j-ndl/react": "^3.0.28"
+  },
+  "scripts": {
+    "test": "pnpm test:playwright",
+    "test:playwright": "playwright test -c playwright-component-testing.config.ts",
+    "build": "pnpm build:esm && pnpm build:cjs && pnpm build:types",
+    "build:esm": "tsc -p tsconfig.esm.json",
+    "build:cjs": "tsc -p tsconfig.cjs.json",
+    "watch:esm": "tsc -p tsconfig.esm.json --watch",
+    "watch:cjs": "tsc -p tsconfig.cjs.json --watch",
+    "build:types": "tsc -p tsconfig.types.json",
+    "format": "prettier --write 'src/**/*.{js,jsx,ts,tsx}'",
+    "lint": "eslint src",
+    "nuke:local": "../../scripts/cc.sh '{yellow ☢️} Nuking react! {yellow ☢️}' && pnpm dlx rimraf@5.0.5 .tsbuildinfo node_modules lib playwright-report test-results playwright/.cache"
+  }
+}