# Accessibility (`chartist-plugin-accessibility`, Chartist plugin)

> Adds a visually hidden table with the data, a caption and a summary, so screen reader users get the numbers.

- Author: Gion Kunz
- Source: https://github.com/gionkunz/chartist-plugin-accessibility, npm: https://www.npmjs.com/package/chartist-plugin-accessibility
- License: WTFPL
- Written for the Chartist 0.x API; runs on v2 with `chartist/compat` (a script that reads the global `Chartist`, for backwards compatibility)
- Charts: line, bar, pie
- Server rendering: no, it needs a browser
- Downloads: 1988 a month, last release 2018-02-11

Setup:

```html
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/chartist@2.0.0-rc.2/dist/index.min.css">
<script type="module">
  import 'https://cdn.jsdelivr.net/npm/chartist@2.0.0-rc.2/dist/compat.min.js';
</script>
<script defer src="https://cdn.jsdelivr.net/npm/chartist-plugin-accessibility@0.0.5/dist/chartist-plugin-accessibility.js"></script>
<script type="module">
  import { lineChart } from 'https://cdn.jsdelivr.net/npm/chartist@2.0.0-rc.2/dist/index.min.js';
  import { fromLegacyPlugin } from 'https://cdn.jsdelivr.net/npm/chartist@2.0.0-rc.2/dist/compat.min.js';

  lineChart('#chart', data, {
    plugins: [fromLegacyPlugin(Chartist.plugins.ctAccessibility())]
  });
</script>
```

Example (`src/main.ts`):

```ts
import 'chartist/styles.css';
import './style.css';
import { lineChart } from 'chartist';
import { fromLegacyPlugin } from 'chartist/compat';

// Plugin scripts register on the global `Chartist`.
const { plugins } = Chartist;

lineChart(
  '#chart',
  {
    labels: ['Q1', 'Q2', 'Q3', 'Q4'],
    series: [
      { name: 'Income', data: [5000, 6500, 4800, 7200] },
      { name: 'Expenses', data: [4200, 4700, 5100, 5000] }
    ]
  },
  {
    // A fixed height, so the table the plugin adds flows below the chart.
    height: 200,
    plugins: [
      fromLegacyPlugin(
        plugins.ctAccessibility({
          caption: 'Fiscal year 2026',
          seriesHeader: 'Business numbers',
          summary: 'Income and expenses per quarter of the fiscal year 2026',
          valueTransform: (value: number) => `${value} dollars`,
          // Shown here so you can see the table; leave this out to keep it
          // visually hidden.
          visuallyHiddenStyles: 'display: block; margin-top: 12px;'
        })
      )
    ]
  }
);
```

All plugins: https://chartist.dev/plugins.md