npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

react-accessible-details

v3.0.5

Published

React Accessible Details

Downloads

106

Readme

React Accessible <Details> / <Summary>

The little runt brother of React Accessible Accordion which is probably what you want instead of this.

But if you do want HTML5 <details> and <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

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>.

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.

Credit

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