Package Exports
- @archway/valet
Readme
valet
valet is a CSS-in-JS engine, a UI component kit, and an accessibility layer that treats all humans and their AI proxies as first class users.
Please expect many breaking changes but feel free to check it out!
When 1.0.X drops hop in and depend on that thing!
valet is pronounced like the British attendant but pronouncing it like the car attendant is also very cool and encouraged.
Unless you don't like valet in which case its pronounced like the British attendant and go make valet2 and tell us about it.
To use valet in your project run:
cd your-project-using-valet
npm install @archway/valetTo run a local dev server, run:
npm install
npm link
npm run dev(second terminal emulator)
cd YourReactLibraryThatUses_valet
npm link @archway/valetComponents
These have been mostly tested in the Valet Playground.
| Component | Playground QC | Comments |
|---|---|---|
| Accordion | ✅ | ---------- |
| Box | ✅ | ---------- |
| Button | ✅ | ---------- |
| Checkbox | ❌ | styling |
| Drawer | ❌ | WIP |
| FormControl | ✅ | ---------- |
| Icon | ✅ | ---------- |
| IconButton | ✅ | ---------- |
| List | ✅ | ---------- |
| Modal | ❌ | styling |
| Panel | ✅ | ---------- |
| Parallax | ✅ | ---------- |
| Progress | ❌ | styling |
| Radio Group | ❌ | styling |
| Select | ❌ | styling |
| Slider | ✅ | ---------- |
| Stack | ✅ | ---------- |
| Surface | ✅ | ---------- |
| Switch | ✅ | ---------- |
| Table | ✅ | ---------- |
| Tabs | ✅ | ---------- |
| Textfield | ✅ | ---------- |
| Tooltip | ✅ | ---------- |
| Typography | ✅ | ---------- |
Hooks
| Hook | Playground QC | Comments |
|---|---|---|
| useGoogleFonts | ✅ | ---------- |
| useTheme | ✅ | ---------- |
Utilities
| Utility | Playground QC | Comments |
|---|---|---|
| createFormStore | ✅ | ---------- |
| definePreset | ✅ | ---------- |
Roadmap
- Everything related to being an AI "bridge"
- As close to AAA accessibility support as possible
- No compromises on getting to AA
Intended Components
- List
- App Bar
- Breadcrumbs
- Drawer
- Pagination
- Stepper
- Speed Dial
- Grid
Contributuing
Add a pull request if you wish to help!