Documentation
Page blocksHero

Hero Basic

A headline-led marketing hero — eyebrow, title, supporting copy, CTAs, and proof badges — installed as a wired Payload block.

v0.1.0Page blockHero familyHero section
import type { Block } from 'payload'import { heroFields } from '@/blocks/shared/heroFields'export const HeroBasic: Block = {  slug: 'heroBasic',  interfaceName: 'HeroBasicBlock',  fields: [    // Shared hero core (eyebrow, title, description, CTA links). Variant-specific    // fields follow; edit the shared shape in @/blocks/shared/heroFields.    ...heroFields,    {      name: 'proofItems',      type: 'array',      admin: {        initCollapsed: true,      },      fields: [        {          name: 'label',          type: 'text',          required: true,        },      ],      maxRows: 4,    },  ],  labels: {    plural: 'Hero Basic Blocks',    singular: 'Hero Basic',  },}

Installation

npx payload-components add hero-basic

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/hero-basic.json

What it installs

Copies 3 source files into your project:

  • src/blocks/shared/heroFields.tsshared
  • src/blocks/HeroBasic/config.ts
  • src/blocks/HeroBasic/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
heroFields.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 four fields come from the shared heroFields base; proofItems is specific to this variant.

Prop

Type

Usage

Add the block to a page. In the Payload admin, open (or create) a Page and add the HeroBasic 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
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.