Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lxsmnsyc/terracotta
Headless UI for SolidJS
https://github.com/lxsmnsyc/terracotta
a11y accessibility headless-ui solid-js tailwindcss
Last synced: 2 days ago
JSON representation
Headless UI for SolidJS
- Host: GitHub
- URL: https://github.com/lxsmnsyc/terracotta
- Owner: lxsmnsyc
- License: mit
- Created: 2021-08-19T12:46:08.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-14T13:53:50.000Z (3 months ago)
- Last Synced: 2024-12-05T04:05:18.253Z (9 days ago)
- Topics: a11y, accessibility, headless-ui, solid-js, tailwindcss
- Language: TypeScript
- Homepage:
- Size: 3.04 MB
- Stars: 671
- Watchers: 6
- Forks: 18
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-solid-js - Solid Headless - Headless UI for SolidJS (📦 Components & Libraries / Frameworks & Component Libraries)
README
# terracotta
> Headless UI library for SolidJS
## Install
```bash
npm i terracotta
```
```bash
yarn add terracotta
```
```bash
pnpm add terracotta
```
## Note
The project is still in development, as I aim to implement the [WAI-ARIA Design Patterns and Widgets](https://www.w3.org/TR/wai-aria-practices-1.1/).
Here's the current components:
- `Accordion` [](https://stackblitz.com/github/LXSMNSYC/terracotta/tree/main/examples/accordion)
- `Alert`
- `Alert Dialog`
- `Button`
- `Button (Toggle)`
- `Checkbox` [](https://stackblitz.com/github/LXSMNSYC/terracotta/tree/main/examples/checkbox)
- `Dialog (Modal)` [](https://stackblitz.com/github/LXSMNSYC/terracotta/tree/main/examples/dialog)
- `Dialog (Popover)` [](https://stackblitz.com/github/LXSMNSYC/terracotta/tree/main/examples/popover)
- `Disclosure (Show/Hide)` [](https://stackblitz.com/github/LXSMNSYC/terracotta/tree/main/examples/disclosure)
- `Feed` [](https://stackblitz.com/github/LXSMNSYC/terracotta/tree/main/examples/feed)
- `Listbox (Select)` [](https://stackblitz.com/github/LXSMNSYC/terracotta/tree/main/examples/select)
- `Listbox (Dropdown)` [](https://stackblitz.com/github/LXSMNSYC/terracotta/tree/main/examples/listbox)
- `Menu` [](https://stackblitz.com/github/LXSMNSYC/terracotta/tree/main/examples/menu)
- `Radio Group` [](https://stackblitz.com/github/LXSMNSYC/terracotta/tree/main/examples/radiogroup)
- `Toolbar` [](https://stackblitz.com/github/LXSMNSYC/terracotta/tree/main/examples/toolbar)
- `Transition` [](https://stackblitz.com/github/LXSMNSYC/terracotta/tree/main/examples/transitions)
- `Toaster`/`Toast` [](https://stackblitz.com/github/LXSMNSYC/terracotta/tree/main/examples/toaster)
- `ContextMenu (Dialog)` [](https://stackblitz.com/github/LXSMNSYC/terracotta/tree/main/examples/context-menu)
- `CommandBar (Dialog)` [](https://stackblitz.com/github/LXSMNSYC/terracotta/tree/main/examples/commandbar)
- `Tabs` [](https://stackblitz.com/github/LXSMNSYC/terracotta/tree/main/examples/tabs)
## FAQ
### Is this the official [HeadlessUI](https://headlessui.dev/) for SolidJS?
Uhh, no. I intended to port the original however this is not recognized as the official port for SolidJS. There's also some differences in development path since I intended to implement the WAI-ARIA widgets. The reason is that there seems to be no resolution from the original Headless UI if they're going to implement WAI-ARIA widgets in the first place.
### If this is a port, does it mean it is 100% compatible?
Kinda. Due to differences in principle between SolidJS and React, the implementation would be different and such, features that are originally found in the original HeadlessUI may be incompatible with the SolidJS version.
## License
MIT © [lxsmnsyc](https://github.com/lxsmnsyc)