Documentation
Page blocksTeam

Team Roster

A team section that groups members into titled departments, each a grid of avatars with name and role.

v0.1.0Page blockTeam familyTeam section
import type { Block } from 'payload'import { teamFields, teamMemberFields } from '@/blocks/shared/teamFields'export const TeamRoster: Block = {  slug: 'teamRoster',  interfaceName: 'TeamRosterBlock',  fields: [    // Shared team core (eyebrow, title). Variant-specific fields follow; edit the    // shared shape in @/blocks/shared/teamFields.    ...teamFields,    {      name: 'groups',      type: 'array',      required: true,      minRows: 1,      maxRows: 6,      admin: {        initCollapsed: true,      },      labels: {        plural: 'Groups',        singular: 'Group',      },      fields: [        {          name: 'label',          type: 'text',          required: true,        },        {          name: 'members',          type: 'array',          required: true,          minRows: 1,          maxRows: 12,          admin: {            initCollapsed: true,          },          // Shared member shape — see @/blocks/shared/teamFields.          fields: teamMemberFields,        },      ],    },  ],  labels: {    plural: 'Team Roster Blocks',    singular: 'Team Roster',  },}

Installation

npx payload-components add team-roster

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/team-roster.json

What it installs

Copies 3 source files into your project:

  • src/blocks/shared/teamFields.tsshared
  • src/blocks/TeamRoster/config.ts
  • src/blocks/TeamRoster/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
teamFields.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 eyebrow and title fields come from the shared Team family base (src/blocks/shared/teamFields.ts); the groups list is specific to this variant.

Prop

Type

Each item in groups carries:

Prop

Type

Each item in members carries:

Prop

Type

Usage

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

In this family