Skip to content

Commit 933a85c

Browse files
authored
Merge pull request #375 from springload/chore/deprecation-notice
Add deprecation notice
2 parents 041929b + 8089735 commit 933a85c

File tree

3 files changed

+14
-2
lines changed

3 files changed

+14
-2
lines changed

README.md

+11
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,17 @@
33
[![Accessibility status](https://img.shields.io/badge/a11y-tested-brightgreen.svg)](http://wave.webaim.org/report#/https://springload.github.io/react-accessible-accordion/)
44
=========
55

6+
## ⚠️ Project status
7+
8+
In most cases, you no longer need a JS library like this to render fully functional, accessible accordions. For that reason, **this project is no longer maintained**.
9+
10+
This is because native [HTML Disclosure](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/summary) (aka `<details>`/`<summary`>) elements are now [widely supported](https://caniuse.com/details).
11+
12+
Native disclosures offer several advantages over any JS-based solutions. For instance:
13+
- Because there is no JS to download/parse, they are far more performant.
14+
- They are framework-agnostic, and will work the same way whether you're using React, [other framework], or plain old HTML.
15+
- Collapsed content can still be found via find-on-page (<key>ctrl</key>/<key>command</key>+<key>f</key>) in supporting browsers, including Chrome.
16+
617
## Demo
718

819
[Try a demo now](https://springload.github.io/react-accessible-accordion/).

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "react-accessible-accordion",
3-
"version": "5.0.0",
3+
"version": "5.0.1",
44
"description": "Accessible Accordion component for React",
55
"main": "dist/umd/index.js",
66
"module": "dist/es/index.js",

tsconfig.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
"jsx": "react",
1414
"baseUrl": "./",
1515
"lib": ["dom", "es2015"],
16-
"strict": true
16+
"strict": true,
17+
"skipLibCheck": true
1718
}
1819
}

0 commit comments

Comments
 (0)