Module react-entry

Public React API for MAIDR.

Provides the <Maidr> component for adding accessible, non-visual access to statistical visualizations in React applications. Supports audio sonification, text descriptions, braille output, and keyboard navigation.

Remarks

Requires React 18 or 19 as a peer dependency.

Example

import { Maidr, type MaidrData } from 'maidr/react';

const data: MaidrData = {
  id: 'my-chart',
  title: 'Sales by Quarter',
  subplots: [[{
    layers: [{
      id: '0',
      type: 'bar',
      axes: { x: 'Quarter', y: 'Revenue' },
      data: [
        { x: 'Q1', y: 120 },
        { x: 'Q2', y: 200 },
      ],
    }],
  }]],
};

function MyChart() {
  return (
    <Maidr data={data}>
      <svg>{...}</svg>
    </Maidr>
  );
}

References

Maidr → Maidr
MaidrProps → MaidrProps
MaidrData → Maidr
MaidrLayer → MaidrLayer
MaidrSubplot → MaidrSubplot
Orientation → Orientation
TraceType → TraceType

Module react-entry

Remarks

Example

References

Settings

On This Page