structyl is an open-source, TypeScript-first React component library with 90+ accessible components. It combines WAI-ARIA compliant headless primitives with Tailwind CSS v4 styled wrappers, a runtime theming system, and a first-class DataTable — all in independently-versioned npm packages.

How does structyl differ from shadcn/ui?

structyl ships as actual npm packages (pnpm add @structyl/styled) rather than copy-paste code snippets. It adds a runtime theming system that switches themes without a page reload, a feature-complete DataTable, 24+ React hooks, and 90+ components — significantly more than shadcn/ui out of the box.

How does structyl compare to Radix UI?

structyl builds on the same headless-first philosophy as Radix UI but adds a complete Tailwind-styled layer, runtime theming with CSS variables, dark mode, a DataTable, and chart components. Radix is primitives-only; structyl is a full component library ready to use.

Is structyl compatible with Next.js App Router?

Yes. All structyl components that use React hooks are marked with 'use client'. The library is SSR-safe and fully compatible with Next.js 15 App Router and React Server Components.

Does structyl support dark mode?

Yes. structyl includes a ThemeProvider that supports system, light, and dark modes. Theme switches happen instantly using CSS custom properties — no page reload required and no flash of unstyled content.

How do I install structyl?

Install the main package with: pnpm add @structyl/styled (or npm install @structyl/styled). Then wrap your app in ThemeProvider from @structyl/themes and add Toaster from @structyl/styled to your root layout.

Is structyl free and open source?

Yes. structyl is MIT licensed and completely free. All packages are published to npm under the @structyl scope.

Does structyl support TypeScript?

Yes. structyl is built with TypeScript strict mode throughout. All components export their prop types and the library ships with full type definitions. There is no any usage in the public API.

What styling system does structyl use?

structyl uses Tailwind CSS v4 for styling, tailwind-variants for type-safe variant APIs, and tailwind-merge for class conflict resolution. All colors and design tokens are CSS custom properties that integrate with the runtime theming system.

Does structyl have a DataTable component?

Yes. structyl includes a first-class DataTable in the @structyl/data-table package, built on @tanstack/table-core. It supports sorting, multi-column filtering, pagination, row selection, column resizing, and row virtualization via @tanstack/react-virtual.

Toast API

View component

The full prop reference for the Toast component. A succinct message that is displayed temporarily.

Import

tsx

import { Toast } from '@structyl/styled';

Props

Provider

Toast context provider — wraps your app to enable toast functionality

Prop	Type	Default
children#	`React.ReactNode` The app content that can access toast context	—
label#	`string` Aria label for the toast region	'Notifications'
duration#	`number` Time in ms to auto-dismiss toasts; set to Infinity to disable	5000
swipeDirection#	`'up' \| 'down' \| 'left' \| 'right'` Direction users can swipe to dismiss toasts	'right'
swipeThreshold#	`number` Distance in px to consider a swipe a dismissal	50

Viewport

Container that holds and positions all toasts; automatically styled in the styled layer

Prop	Type	Default
asChild#	`boolean` Render as child element instead of creating wrapper	—
hotkey#	`string[]` Keyboard keys to focus the toast viewport	['F8']
label#	`string` Aria label for the toast list	'{hotkey} hotkey to focus toasts'
className#	`string` Additional CSS classes (styled layer provides sensible defaults)	—
...rest#	`React.ComponentPropsWithoutRef<'ol'>` All native ol HTML attributes (style, role, aria-*, etc.)	—

Root

Individual toast component — represents a single toast notification

Prop	Type	Default
type#	`'foreground' \| 'background'` Aria-live priority: foreground=assertive, background=polite	'foreground'
open#	`boolean` Controlled: whether the toast is visible	—
defaultOpen#	`boolean` Uncontrolled: initial visibility state	true
onOpenChange#	`(open: boolean) => void` Fired when toast visibility changes	—
duration#	`number` Overrides Provider duration for this toast; Infinity to keep open	—
forceMount#	`boolean` Always render in DOM (even when closed) for animation control	—
onEscapeKeyDown#	`(event: KeyboardEvent) => void` Fired when Escape key is pressed on focused toast	—
onPause#	`() => void` Fired when toast auto-dismiss timer pauses (hover/focus)	—
onResume#	`() => void` Fired when toast auto-dismiss timer resumes	—
onSwipeStart#	`(event: React.PointerEvent) => void` Fired when swipe gesture begins	—
onSwipeMove#	`(event: React.PointerEvent) => void` Fired continuously while swiping	—
onSwipeEnd#	`(event: React.PointerEvent) => void` Fired when swipe distance exceeds threshold and toast closes	—
onSwipeCancel#	`(event: React.PointerEvent) => void` Fired when swipe is released but below threshold	—
variant#	`'default' \| 'destructive' \| 'error' \| 'success' \| 'warning' \| 'info'` Visual style variant (styled layer only)	'default'
className#	`string` Additional CSS classes (merges with variant styles)	—
...rest#	`React.ComponentPropsWithoutRef<'li'>` All native li HTML attributes (role, data-*, etc.)	—

Title

Toast title text — renders inside Toast.Root

Prop	Type	Default
asChild#	`boolean` Render as child element instead of creating wrapper	—
className#	`string` Additional CSS classes (styled layer provides typography defaults)	—
children#	`React.ReactNode` Title text or content	—
...rest#	`React.ComponentPropsWithoutRef<'div'>` All native div HTML attributes	—

Description

Toast description text — renders inside Toast.Root

Prop	Type	Default
asChild#	`boolean` Render as child element instead of creating wrapper	—
className#	`string` Additional CSS classes (styled layer provides typography defaults)	—
children#	`React.ReactNode` Description text or content	—
...rest#	`React.ComponentPropsWithoutRef<'div'>` All native div HTML attributes	—

Action

Action button in the toast — automatically closes toast on click

Prop	Type	Default
altText#	`string` Required alt text for screen readers (hidden visually)	—
asChild#	`boolean` Render as child element instead of creating button	—
className#	`string` Additional CSS classes (styled layer provides button styles)	—
children#	`React.ReactNode` Button label or content	—
...rest#	`React.ComponentPropsWithoutRef<'button'>` All native button HTML attributes (onClick, disabled, etc.)	—

Close

Close/dismiss button in the toast — automatically closes toast on click

Prop	Type	Default
asChild#	`boolean` Render as child element instead of creating button	—
className#	`string` Additional CSS classes (styled layer provides default icon and styles)	—
children#	`React.ReactNode` Button content (styled layer provides X icon by default)	—
...rest#	`React.ComponentPropsWithoutRef<'button'>` All native button HTML attributes (onClick, disabled, etc.)	—

Portal

Portal helper — renders toast content into a specific DOM container

Prop	Type	Default
children#	`React.ReactNode` Content to portal	—
container#	`Element \| DocumentFragment \| null` Target DOM node; defaults to document.body	—

Toaster

Singleton component — renders all imperative toasts. Drop once in your app root (e.g. layout.tsx)

Prop	Type	Default
horizontal#	`'left' \| 'center' \| 'right'` Default horizontal alignment for all toasts	'right'
vertical#	`'top' \| 'bottom'` Default vertical alignment for all toasts	'bottom'
maxToasts#	`number` Maximum number of toasts visible at once per position group	5
className#	`string` Additional CSS classes forwarded to viewport wrappers	—
...rest#	`React.ComponentPropsWithoutRef<typeof Viewport>` Viewport props (hotkey, label, style, aria-*, etc.)	—

toast.show()

Imperative API — fire a toast with full control over all options

Prop	Type	Default
options.id#	`string` Reuse/update existing toast when same ID is fired again	—
options.title#	`string` Main toast text	—
options.description#	`string` Secondary toast text	—
options.variant#	`'default' \| 'success' \| 'error' \| 'warning' \| 'info' \| 'loading'` Visual style and icon	'default'
options.duration#	`number` Auto-dismiss in ms; pass Infinity to keep until manually dismissed	4000
options.horizontal#	`'left' \| 'center' \| 'right'` Horizontal position (overrides Toaster default)	—
options.vertical#	`'top' \| 'bottom'` Vertical position (overrides Toaster default)	—
options.action#	`{ label: string; onClick: () => void }` Custom action button; takes priority over retry if both provided	—
options.retry#	`() => void` Adds a Retry button (action takes priority for button label)	—
options.onDismiss#	`(id: string) => void` Callback fired when toast is dismissed (before animation)	—

toast.success()

Convenience method — fire a success toast

Prop	Type	Default
title#	`string` Main toast text	—
options#	`Omit<ToastOptions, 'title' \| 'variant'>` Same as toast.show() except title and variant are preset	—

toast.error()

Convenience method — fire an error toast

Prop	Type	Default
title#	`string` Main toast text	—
options#	`Omit<ToastOptions, 'title' \| 'variant'>` Same as toast.show() except title and variant are preset	—

toast.warning()

Convenience method — fire a warning toast

Prop	Type	Default
title#	`string` Main toast text	—
options#	`Omit<ToastOptions, 'title' \| 'variant'>` Same as toast.show() except title and variant are preset	—

toast.info()

Convenience method — fire an info toast

Prop	Type	Default
title#	`string` Main toast text	—
options#	`Omit<ToastOptions, 'title' \| 'variant'>` Same as toast.show() except title and variant are preset	—

toast.loading()

Convenience method — fire a loading toast (spinner icon, duration defaults to Infinity)

Prop	Type	Default
title#	`string` Main toast text	—
options#	`Omit<ToastOptions, 'title' \| 'variant'>` Same as toast.show() except title and variant are preset; duration defaults to Infinity	—

toast.promise()

Async helper — show loading toast, then update to success or error when promise settles

Prop	Type	Default
promise#	`Promise<T>` The promise to track	—
messages.loading#	`string` Text while promise is pending	—
messages.success#	`string \| ((data: T) => string)` Text when promise resolves; can be a function to format the resolved value	—
messages.error#	`string \| ((err: unknown) => string)` Text when promise rejects; can be a function to format the error	—
options#	`Omit<ToastOptions, 'title' \| 'variant'>` Same as toast.show() except title and variant are managed by promise state	—

toast.dismiss()

Close a toast with exit animation; omit id to dismiss all

Prop	Type	Default
id#	`string` Toast ID to close; omit to dismiss all open toasts	—

toast.remove()

Instantly remove a toast from the store without animation

Prop	Type	Default
id#	`string` Toast ID to remove	—

useToast()

Hook to subscribe to the toast store inside a React component

Prop	Type	Default
return.toasts#	`ToastItem[]` Array of current toast items in the store	—
return.toast#	`typeof toast` The complete toast imperative API (show, success, error, etc.)	—
return.dismiss#	`(id?: string) => void` Close toast(s) with animation	—
return.remove#	`(id: string) => void` Instantly remove a toast	—

Keyboard interactions

Key	Description
`F8`	Jumps focus into the toast viewport.
`Tab`	Moves focus through the toast.
`Esc`	Closes the focused toast.

Source code

If you didn't find what you need here, read the component implementation .