README.md

quoin

Socket Badge

An unstyled, accessible UI component library for SolidJS — a faithful port of Base UI, built on Solid 2.0's fine-grained reactivity.

You bring the styles and the markup; quoin brings the behavior, accessibility, and positioning. Every component is a set of composable parts you assemble yourself, so you keep full control over the DOM.

[!WARNING] quoin is pre-release software (0.4.x). The API is still settling and breaking changes should be expected. It targets the solid-js@2.0.0-rc line and currently carries one development-build context patch (see patches/).

Installation

bash
1pnpm install quoin-ui
2# or
3bun add quoin-ui

quoin targets Solid 2.0 and expects the following peers:

bash
1bun install solid-js@2.0.0-rc.1 @solidjs/web@2.0.0-rc.1 @solidjs/signals@2.0.0-rc.1

Required patch (Solid RC)

quoin relies on one small fix to the Solid 2.0 RC: the createContext provider must read its value outside the provider root's tracking scope. Until that lands upstream, bun consumers should apply the included patch to avoid strict-read diagnostics and accidental provider-root subscriptions.

The patch files ship inside the package. Copy them into your project and register them in your package.json:

bash
1mkdir -p patches
2cp node_modules/quoin/patches/* patches/
jsonc
1// package.json
2{
3 "patchedDependencies": {
4 "solid-js@2.0.0-rc.1": "patches/solid-js@2.0.0-rc.1.patch"
5 }
6}
bash
1bun install # applies the patches

The Portal and async rejection patches required by beta.14 are incorporated upstream in beta.28 and are no longer carried by quoin.

Two ways to build

quoin exposes every component at two layers. Reach for whichever fits the job — they share the same underlying state machine, so you can mix them.

Compound components

The Base UI / React-style API: a namespace of composable parts you nest to build the markup. Batteries included — portal, focus trap, scroll lock, positioning, and transitions are wired up for you. This is what you want most of the time.

tsx
1import { createSignal } from "solid-js";
2import { Dialog } from "quoin-ui/dialog";
3
4function Example() {
5 const [open, setOpen] = createSignal(false);
6
7 return (
8 <Dialog.Root open={open()} onOpenChange={setOpen}>
9 <Dialog.Trigger>View notifications</Dialog.Trigger>
10 <Dialog.Portal>
11 <Dialog.Backdrop />
12 <Dialog.Popup>
13 <Dialog.Title>Notifications</Dialog.Title>
14 <Dialog.Description>
15 You are all caught up. Good job!
16 </Dialog.Description>
17 <Dialog.Close>Close</Dialog.Close>
18 </Dialog.Popup>
19 </Dialog.Portal>
20 </Dialog.Root>
21 );
22}

Every component family is also a subpath export (quoin/dialog, quoin/select, …) so you only ship what you import. Components are unstyled — bring your own CSS, CSS modules, or Tailwind. Every part forwards class, style, and the standard data attributes (data-open, data-disabled, …) for styling state.

Headless primitives

The createX API: a Solid-idiomatic primitive that owns the state, modality, and dismissal logic but renders nothing. You provide the markup and read the state from any descendant with useX(). The compound <Dialog.Root> is itself a thin wrapper over createDialog — drop to this layer when you need full control of the rendered tree.

tsx
1import { createSignal, Show } from "solid-js";
2import { createDialog, useDialog } from "quoin-ui/dialog";
3
4function Example() {
5 const [open, setOpen] = createSignal(false);
6 // Controlled — `setOpen`/`toggle` emit through `onOpenChange`; you own the signal.
7 const dialog = createDialog({ open, onOpenChange: setOpen });
8
9 return (
10 <dialog.Provider>
11 <button onClick={() => dialog.toggle()}>View notifications</button>
12 <Show when={dialog.open()}>
13 <div role="dialog" aria-modal={dialog.modal() === true}>
14 <h2>Notifications</h2>
15 <p>You are all caught up. Good job!</p>
16 <CloseButton />
17 </div>
18 </Show>
19 </dialog.Provider>
20 );
21}
22
23function CloseButton() {
24 const dialog = useDialog(); // reads the nearest <dialog.Provider>
25 return <button onClick={() => dialog.setOpen(false)}>Close</button>;
26}

Note: the primitive manages state and behavior only — DOM machinery like the portal, focus trap, and scroll lock lives in the compound parts. With createDialog alone you render (and wire up) the surface yourself.

For state that lives outside your JSX — opened from an event handler or another component — the Dialog namespace also exposes an imperative Dialog.createHandle() you connect via <Dialog.Root handle={…}> and drive with handle.open(triggerId) / handle.close() / handle.openWithPayload({ … }).

Components

OverlaysDialogAlert DialogPopover
TooltipPreview CardDrawer
MenusMenuSubmenuContext Menu
MenubarNavigation MenuToolbar
SelectionSelectComboboxAutocomplete
FormFieldFieldsetForm
InputNumber FieldOTP Field
ControlsButtonCheckboxCheckbox Group
RadioRadio GroupSwitch
ToggleToggle GroupSlider
DisclosureAccordionCollapsibleTabs
DisplayAvatarProgressMeter
Scroll AreaSeparator
ProvidersDirection ProviderCSP Provider

How it works

Quoin heavily references Base UI's component model in idiomatic Solid:

  • Composable parts. Each component is a namespace of parts (Dialog.Root, Dialog.Trigger, Dialog.Popup, …) that you nest to build the markup you want.
  • Controlled by default. Root components take controlled props (open/onOpenChange, value/onValueChange) — pass a signal and wire the callback.
  • Floating UI positioning. Popovers, menus, selects, and tooltips position with @floating-ui/dom.
  • SSR & hydration ready. Ships a dual build — a DOM-compiled bundle (import/default) plus a JSX-preserved bundle (the solid condition) so Solid-aware bundlers can recompile for your target.

Project status

This is an experimental Solid 2.0 port and is not affiliated with the Base UI team. It tracks Base UI's behavior and test suite where practical, with adjustments for Solid's reactivity model.

Acknowledgements

Built on the work of the Base UI team (from the creators of Radix, Floating UI, and Material UI) and the SolidJS project.

Required Solid patch

[!IMPORTANT] quoin carries one fix against solid-js@2.0.0-rc.1. Package-manager patch settings do not transfer from a published dependency, so consumers that run Solid's development build should apply the included patch themselves.

The patch wraps the context value write in untrack, preventing the provider root from subscribing to signals read through props.value. The RC already contains the former Portal and async rejection fixes.

Applying them

quoin ships the patch files in patches/. Copy them into your project and register them with your package manager.

bun — copy patches/ to your project root and add to package.json:

jsonc
1{
2 "patchedDependencies": {
3 "solid-js@2.0.0-rc.1": "patches/solid-js@2.0.0-rc.1.patch"
4 }
5}

pnpm — same, under the pnpm.patchedDependencies key. npm / yarn — these have no native equivalent; use patch-package with the same diffs.

After installing, verify that solid-js/dist/dev.js contains untrack(() => setContext(provider, props.value)).

[!NOTE] This patch is pinned to 2.0.0-rc.1. Re-confirm and re-derive or remove it on every Solid bump. Full rationale lives in solid/patches.md.