Documentation
Page blocksFAQ

Faq Split

A two-column FAQ pairing a sticky heading and CTA with an accordion list.

v0.1.0Page blockFAQ familyFAQ section
import type { Block } from 'payload'import { faqFields, faqItemsField } from '@/blocks/shared/faqFields'import { linkGroup } from '@/fields/linkGroup'export const FaqSplit: Block = {  slug: 'faqSplit',  interfaceName: 'FaqSplitBlock',  fields: [    // Shared FAQ core (eyebrow, title, description). Variant-specific fields    // follow; edit the shared shape in @/blocks/shared/faqFields.    ...faqFields,    faqItemsField,    linkGroup({      overrides: {        admin: {          initCollapsed: true,        },        maxRows: 1,      },    }),  ],  labels: {    plural: 'FAQ Split Blocks',    singular: 'FAQ Split',  },}

Installation

npx payload-components add faq-split

Copy the files straight from the registry, then wire the Payload fragments by hand:

pnpm dlx shadcn@latest add https://www.payload-components.xyz/r/faq-split.json

What it installs

Copies 3 source files into your project:

  • src/blocks/shared/faqFields.tsshared
  • src/blocks/FaqSplit/config.ts
  • src/blocks/FaqSplit/Component.tsx

…and makes 4 edits to wire the block into your project:

Registers the blocksrc/collections/Pages/index.ts
Maps the renderersrc/blocks/RenderBlocks.tsx
Regenerates typessrc/payload-types.ts
Regenerates the admin import mapsrc/app/(payload)/admin/importMap.js
faqFields.ts is the shared field core for this family — every variant composes it. Editing it updates each installed block at once, and re-running an install never overwrites a copy you have changed.

Re-running the install converges: it detects existing wiring, skips it, and records install state in .payload-components/state.json.

Content model

The first three fields come from the shared faqFields base; items and links are specific to this variant.

Prop

Type

Each item in items carries:

Prop

Type

Usage

Add the block to a page. In the Payload admin, open (or create) a Page and add the FaqSplit block to its layout.
Fill the content. Complete the fields from the content model above — the component ships sample content you can start from.
Publish. Save and publish the page; the block renders through RenderBlocks on the frontend, fully typed — no extra wiring.

Requirements

Target
payload-website-starter
Payload
v3
Next.js
15 / 16
shadcn UI
accordion, badge

Your project must already expose components.json, src/payload.config.ts, src/blocks/RenderBlocks.tsx, src/collections/Pages/index.ts — the surfaces payload-components add patches. The CLI verifies this against the support matrix before touching anything.

In this family