# FAQ Section (Lumen Halo): prompt.md (v1.0.0)

- id: `lumen-faq-section` · version 1.0.0 · block · pro (Pro)
- category: Marketing
- build: Base UI (one set of files; its dependencies follow the build)
- install (this build): `npx shadcn@latest add @beautiful-ui-pro/lumen-faq-section`
- npm dependencies: none
- registry dependencies: utils, @beautiful-ui-pro/lumen-accordion, @beautiful-ui/lumen-collapsible, @beautiful-ui/lumen-input, https://beautiful-ui.dev/r/lumen-foundation.json
- docs: https://beautiful-ui.dev/components/lumen-faq-section
- The install command carries everything this item needs (files, CSS, tokens, npm and registry dependencies). Prefer it to copying source by hand.

Questions and answers grouped by topic, with a search that narrows as you type and says how many match. Topics sit beside the list as a quiet index on wide screens and above it on narrow ones; answers open and close as Lumen Accordion items.

## Build it
- Stack: React 19 (`ref` is a plain prop), TypeScript, Tailwind CSS v4 utilities, a shadcn-initialised project with the `@/*` alias.
- Packages: none beyond React.
- Files: `components/ui/lumen/blocks/faq-section.tsx`.
- Registry dependencies, installed with it automatically: shadcn `utils` (cn), `lumen-accordion`, `lumen-collapsible`, `lumen-input`, `lumen-foundation`.
- Builds: one set of files for both, but its dependencies come in Base UI and Radix builds. Install the one that matches the project (see Install): a free item's bare URL installs the Base UI build of it and its dependencies.
- Exports to keep: `FaqSection`, and every exported type.
- CSS: the install merges this item's rules (the registry `css` field) into your global stylesheet, in `@layer components`, and adds the lumen foundation (tokens, keyframes, motion levels) once. Nothing to import by hand.
- Re-running `add` (or `--overwrite`) re-applies those rules: put overrides in your own CSS, never in the installed rules.
- Tokens: retheme with the `--lumen-*` custom properties (`--lumen-accent`, `--lumen-accent-foreground`, `--lumen-accent-text`, `--lumen-bad`, `--lumen-bad-text`, `--lumen-chart-accent`, `--lumen-chart-accent-foreground`, `--lumen-chart-accent-text`, `--lumen-focus`, `--lumen-good`, `--lumen-good-text`, `--lumen-hairline`, `--lumen-ink`, `--lumen-muted-ink`, `--lumen-series-1`, `--lumen-series-2`, `--lumen-series-3`, `--lumen-series-4`, `--lumen-series-5`, `--lumen-series-6`, `--lumen-warn`, `--lumen-warn-text`); this item's CSS also reads `--lumen-font-mono`, `--lumen-font-sans`, `--lumen-radius-k`. Never add Tailwind colour classes inside the component.

```tsx
import { FaqSection, type FaqItem } from "@/components/ui/lumen/blocks/faq-section";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `FaqSection` | `faq-section` | The heading, topics, search and grouped questions. |

Style a part with `[data-slot="<slot>"]` selectors or its `className`; keep the attributes when editing.

## Sound
- Keep every `data-slot` and `data-sound` attribute: the sound layer reads them.
- Installing this item adds no audio. Nothing plays until the app mounts `GlassSoundProvider` once (install: `npx shadcn@latest add https://beautiful-ui.dev/r/glass-sound.json`, import from `@/components/beautiful-ui/glass-sound`); `GlassSoundToggle` is its mute control. Without a provider the audio engine never loads.

## Match the original
- Read `components/ui/lumen/blocks/faq-section.tsx` as the reference implementation before changing or recreating anything, and match it: sizes, colours per theme, motion timings, copy and behaviour.
- If you deviate (a prop you can't honour, a style you changed, a dependency you swapped), say so in your reply, part by part.
- Keep the accessibility contract, the keyboard map and the motion levels listed below.

## Use it when
- faq, frequently asked questions, help section, questions and answers, pricing faq, support questions
- The questions section of a pricing or landing page
- A help page with many questions across topics

### Not when
- A few disclosures with no search: use Accordion directly
- A full help centre with articles: link out to it

## Mistakes
- Pass text for answers that are nodes, or search won't find words inside them
- Keep ids stable so open answers stay open after a re-render

## Usage

```tsx
import { FaqSection, type FaqItem } from "@/components/ui/lumen/blocks/faq-section";

const faqs: FaqItem[] = [
  { id: "trial", topic: "Billing", question: "Is there a free trial?", answer: "Yes. Every plan starts with 14 days free, no card needed." },
  { id: "cancel", topic: "Billing", question: "Can I cancel any time?", answer: "Yes. You keep access until the end of the period you paid for." },
  { id: "sso", topic: "Security", question: "Do you support single sign-on?", answer: "On Team and Scale, with SAML and SCIM." },
];

export function PricingFaq() {
  return <FaqSection title="Questions, answered" items={faqs} />;
}
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `items` | `FaqItem[]` |  | FaqItem = { id, question, answer (string or nodes), text? (the answer as plain text, for search, when answer is nodes), topic? }. |
| `title / description` | `ReactNode / ReactNode` |  | The section heading and its line. |
| `searchable` | `boolean` | `more than six questions` | Show the search. |
| `defaultOpen` | `string[]` |  | Questions open at first. |
| `labels` | `{ search?, topics?, matches?(n), empty?, other? }` |  | Words, for i18n; other names questions with no topic. |

Full docs: https://beautiful-ui.dev/components/lumen-faq-section

## Customising
- Colours: set the `--lumen-*` tokens on `:root`, or on a container with the `lumen-scope` class to retheme one area. Add the `lumen-inherit` class to follow your shadcn palette instead (`--chart-N`, `--destructive`).
- Dark mode follows the `.dark` class on an ancestor (the shadcn and next-themes convention).
- Update later by re-running the install with `--overwrite` (review the diff if you edited it). Changelog: https://beautiful-ui.dev/r/changelog.json

## Keyboard

| Keys | Action |
|---|---|
| Tab | Topics, the search, then each question |
| Enter / Space | Open or close an answer |

## Performance

- Search is a single pass over the questions; fine for a few hundred

## Responsive

- Topics sit beside the questions and become a row of chips above them under 640px

## Motion inventory

| Interaction | What moves |
|---|---|
| Open | Accordion's own: the panel unfolds and the chevron turns |

## Accessibility contract (preserve when editing)
- Answers are disclosure buttons with aria-expanded, each controlling its panel
- Topics are a labelled navigation of in-page links with their counts as text
- The search is labelled and its match count is announced politely

## Install

```bash
npx shadcn@latest add @beautiful-ui-pro/lumen-faq-section
```

Pro item: needs the `@beautiful-ui-pro` registry in `components.json` and `BEAUTIFUL_UI_TOKEN` in `.env.local` (https://beautiful-ui.dev/account). Setup: https://beautiful-ui.dev/docs/pro. Your components.json `style` picks the build: radix-*, new-york and default get Radix, base-* gets Base UI.

The lumen foundation (the tokens listed above, keyframes and motion levels) installs once with the first component; its CSS is public at https://beautiful-ui.dev/r/lumen-foundation.json.
