@kubit-ui-web/react-charts 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,368 @@
+# Kubit React Charts
+
+<p align="center">
+  <img src="./assets/readme_logo.png" alt="Kubito" width="120" height="120" />
+</p>
+
+<p align="center">
+  <strong>A modern React charting library</strong><br/>
+  Reusable, accessible, and interactive SVG components for data visualization
+</p>
+
+<p align="center">
+  <img src="https://img.shields.io/badge/React-18.3.1-blue?logo=react" alt="React version" />
+  <img src="https://img.shields.io/badge/TypeScript-5.9.2-blue?logo=typescript" alt="TypeScript version" />
+  <img src="https://img.shields.io/badge/license-ISC-green" alt="License" />
+</p>
+
+---
+
+## Table of Contents
+
+### For Library Users
+
+- [Features](#features)
+- [Installation](#installation)
+- [Quick Start](#quick-start)
+- [Available Components](#available-components)
+- [API Reference](#api-reference)
+
+### For Contributors & Developers
+
+- [Development Setup](#development-setup)
+- [Project Architecture](#project-architecture)
+- [Development Scripts](#development-scripts)
+- [Contributing Guidelines](#contributing-guidelines)
+- [License](#license)
+
+---
+
+# For Library Users
+
+## Features
+
+**Composable**: Modular architecture where each chart is composed of specialized elements  
+**Performant**: Optimized SVG rendering with React 18  
+**Accessible**: WCAG compliant with keyboard navigation support  
+**Customizable**: Flexible styling and granular configurations  
+**Responsive**: Adaptable to different screen sizes  
+**TypeScript**: Fully typed for better developer experience  
+**Tested**: Complete coverage with Vitest and Testing Library
+
+## Installation
+
+### NPM
+
+```bash
+npm install @kubit-ui-web/react-charts
+```
+
+### Yarn
+
+```bash
+yarn add @kubit-ui-web/react-charts
+```
+
+### Peer Dependencies
+
+This library requires React as a peer dependency:
+
+```bash
+npm install react react-dom
+# or
+yarn add react react-dom
+```
+
+**Compatible versions:**
+
+- React: ^18.3.1
+- React DOM: ^18.3.1
+
+## Quick Start
+
+### Importing Components
+
+```typescript
+// Import complete charts
+import { BarChart, LineChart, PieChart } from "@kubit-ui-web/react-charts";
+
+// Import specific components
+import { Plot, Path, Node } from "@kubit-ui-web/react-charts/components";
+
+// Import types
+import type { ChartData, BarOrientation } from "@kubit-ui-web/react-charts/types";
+```
+
+### LineChart Example
+
+```tsx
+import React from "react";
+import { LineChart } from "@kubit-ui-web/react-charts";
+
+const data = [
+  { year: "2020", sales: 100, profit: 20 },
+  { year: "2021", sales: 150, profit: 35 },
+  { year: "2022", sales: 180, profit: 45 },
+  { year: "2023", sales: 200, profit: 60 },
+];
+
+function MyLineChart() {
+  return (
+    <LineChart data={data} xKey="year" width="100%" height="400px">
+      <LineChart.Path dataKey="sales" stroke="#0078D4" strokeWidth={2} />
+      <LineChart.Path dataKey="profit" stroke="#FF6B35" strokeWidth={2} />
+      <LineChart.XAxis position="BOTTOM" showTickLines />
+      <LineChart.YAxis position="LEFT" valueFormatter={(val) => `$${val}k`} />
+    </LineChart>
+  );
+}
+```
+
+### BarChart Example
+
+```tsx
+import React from "react";
+import { BarChart, BarOrientation } from "@kubit-ui-web/react-charts";
+
+const data = [
+  { category: "A", value: 30 },
+  { category: "B", value: 45 },
+  { category: "C", value: 25 },
+  { category: "D", value: 60 },
+];
+
+function MyBarChart() {
+  return (
+    <BarChart
+      data={data}
+      pKey="category"
+      orientation={BarOrientation.VERTICAL}
+      gapBetweenBars={5}
+      width="100%"
+      height="400px"
+    >
+      <BarChart.Path
+        dataKey="value"
+        dataIdx={0}
+        barConfig={{
+          barWidth: 40,
+          singleConfig: [{ color: "#0078D4", coverage: 100 }],
+        }}
+      />
+      <BarChart.XAxis position="BOTTOM" />
+      <BarChart.YAxis position="LEFT" />
+    </BarChart>
+  );
+}
+```
+
+## Available Components
+
+### Main Charts
+
+| Component       | Description                   | Use Cases                           |
+| --------------- | ----------------------------- | ----------------------------------- |
+| **`LineChart`** | Multi-series line chart       | Time trends, metric comparisons     |
+| **`BarChart`**  | Horizontal/vertical bar chart | Category comparisons, discrete data |
+| **`PieChart`**  | Circular chart with segments  | Part-to-whole relationships         |
+
+### Base Components
+
+| Component       | Description                   |
+| --------------- | ----------------------------- |
+| **`Plot`**      | Base SVG container for charts |
+| **`Path`**      | Customizable SVG path element |
+| **`Node`**      | Interactive points in charts  |
+| **`Line`**      | Lines and connectors          |
+| **`Bar`**       | Rectangular bars              |
+| **`ChartText`** | Formatted text for labels     |
+
+### Available Hooks
+
+| Hook           | Description                              |
+| -------------- | ---------------------------------------- |
+| **`useFocus`** | Focus state management for accessibility |
+| **`useHover`** | Hover detection with callbacks           |
+
+## API Reference
+
+For detailed API documentation, component props, and advanced examples, please refer to our individual component READMEs:
+
+- [BarChart Documentation](./app/src/charts/barChart/README.md)
+- [LineChart Documentation](./app/src/charts/lineChart/README.md)
+- [PieChart Documentation](./app/src/charts/pieChart/README.md)
+
+---
+
+# For Contributors & Developers
+
+<p align="center">
+  <img src="./app/assets/KubitoJumping.gif" alt="Kubito jumping" width="100" />
+</p>
+
+## Development Setup
+
+### Environment Requirements
+
+- Node.js >= 16
+- Yarn (recommended) or npm
+- Git
+
+### Getting Started
+
+1. **Clone the repository**
+
+   ```bash
+   git clone https://github.com/kubit-ui/kubit-react-charts
+   cd web-ui-charts/app
+   ```
+
+2. **Install dependencies**
+
+   ```bash
+   yarn install
+   ```
+
+3. **Start development server**
+   ```bash
+   yarn start
+   ```
+
+This will launch Storybook at `http://localhost:6006` where you can interact with all components.
+
+## Project Architecture
+
+```
+src/
+├── charts/           # High-level chart components
+│   ├── barChart/     # BarChart and subcomponents
+│   ├── lineChart/    # LineChart and subcomponents
+│   └── pieChart/     # PieChart and subcomponents
+├── components/       # Reusable SVG base components
+│   ├── plot/         # Main SVG container
+│   ├── path/         # Path elements
+│   ├── node/         # Interactive points
+│   ├── line/         # Lines and connectors
+│   └── ...
+├── hooks/            # Custom hooks
+├── types/            # TypeScript definitions
+├── utils/            # Shared utility functions
+└── storybook/        # Storybook configuration and constants
+```
+
+### Composition Pattern
+
+Each chart follows a consistent compositional pattern:
+
+```typescript
+const LineChart = Object.assign(LineChartStructure, {
+  Path: LineChartPath,
+  XAxis: LineChartXAxis,
+  YAxis: LineChartYAxis,
+  Separator: LineChartSeparator,
+});
+```
+
+This pattern enables:
+
+- **Flexibility**: Use only the components you need
+- **Reusability**: Shared components between different charts
+- **Extensibility**: Easy addition of new subcomponents
+
+## Development Scripts
+
+### Main Commands
+
+```bash
+# Start Storybook in development mode
+yarn start
+
+# Build library for production
+yarn dist
+
+# Run tests with coverage
+yarn test
+
+# Lint code with ESLint
+yarn eslint
+
+# Build Storybook for production
+yarn build
+
+# Run accessibility tests
+yarn storybook:axe
+```
+
+### Build Commands
+
+```bash
+# Complete build (ESM + CJS)
+yarn dist
+
+# Build in watch mode
+yarn dist:watch
+
+# CommonJS only
+yarn dist:cjs
+
+# ES Modules only
+yarn dist:esm
+```
+
+### Testing Commands
+
+```bash
+# Unit tests with UI
+yarn vitest-report
+
+# Storybook tests
+yarn test-storybook
+
+# ESLint only
+yarn eslint --fix
+```
+
+## Contributing Guidelines
+
+### Code Standards
+
+- **TypeScript**: Fully typed code
+- **ESLint**: Strict configuration with Kubit rules
+- **Prettier**: Automatic code formatting
+- **Testing**: Minimum 80% coverage
+
+### Contribution Workflow
+
+1. Create a feature branch from `main`
+2. Develop following project conventions
+3. Write tests for new features
+4. Run `yarn test` to verify
+5. Create Pull Request
+
+### Conventions
+
+- **Commits**: Use conventional commits
+- **Components**: Follow existing composition pattern
+- **Tests**: One test file per component
+- **Stories**: Document all use cases
+
+### Component Development Guidelines
+
+Please refer to our [development instructions](./.github/copilot-instructions.md) for detailed guidelines on:
+
+- Component structure and patterns
+- Naming conventions
+- TypeScript usage
+- Error handling
+- CSS and styling
+- Accessibility requirements
+
+## License
+
+This project is licensed under the ISC License.
+
+---
+
+<p align="center">
+  Made with ❤️ by the <strong>Kubit</strong> team <img src="./assets/kubito.png" alt="Kubito" width="15" height="15" />
+</p>

package/dist/cjs/charts/barChart/barChart.d.ts

@@ -0,0 +1,9 @@
+declare const BarChart: import("react").FC<import("./barChart.type").BarChartProps> & {
+    Path: import("react").FC<import("./barChart.type").BarChartPathProps>;
+    Separator: import("react").FC<import("./barChart.type").BarChartSeparatorProps>;
+    XAxis: import("react").FC<import("./barChart.type").BarChartXAxisProps>;
+    YAxis: import("react").FC<import("./barChart.type").BarChartYAxisProps>;
+};
+export { BarChart };
+export * from './barChart.type';
+//# sourceMappingURL=barChart.d.ts.map

package/dist/cjs/charts/barChart/barChart.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"barChart.d.ts","sourceRoot":"","sources":["../../../../src/charts/barChart/barChart.ts"],"names":[],"mappings":"AAMA,QAAA,MAAM,QAAQ;;;;;CAKZ,CAAC;AAEH,OAAO,EAAE,QAAQ,EAAE,CAAC;AAEpB,cAAc,iBAAiB,CAAC"}

package/dist/cjs/charts/barChart/barChart.js

@@ -0,0 +1,30 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BarChart = void 0;
+const barChartStructure_1 = require("./barChartStructure");
+const barChartPath_1 = require("./fragments/barChartPath");
+const barChartSeparator_1 = require("./fragments/barChartSeparator");
+const barChartXAxis_1 = require("./fragments/barChartXAxis");
+const barChartYAxis_1 = require("./fragments/barChartYAxis");
+const BarChart = Object.assign(barChartStructure_1.BarChartStructure, {
+    Path: barChartPath_1.BarChartPath,
+    Separator: barChartSeparator_1.BarChartSeparator,
+    XAxis: barChartXAxis_1.BarChartXAxis,
+    YAxis: barChartYAxis_1.BarChartYAxis,
+});
+exports.BarChart = BarChart;
+__exportStar(require("./barChart.type"), exports);