Accordion.
Make room for the details.
Live preview
import { Accordion } from "luminescent";
import "luminescent/style.css";
export function Example() {
return (
<Accordion title="What makes it luminescent?" defaultExpanded>
Semantic tokens, carefully layered light, and native interactions.
</Accordion>
);
}
Installation
npm install luminescent
Import luminescent/style.css once at your application root. The example above uses the same package implementation as Storybook.
Variants and states
Use the preview controls to explore the supported variants, sizes, disabled/loading states and reduced motion. Controls appear only where the component exposes the corresponding prop. Theme and glow apply to every component.
Controlled and uncontrolled state
State contract: expanded / defaultExpanded / onChange. Omit the controlled prop to let the component own its initial state; supply a value and callback when your application owns it. Native uncontrolled fields and state-backed form controls participate in form reset. Controlled state must be reset by the application.
import { useState } from "react";
import { Accordion } from "luminescent";
export function ControlledExample() {
const [value, setValue] = useState(false);
return (
<Accordion title="Details" expanded={value} onChange={setValue}>
Your project details.
</Accordion>
);
}
API reference
Generated from the source TypeScript interfaces. Native attributes, className, style, aria-* and data-* also pass through to the documented element. Import AccordionProps from the package for the full inherited contract.
| Prop | Type | Details |
|---|---|---|
titlerequired | React.ReactNode | Optional unless marked required. |
expanded | boolean | Optional unless marked required. |
defaultExpanded | boolean | Optional unless marked required. |
onChange | (expanded: boolean) => void | Optional unless marked required. |
disabled | boolean | Optional unless marked required. |
glowColor | GlowColor | Optional unless marked required. |
headingLevel | 2 | 3 | 4 | 5 | 6 | Optional unless marked required. |
Accessibility and keyboard
Tab to a heading; Enter or Space toggles its associated region. Collapsed content is hidden from the tab order.
Keep labels meaningful and test application-level contrast, focus order and screen-reader output. See the accessibility guide for composition requirements.
Theme customization
import { LuminescentProvider, Accordion } from "luminescent";
import "luminescent/style.css";
export function Example() {
return (
<LuminescentProvider theme="light" accent="violet" glow="subtle">
<Accordion title="What makes it luminescent?" defaultExpanded>
Semantic tokens, carefully layered light, and native interactions.
</Accordion>
</LuminescentProvider>
);
}
Switch between light and dark in the preview, or open the playground for a larger workspace. Custom CSS variables can override spacing, color, typography and effects.