Skip to content

Latest commit

 

History

History
62 lines (44 loc) · 1.84 KB

README.md

File metadata and controls

62 lines (44 loc) · 1.84 KB
Raw

headlessui-svelte

This is an alpha port of HeadlessUI 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. 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)
  • using test functions from the main headlessui repo, instead of the equivalent testing-library functionality
  • the existence of a Fragment component
  • ...

Installation

npm install @robotpajamas/headlessui-svelte

Documentation

Full documenation and examples will eventually live at headlessui-svelte.com

Progress

The target compatibility for the components below is based on HeadlessUI React 2.2.0 (d71fb9c). A component is considered completed when most of the mapped-over tests pass, and the component functions similarly to headlessui.com.

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:

License

This library is licensed under the MIT license; see the LICENSE file for more.