# @kyndryl-design-system/shidoka-charts

> Shidoka Charts

Latest version **2.12.5** (published 2026-10-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @kyndryl-design-system/shidoka-charts
pnpm add @kyndryl-design-system/shidoka-charts
yarn add @kyndryl-design-system/shidoka-charts
bun add @kyndryl-design-system/shidoka-charts
```

## Health

**Score 75/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 2.12.5 |
| Published | 2026-10-07 |
| First published | 2023-09-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 19 |
| Unpacked size | 467.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| Maintainers | kumarivijeta, w.barbee, shidoka-bot |

## Links

- npm: https://www.npmjs.com/package/@kyndryl-design-system/shidoka-charts
- Repository: https://github.com/kyndryl-design-system/shidoka-charts
- Homepage: https://github.com/kyndryl-design-system/shidoka-charts#readme
- Issues: https://github.com/kyndryl-design-system/shidoka-charts/issues
- npm.io page: https://npm.io/package/@kyndryl-design-system/shidoka-charts

## Dependencies (19)

- [lit](https://npm.io/package/lit.md) ^3.3.0
- [tslib](https://npm.io/package/tslib.md) ^2.8.1
- [mermaid](https://npm.io/package/mermaid.md) ^11.13.0
- [chart.js](https://npm.io/package/chart.js.md) ^4.5.1
- [date-fns](https://npm.io/package/date-fns.md) ^2.30.0
- [deepmerge-ts](https://npm.io/package/deepmerge-ts.md) ^8.0.0
- [chartjs-chart-geo](https://npm.io/package/chartjs-chart-geo.md) ^4.2.4
- [chartjs-chart-graph](https://npm.io/package/chartjs-chart-graph.md) ^4.3.4
- [chartjs-chart-matrix](https://npm.io/package/chartjs-chart-matrix.md) ^2.0.1
- [chartjs-chart-sankey](https://npm.io/package/chartjs-chart-sankey.md) ^0.14.0
- [chartjs-chart-treemap](https://npm.io/package/chartjs-chart-treemap.md) ^2.3.0
- [chartjs-adapter-date-fns](https://npm.io/package/chartjs-adapter-date-fns.md) ^3.0.0
- [chartjs-plugin-annotation](https://npm.io/package/chartjs-plugin-annotation.md) ^3.0.1
- [chartjs-plugin-datalabels](https://npm.io/package/chartjs-plugin-datalabels.md) ^2.2.0
- [chartjs-plugin-a11y-legend](https://npm.io/package/chartjs-plugin-a11y-legend.md) ^0.1.0
- [chartjs-plugin-chart2music](https://npm.io/package/chartjs-plugin-chart2music.md) ^0.1.2
- [@sgratzl/chartjs-chart-boxplot](https://npm.io/package/@sgratzl/chartjs-chart-boxplot.md) ^4.4.4
- [@kyndryl-design-system/shidoka-icons](https://npm.io/package/@kyndryl-design-system/shidoka-icons.md) ^2.21.0
- [@kyndryl-design-system/shidoka-foundation](https://npm.io/package/@kyndryl-design-system/shidoka-foundation.md) ^2.8.10

## Recent versions

- 2.12.5 (latest) — 2026-10-07
- 2.5.5-beta.1 (beta) — 2025-11-05
- 2.0.0-next.8 (next) — 2025-02-12
- 2.12.4 — 2026-09-21
- 2.12.3 — 2026-08-19
- 2.12.2 — 2026-08-04
- 2.12.1 — 2026-07-30
- 2.12.0 — 2026-07-28
- 2.11.0 — 2026-07-22
- 2.10.2 — 2026-07-06
- 2.10.1 — 2026-06-11
- 2.10.0 — 2026-05-27
- 2.9.0 — 2026-03-13
- 2.8.11 — 2026-03-06
- 2.8.10 — 2026-02-23
- … 90 more at https://npm.io/package/@kyndryl-design-system/shidoka-charts/versions

## README

# Shidoka Charts

[![Release](https://github.com/kyndryl-design-system/shidoka-charts/actions/workflows/release.yml/badge.svg)](https://github.com/kyndryl-design-system/shidoka-charts/actions/workflows/release.yml)

# Contributing to this project

Read the [Contributing Guide](CONTRIBUTING.md) here.

# Using this library in another project

## Install the package

```bash
npm install @kyndryl-design-system/shidoka-charts -S
```

## Import the root stylesheet to your app's global styles

The method used (SCSS @use, CSS @import, JS import, or &lt;style&gt; tag) will vary based on your framework/bundler. Some examples:

### SCSS

```css
@use '~@kyndryl-design-system/shidoka-foundation/scss/root.scss';
```

### CSS

```css
@import '@kyndryl-design-system/shidoka-foundation/css/root.css';
```

### JS

```js
import '@kyndryl-design-system/shidoka-foundation/css/root.css';
```

### Set a color scheme

More info on color schemes in the [Foundation Storybook](https://shidoka-foundation.netlify.app/?path=/docs/foundation-colors--docs#setting-a-theme).

## Start using components

See [Storybook](https://shidoka-charts.netlify.app) for the full components documentation.

### Example

```js
import '@kyndryl-design-system/shidoka-charts/components/chart';
```

```html
<kd-chart></kd-chart>
```

### React usage

React does not yet support automatic interop with Web Components. This means that React treats all props passed to Web Components as string attributes. It sounds like they are [planning to release it eventually](https://github.com/facebook/react/issues/11347#issuecomment-988970952), and is now available behind an `@experimental` flag. Until you've upgraded to a version of React that has support, you will need to use a library like [@lit/react](https://www.npmjs.com/package/@lit/react) to use these components in React.

Some options for React wrapper libraries:

1. [@lit/react](https://www.npmjs.com/package/@lit/react)
2. [reactify-wc](https://www.npmjs.com/package/reactify-wc)
3. [wc-react](https://www.npmjs.com/package/wc-react)

### Server-Side Rendering (SSR)

When using with an SSR framework like Next.js, you will encounter errors with code that only runs client-side, like `window` references for example. This is because web components cannot render on the server. Here is an article that provides some methods to work around this: [Using Non-SSR Friendly Components with Next.js](https://blog.bitsrc.io/using-non-ssr-friendly-components-with-next-js-916f38e8992c) and [How to entirely disable server-side rendering in next.js v13?](https://stackoverflow.com/questions/75406728/how-to-entirely-disable-server-side-rendering-in-next-js-v13). Basically, they need their rendering deferred to only happen on the client-side.

Here is some additional information about why SSR does not work for web components, and some potential polyfills/solutions to enable server rendering: https://lit.dev/docs/ssr/overview/

---
_Source: https://npm.io/package/@kyndryl-design-system/shidoka-charts · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
