reach /reach-ui

The Accessible Foundation for React Apps and Design Systems

★ 5,962⑂ 556👁 51⑃ 415● 540▤ 53
TypeScriptMITCreated 2018-07-31reacttraining.com/reach-ui/
下载:v0.18.0v0.18.0 ↓0.18.02022-10-13
+0
日增长
5,962
stars
556
forks
51
watchers
415
prs
540
issues
53
releases

README

Reach-UI is currently not maintained! See this issue

 Welcome to Reach UI Development ♿️

Thanks for getting involved with Reach UI development!

 Looking for the documentation?

https://reach.tech/

 Getting Started

Reach UI is built and tested with Yarn. Please follow their install instructions to get Yarn installed on your system.

Then, run these commands:


git clone [email protected]:reach/reach-ui.git
cd reach-ui
pnpm install
pnpm build


 Root Repo Scripts:

sh
pnpm build         builds all packages
pnpm dev         starts storybook server
pnpm test          runs tests in all packages


 Running / Writing Examples

First do the steps in "Getting started", then start the Storybook server:


pnpm dev


Next, put a file in packages//examples/.example.js and make it look like this:

jsx
import  as React from "react";

// The name of the example (always name the variable name)
let name = "Basic";

// The example to render (always name the function Example)
function Example() {
	return Cool cool cool;
}

// Assign the name to the example and then export it as a named constant
Example.storyName = name;
export const Basic = Example;

// Default export an object with the title matching the name of the Reach package
export default { title: "Dialog" };


Now you can edit the files in packages/ and storybook will automatically reload your changes.

Note: If you change an internal dependency you will need to run yarn build again. For example, if working on MenuButton requires a change to Rect (an internal dependency of MenuButton), you will need to run yarn build for the changes to Rect to show up in your MenuButton example.

 Running / Writing Tests

First do the steps in "Getting Started", then:


pnpm test


Or if you want to run the tests as you edit files:


pnpm test --watch


Often you'll want to just test the component you're working on:


cd packages/
pnpm test --watch


 Development Plans

The components to be built come from the the Aria Practices Design Patterns and Widgets, with a few exceptions. Here is a table of the components and their status.

✅ - Released
🛠 - Building

| Status | Name           |
| ------ | -------------- |
| ✅     | Accordion      |
| ✅     | Alert          |
| ✅     | Alert Dialog   |
| ✅     | Checkbox       |
| ✅     | Combo Box      |
| ✅     | Dialog (Modal) |
| ✅     | Disclosure     |
| 🛠      | Hover Card     |
| ✅     | Listbox        |
| ✅     | Menu Button    |
| 🛠      | Radio Group    |
| ✅     | Slider         |
| ✅     | Tabs           |
| 🛠      | Toggletip      |
| ✅     | Tooltip        |

 Releases [DEPRECATED]

This is (was?) our current release process. It's not perfect, but it has almost the right balance of manual + automation for me. We might be able to put some of this in a script...

sh
$ git checkout main
$ git pull origin main
$ git checkout dev
$ git pull origin dev
$ git checkout -b release-
$ git merge main

 Resolve any merge conflicts and commit if necessary

 Run the build locally a

Top issues

Discussions

Latest release

v0.18.0 v0.18.0 Pre-release 2022-10-13
Changes for individual packages can now be found in the CHANGELOG.md file in the root of the affected package. GitHub releases will be used to document changes affecting all or several packages in the repo.

 BREAKING Changes

- All default exports have been removed. Replace all default imports with the appropriate documented named export.
- The output directory structure has changed slightly. Module files are now named reach-.mjs instead of reach-.esm.js.

 Minor Changes

- We have simplified our build setup to remove a boatload of dependencies. Build output for all packages may look

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON