Installation

npx payload-components add faq-icons

What it installs

Copies 4 source files into your project:

src/blocks/shared/faqFields.tsshared
src/blocks/shared/faqIcons.ts
src/blocks/FaqIcons/config.ts
src/blocks/FaqIcons/Component.tsx

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

Registers the block	`src/collections/Pages/index.ts`
Maps the renderer	`src/blocks/RenderBlocks.tsx`
Regenerates types	`src/payload-types.ts`
Regenerates the admin import map	`src/app/(payload)/admin/importMap.js`

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 is specific to this variant. Each item's icon is a select over the faqIcons allowlist — Payload stores the name and the frontend looks up the matching lucide mark at render.

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 FaqIcons 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

faq-split

Faq SplitA two-column FAQ pairing a sticky heading and CTA with an accordion of question/answer items.

faq-accordion

Faq AccordionA centered FAQ accordion of question/answer items with an optional CTA — the base of the FAQ family.

faq-grouped

Faq GroupedAn FAQ split into titled, icon-tagged category groups of accordions.

faq-card

Faq CardA centered FAQ accordion wrapped in a card with an optional CTA below.

faq-iconscurrent

Faq IconsAn FAQ accordion with a per-question icon picked from a fixed allowlist.

faq-grid

Faq GridA static two-column grid of question/answer cards — every answer visible, no accordion.