-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
f27fbe0
commit 888a039
Showing
1 changed file
with
45 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,50 @@ | ||
# headlessui-svelte | ||
|
||
This is an alpha port of [HeadlessUI](https://headlessui.com/) targeting Svelte 5 (or later). | ||
|
||
A primary design goal is to stay as reasonably faithful to the HeadlessUI-React API as possible, in order to integrate better with [TailwindUI](https://tailwindui.com/). A secondary design goal is to align folder naming and tests, in order to reduce cognitive burden when porting and making updates. | ||
|
||
This can manifest in strange, but intentional, ways: | ||
- the existence of a `hooks` folder (not [SvelteKit hooks](https://svelte.dev/docs/kit/hooks)) | ||
- using test functions from the main headlessui repo, instead of the equivalent `testing-library` functionality | ||
- the existence of a `Fragment` component | ||
- ... | ||
|
||
## Progress | ||
|
||
### Forms | ||
|
||
- [ ] Button | ||
- [ ] Checkbox | ||
- [ ] Combobox | ||
- [ ] Description | ||
- [ ] Field | ||
- [ ] Fieldset | ||
- [ ] Input | ||
- [ ] Label | ||
- [ ] Listbox | ||
- [ ] Radio Group | ||
- [ ] Select | ||
- [ ] Switch | ||
- [ ] Textarea | ||
|
||
### Components | ||
|
||
- [ ] Dropdown Menu | ||
- [ ] Disclosure | ||
- [ ] Dialog | ||
- [ ] Popover | ||
- [ ] Portal | ||
- [ ] Tabs | ||
- [ ] Transition | ||
|
||
## Community | ||
|
||
Other Svelte-based HeadlessUI implementations: | ||
|
||
- CaptainCodeman: https://github.com/CaptainCodeman/svelte-headlessui | ||
- rgossiaux: https://github.com/rgossiaux/svelte-headlessui | ||
|
||
## License | ||
|
||
This library is licensed under the MIT license; see the LICENSE file for more. |