1 | <br>
|
2 |
|
3 | <p align="center">
|
4 | <a href="https://github.com/reakit/reakit/tree/master/logo">
|
5 | <img src="https://user-images.githubusercontent.com/3068563/55114952-118f6b00-50c2-11e9-8879-d047e5686284.png" alt="Reakit symbol" width="80" />
|
6 | </a>
|
7 | </p>
|
8 |
|
9 | <h1 align="center">Reakit</h1>
|
10 |
|
11 | <p align="center">
|
12 | Toolkit for building <a href="https://reakit.io/docs/accessibility">accessible</a> rich web apps with <a href="https://reactjs.org">React</a>.
|
13 | <br>
|
14 | <a href="https://reakit.io"><strong>Explore website »</strong></a>
|
15 | </p>
|
16 |
|
17 | <br>
|
18 |
|
19 | <p align="center">
|
20 | <a href="https://npmjs.org/package/reakit"><img alt="NPM version" src="https://img.shields.io/npm/v/reakit.svg" /></a>
|
21 | <a href="https://npmjs.org/package/reakit"><img alt="NPM downloads" src="https://img.shields.io/npm/dm/reakit.svg"></a>
|
22 | <a href="https://github.com/reakit/reakit/actions"><img alt="Build Status" src="https://github.com/reakit/reakit/workflows/ci/badge.svg?event=push&branch=master" /></a>
|
23 | <a href="https://codecov.io/gh/reakit/reakit"><img src="https://codecov.io/gh/reakit/reakit/branch/master/graph/badge.svg" /></a><br>
|
24 | <a href="https://opencollective.com/ariakit"><img alt="Sponsors" src="https://opencollective.com/ariakit/sponsor/badge.svg?label=sponsors" /></a>
|
25 | <a href="https://opencollective.com/ariakit"><img alt="Backers" src="https://opencollective.com/ariakit/backer/badge.svg?label=backers" /></a>
|
26 | <a href="https://twitter.com/reakitjs">
|
27 | <img alt="Follow Reakit on Twitter" src="https://img.shields.io/twitter/follow/reakitjs.svg"></a>
|
28 | </p>
|
29 |
|
30 |
|
31 | ## Sponsors
|
32 |
|
33 | By donating $100 or more you [become a sponsor](https://opencollective.com/ariakit) and help in the development of this project. Thank you to all our sponsors! 🙏
|
34 |
|
35 | <p>
|
36 | <a href="https://opencollective.com/ariakit/sponsor/0/website"><img src="https://opencollective.com/ariakit/sponsor/0/avatar.svg"></a>
|
37 | <a href="https://opencollective.com/ariakit/sponsor/1/website"><img src="https://opencollective.com/ariakit/sponsor/1/avatar.svg"></a>
|
38 | <a href="https://opencollective.com/ariakit/sponsor/2/website"><img src="https://opencollective.com/ariakit/sponsor/2/avatar.svg"></a>
|
39 | <a href="https://opencollective.com/ariakit/sponsor/3/website"><img src="https://opencollective.com/ariakit/sponsor/3/avatar.svg"></a>
|
40 | <a href="https://opencollective.com/ariakit/sponsor/4/website"><img src="https://opencollective.com/ariakit/sponsor/4/avatar.svg"></a>
|
41 | <a href="https://opencollective.com/ariakit/sponsor/5/website"><img src="https://opencollective.com/ariakit/sponsor/5/avatar.svg"></a>
|
42 | <a href="https://opencollective.com/ariakit/sponsor/6/website"><img src="https://opencollective.com/ariakit/sponsor/6/avatar.svg"></a>
|
43 | <a href="https://opencollective.com/ariakit/sponsor/7/website"><img src="https://opencollective.com/ariakit/sponsor/7/avatar.svg"></a>
|
44 | <a href="https://opencollective.com/ariakit/sponsor/8/website"><img src="https://opencollective.com/ariakit/sponsor/8/avatar.svg"></a>
|
45 | <a href="https://opencollective.com/ariakit/sponsor/9/website"><img src="https://opencollective.com/ariakit/sponsor/9/avatar.svg"></a>
|
46 | </p>
|
47 |
|
48 | ## Backers
|
49 |
|
50 | By donating $5 or more you [become a backer](https://opencollective.com/ariakit) and help in the development of this project. Thank you to all our backers! 🙏
|
51 |
|
52 | <p>
|
53 | <a href="https://opencollective.com/ariakit/backer/0/website"><img src="https://opencollective.com/ariakit/backer/0/avatar.svg"></a>
|
54 | <a href="https://opencollective.com/ariakit/backer/1/website"><img src="https://opencollective.com/ariakit/backer/1/avatar.svg"></a>
|
55 | <a href="https://opencollective.com/ariakit/backer/2/website"><img src="https://opencollective.com/ariakit/backer/2/avatar.svg"></a>
|
56 | <a href="https://opencollective.com/ariakit/backer/3/website"><img src="https://opencollective.com/ariakit/backer/3/avatar.svg"></a>
|
57 | <a href="https://opencollective.com/ariakit/backer/4/website"><img src="https://opencollective.com/ariakit/backer/4/avatar.svg"></a>
|
58 | <a href="https://opencollective.com/ariakit/backer/5/website"><img src="https://opencollective.com/ariakit/backer/5/avatar.svg"></a>
|
59 | <a href="https://opencollective.com/ariakit/backer/6/website"><img src="https://opencollective.com/ariakit/backer/6/avatar.svg"></a>
|
60 | <a href="https://opencollective.com/ariakit/backer/7/website"><img src="https://opencollective.com/ariakit/backer/7/avatar.svg"></a>
|
61 | <a href="https://opencollective.com/ariakit/backer/8/website"><img src="https://opencollective.com/ariakit/backer/8/avatar.svg"></a>
|
62 | <a href="https://opencollective.com/ariakit/backer/9/website"><img src="https://opencollective.com/ariakit/backer/9/avatar.svg"></a>
|
63 | <a href="https://opencollective.com/ariakit/backer/10/website"><img src="https://opencollective.com/ariakit/backer/10/avatar.svg"></a>
|
64 | <a href="https://opencollective.com/ariakit/backer/11/website"><img src="https://opencollective.com/ariakit/backer/11/avatar.svg"></a>
|
65 | <a href="https://opencollective.com/ariakit/backer/12/website"><img src="https://opencollective.com/ariakit/backer/12/avatar.svg"></a>
|
66 | <a href="https://opencollective.com/ariakit/backer/13/website"><img src="https://opencollective.com/ariakit/backer/13/avatar.svg"></a>
|
67 | <a href="https://opencollective.com/ariakit/backer/14/website"><img src="https://opencollective.com/ariakit/backer/14/avatar.svg"></a>
|
68 | <a href="https://opencollective.com/ariakit/backer/15/website"><img src="https://opencollective.com/ariakit/backer/15/avatar.svg"></a>
|
69 | <a href="https://opencollective.com/ariakit/backer/16/website"><img src="https://opencollective.com/ariakit/backer/16/avatar.svg"></a>
|
70 | <a href="https://opencollective.com/ariakit/backer/17/website"><img src="https://opencollective.com/ariakit/backer/17/avatar.svg"></a>
|
71 | <a href="https://opencollective.com/ariakit/backer/18/website"><img src="https://opencollective.com/ariakit/backer/18/avatar.svg"></a>
|
72 | <a href="https://opencollective.com/ariakit/backer/19/website"><img src="https://opencollective.com/ariakit/backer/19/avatar.svg"></a>
|
73 | <a href="https://opencollective.com/ariakit/backer/20/website"><img src="https://opencollective.com/ariakit/backer/20/avatar.svg"></a>
|
74 | <a href="https://opencollective.com/ariakit/backer/21/website"><img src="https://opencollective.com/ariakit/backer/21/avatar.svg"></a>
|
75 | <a href="https://opencollective.com/ariakit/backer/22/website"><img src="https://opencollective.com/ariakit/backer/22/avatar.svg"></a>
|
76 | <a href="https://opencollective.com/ariakit/backer/23/website"><img src="https://opencollective.com/ariakit/backer/23/avatar.svg"></a>
|
77 | <a href="https://opencollective.com/ariakit/backer/24/website"><img src="https://opencollective.com/ariakit/backer/24/avatar.svg"></a>
|
78 | <a href="https://opencollective.com/ariakit/backer/25/website"><img src="https://opencollective.com/ariakit/backer/25/avatar.svg"></a>
|
79 | <a href="https://opencollective.com/ariakit/backer/26/website"><img src="https://opencollective.com/ariakit/backer/26/avatar.svg"></a>
|
80 | <a href="https://opencollective.com/ariakit/backer/27/website"><img src="https://opencollective.com/ariakit/backer/27/avatar.svg"></a>
|
81 | <a href="https://opencollective.com/ariakit/backer/28/website"><img src="https://opencollective.com/ariakit/backer/28/avatar.svg"></a>
|
82 | <a href="https://opencollective.com/ariakit/backer/29/website"><img src="https://opencollective.com/ariakit/backer/29/avatar.svg"></a>
|
83 | <a href="https://opencollective.com/ariakit/backer/30/website"><img src="https://opencollective.com/ariakit/backer/30/avatar.svg"></a>
|
84 | <a href="https://opencollective.com/ariakit/backer/31/website"><img src="https://opencollective.com/ariakit/backer/31/avatar.svg"></a>
|
85 | <a href="https://opencollective.com/ariakit/backer/32/website"><img src="https://opencollective.com/ariakit/backer/32/avatar.svg"></a>
|
86 | <a href="https://opencollective.com/ariakit/backer/33/website"><img src="https://opencollective.com/ariakit/backer/33/avatar.svg"></a>
|
87 | <a href="https://opencollective.com/ariakit/backer/34/website"><img src="https://opencollective.com/ariakit/backer/34/avatar.svg"></a>
|
88 | <a href="https://opencollective.com/ariakit/backer/35/website"><img src="https://opencollective.com/ariakit/backer/35/avatar.svg"></a>
|
89 | <a href="https://opencollective.com/ariakit/backer/36/website"><img src="https://opencollective.com/ariakit/backer/36/avatar.svg"></a>
|
90 | <a href="https://opencollective.com/ariakit/backer/37/website"><img src="https://opencollective.com/ariakit/backer/37/avatar.svg"></a>
|
91 | <a href="https://opencollective.com/ariakit/backer/38/website"><img src="https://opencollective.com/ariakit/backer/38/avatar.svg"></a>
|
92 | </p>
|
93 |
|
94 |
|
95 | ## Installation
|
96 |
|
97 | npm:
|
98 | ```sh
|
99 | npm i reakit
|
100 | ```
|
101 |
|
102 | Yarn:
|
103 | ```sh
|
104 | yarn add reakit
|
105 | ```
|
106 |
|
107 | > Thanks to [@nosebit](https://github.com/nosebit) for the package name on npm.
|
108 |
|
109 |
|
110 | ## Usage
|
111 |
|
112 | ```jsx
|
113 | import React from "react";
|
114 | import ReactDOM from "react-dom";
|
115 | import { useDialogState, Dialog, DialogDisclosure } from "reakit";
|
116 |
|
117 | function App() {
|
118 | const dialog = useDialogState();
|
119 | return (
|
120 | <div>
|
121 | <DialogDisclosure {...dialog}>Open dialog</DialogDisclosure>
|
122 | <Dialog {...dialog} aria-label="Welcome">
|
123 | Welcome to Reakit!
|
124 | </Dialog>
|
125 | </div>
|
126 | );
|
127 | }
|
128 |
|
129 | ReactDOM.render(<App />, document.getElementById("root"));
|
130 | ```
|
131 |
|
132 | Play with this on [CodeSandbox](https://codesandbox.io/s/m4n32vjkoj) and read the [documentation](https://reakit.io/docs) to learn more.
|
133 |
|
134 |
|
135 | ## Contributors
|
136 |
|
137 | This project exists thanks to all the people who contribute. Learn more on the [contributing guide](https://github.com/reakit/reakit/blob/master/CONTRIBUTING.md).
|
138 |
|
139 | <a href="https://github.com/reakit/reakit/graphs/contributors"><img src="https://opencollective.com/ariakit/contributors.svg?width=1227&button=false" /></a>
|
140 |
|
141 | <img src="https://user-images.githubusercontent.com/3068563/55114952-118f6b00-50c2-11e9-8879-d047e5686284.png" alt="reakit" height="12" /> [Logo](https://github.com/reakit/reakit/tree/master/logo) by [**Leonardo Elias**](https://github.com/leonardoelias).
|
142 |
|
143 |
|
144 | ## Attribution
|
145 |
|
146 | Browser testing provided by
|
147 | <a href="https://www.browserstack.com" target="_blank"><img src="https://user-images.githubusercontent.com/15015324/45184727-368fbf80-b1fe-11e8-8827-08dbc80b0fb1.png" height="80" align="center"></a>
|
148 |
|
149 |
|
150 | ## License
|
151 |
|
152 | MIT © [Diego Haz](https://github.com/diegohaz)
|