Skip to content

Latest commit

 

History

History
152 lines (118 loc) · 9.93 KB

README.md

File metadata and controls

152 lines (118 loc) · 9.93 KB

Reakit symbol

Reakit

Toolkit for building accessible rich web apps with React.
Explore website »


NPM version NPM downloads Build Status
Sponsors Backers Follow Reakit on Twitter

Sponsors

By donating $100 or more you become a sponsor and help in the development of this project. Thank you to all our sponsors! 🙏

Backers

By donating $5 or more you become a backer and help in the development of this project. Thank you to all our backers! 🙏

Installation

npm:

npm i reakit

Yarn:

yarn add reakit

Thanks to @nosebit for the package name on npm.

Usage

import React from "react";
import ReactDOM from "react-dom";
import { useDialogState, Dialog, DialogDisclosure } from "reakit";

function App() {
  const dialog = useDialogState();
  return (
    <div>
      <DialogDisclosure {...dialog}>Open dialog</DialogDisclosure>
      <Dialog {...dialog} aria-label="Welcome">
        Welcome to Reakit!
      </Dialog>
    </div>
  );
}

ReactDOM.render(<App />, document.getElementById("root"));

Play with this on CodeSandbox and read the documentation to learn more.

Contributors

This project exists thanks to all the people who contribute. Learn more on the contributing guide.

reakit Logo by Leonardo Elias.

Attribution

Browser testing provided by

License

MIT © Diego Haz