# react-accessible-details

> React Accessible Details

Latest version **3.0.5** (published 2019-12-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-accessible-details
pnpm add react-accessible-details
yarn add react-accessible-details
bun add react-accessible-details
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.5 |
| Published | 2019-12-10 |
| First published | 2019-03-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 16 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Matthew Holloway |
| Maintainers | holloway |
| Keywords | details, summary, accessible, html5, typescript |

## Links

- npm: https://www.npmjs.com/package/react-accessible-details
- Homepage: https://github.com/springload/react-accessible-details
- npm.io page: https://npm.io/package/react-accessible-details

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 3.0.5 (latest) — 2019-12-10
- 3.0.4 — 2019-12-09
- 3.0.3 — 2019-12-09
- 3.0.2 — 2019-12-09
- 3.0.1 — 2019-12-09
- 3.0.0 — 2019-12-09
- 2.0.1 — 2019-06-04
- 2.0.0 — 2019-05-17
- 1.0.0 — 2019-03-26
- 0.0.4 — 2019-03-26
- 0.0.3 — 2019-03-25
- 0.0.2 — 2019-03-25
- 0.0.1 — 2019-03-25

## README

# React Accessible `<Details>` / `<Summary>`

The little runt brother of [React Accessible Accordion](https://www.npmjs.com/package/react-accessible-accordion) which is probably what you want instead of this.

But if you do want HTML5 [`<details>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/details) and [`<summary>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/summary) tags in React with managed state and a few accessibility improvements then this is it.

## Install

```
yarn add react-accessible-details
```

or

```
npm i react-accessible-details
```

## Stale?

Often projects on NPM are considered stale if they're not under active development, but that's a problem for software that does one thing and that may not need further development (unless Issues are raised). So this project is deemed **stable and complete** unless Github Issues are raised, so please don't be scared off by the fact that this project isn't under active development.

## Usage

```jsx
import { Details, Summary } from "react-accessible-details";

export default () => (
  <Details>
    <Summary>FAQ: Why Is New Zealand Missing From Maps?</Summary>
    Shush, don't tell anyone.
  </Details>
);
```

- `Details` takes optional props of `isOpen` (boolean to force open/closed), `isOpenDefault` (boolean to set initial value), and `className` (string).
- `Summary` takes an optional prop of `className` (string).

## Features

Accessibility fixes like `role="button"` on the `<summary>`, setting an appropriate `tabindex`, and using `aria-expanded` to help screen readers know whether it's open or not.

As it's a React component it integrates better with a React state manager, and it implements `<details><summary>` in browsers that don't support it, like IE11.

It works without JavaScript (ie, server-side rendered React when browsers have JavaScript disabled) providing that [browsers natively support `<details>` and `<summary>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/details#Browser_compatibility).

It's 2KB.

## Requirements

No dependencies except peer dependencies on React 16.8 or later as it uses useState and the new context API.

## Styling

This component doesn't include any styling, and although it will work in IE11 you may need to provide some default styles for that browser such as `display:block` on the `<summary>` tag.

Because both components support `className` props they're compatible with [Styled Components](https://www.styled-components.com/).

## Credit

Matthew Holloway at https://springload.co.nz/

---
_Source: https://npm.io/package/react-accessible-details · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
