FAQ

Open source

Frequently-asked-question sections — an accordion, a two-column split, a static grid and grouped categories.

resources/views/blocks/faq-split.blade.php Blade

@props([
    'eyebrow' => 'FAQ',
    'heading' => 'Questions, answered',
    'subheading' => 'Can’t find what you’re looking for? Our team is one message away and typically replies within a few hours.',
    'supportCta' => 'Contact support',
    'supportHref' => '#',
    'items' => null,
])

@php
    $items ??= [
        ['question' => 'Do I own the installed code?', 'answer' => 'Yes. Components and blocks are copied into your project as plain Blade. There is no runtime lock-in — edit anything you like.'],
        ['question' => 'How do updates work?', 'answer' => 'Run the update command to pull upstream changes. Unedited files update automatically; edited files are never overwritten and produce a reviewable diff.'],
        ['question' => 'Can I theme it?', 'answer' => 'The entire system is driven by CSS design tokens. Re-theme light, dark, and per-surface variants by editing variables only.'],
        ['question' => 'Is it accessible?', 'answer' => 'Components target WCAG 2.2 AA: keyboard support, focus-visible states, ARIA wiring, reduced motion, and RTL-safe layout.'],
        ['question' => 'How do I get help?', 'answer' => 'Reach out to support any time. We answer setup, theming, and migration questions and ship fixes quickly.'],
    ];
@endphp

<x-ui.section space="xl" {{ $attributes }}>
    <x-ui.container gutter="sm">
        <div class="grid grid-cols-1 gap-12 lg:grid-cols-2">
            <div class="lg:sticky lg:top-24 lg:self-start">
                @if ($eyebrow)
                    <x-ui.badge variant="secondary" class="mb-6">{{ __($eyebrow) }}</x-ui.badge>
                @endif

                <h2 class="text-balance text-3xl font-bold tracking-tight sm:text-4xl">
                    {{ __($heading) }}
                </h2>

                <p class="mt-4 max-w-md text-pretty text-lg text-muted-foreground">
                    {{ __($subheading) }}
                </p>

                @if ($supportCta)
                    <x-ui.button :href="$supportHref" variant="outline" class="group mt-8 inline-block">
                        {{ __($supportCta) }}
                        <svg class="ms-2 size-4 transition-transform group-hover:translate-x-0.5 rtl:rotate-180" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true">
                            <path d="M5 12h14" />
                            <path d="m12 5 7 7-7 7" />
                        </svg>
                    </x-ui.button>
                @endif
            </div>

            <x-ui.accordion>
                @foreach ($items as $i => $item)
                    <x-ui.accordion.item :value="'faq-'.$i">
                        <x-ui.accordion.trigger>{{ __($item['question']) }}</x-ui.accordion.trigger>
                        <x-ui.accordion.content>{{ __($item['answer']) }}</x-ui.accordion.content>
                    </x-ui.accordion.item>
                @endforeach
            </x-ui.accordion>
        </div>
    </x-ui.container>
</x-ui.section>

Installation

terminal

php artisan ui:add blocks/faq-split

Installs these dependencies automatically:

accordion badge button container section

Registry contract

Install confidence

php artisan ui:add blocks/faq-split writes only the generated targets below. The CLI validates each file hash before writing and prompts before replacing local changes unless --force is used.

Version: 1.0.4
License: open
Stability: stable
Contract: v1
Foundation: ≥ 1.0.0

Type	Generated target
blade	resources/views/blocks/faq-split.blade.php

Registry dependencies

accordion badge button container section

Package dependencies

composer: jml/brok:^0.2

Use with AI

A brief for your coding agent: what the block is, the install command, how to render it, its props and the rules. Copy it, or open a prompt about this block in an assistant.

faq-split.md

# Brok UI block: FAQ Split (`faq-split`)

Two-column FAQ with a sticky intro column (eyebrow, heading, supporting copy, contact-support button) beside an accordion of questions and answers.

Brok UI is a Laravel Blade registry. `ui:add` copies this block into the app as plain Blade the app owns; it composes installed `<brok:*>` primitives and semantic design tokens.

## Install

```bash
php artisan ui:add blocks/faq-split
```

## Render it

```blade
<x-blocks.faq-split />
```

## Props

- `eyebrow` (string, default `FAQ`)
- `heading` (string, default `Questions, answered`)
- `subheading` (string, default `Can’t find what you’re looking for? Our team is one message away and typically replies within a few hours.`)
- `support-cta` (string, default `Contact support`)
- `support-href` (string, default `#`)
- `items` (mixed|null, default `null`)

## Use when

- Pairing a sticky intro column (heading, copy, contact-support button) with an accordion of questions on a wider layout.
- Keeping a support escape hatch visible beside the questions rather than only at the end of the list.

## Avoid when

- Use faq-accordion for a single-column accordion without a support column, or faq-contact for a support-agent contact card instead.

## Rules

- Render the installed block with `<x-blocks.faq-split />` and pass data through its props; edit the copied file only for structural changes.
- Keep the semantic design tokens (`bg-background`, `text-muted-foreground`); never swap in raw colour utilities.
- Keep the `data-slot` attributes and the logical (start/end) spacing so the markup still mirrors under `dir="rtl"`.

## Links

- Docs: https://brokui.dev/blocks/faq-split
- Registry JSON (files, props, contract): https://brokui.dev/r/open/blocks/faq-split.json

Ask about FAQ Split in

Working in Claude Code, Cursor or Codex? Give the agent the whole registry through the MCP server or the Brok UI skill.

Guidance

Use when

Pairing a sticky intro column (heading, copy, contact-support button) with an accordion of questions on a wider layout.
Keeping a support escape hatch visible beside the questions rather than only at the end of the list.

Avoid when

Use faq-accordion for a single-column accordion without a support column, or faq-contact for a support-agent contact card instead.

Anti-patterns

Do not replace semantic props with conflicting utility classes.
Do not remove labels, focus styles, or state attributes.

Usage

Render the block as a component, passing data where useful:

resources/views/welcome.blade.php Blade

<x-blocks.faq-split />

Built from primitives

Composes <brok:*> Semantic tokens Re-themeable RTL-ready

This block composes installed <brok:*> primitives and semantic design tokens only — it does not reimplement any primitive. Re-theme it (light, dark, admin, customer) by editing CSS variables; flip the preview to RTL to confirm it mirrors.

Source

The exact, editable file ui:add writes into your app. The preview above renders this same source — there are no preview-only blocks.