Plugin conventions

Every @10x-media plugin follows the same shape. Learn it once and each plugin's options read the same way.

The factory

Each plugin exports one factory, authored with Payload's experimental definePlugin helper. The factory takes a typed options object and returns a standard Payload Plugin:

import { buildConfig } from 'payload'
import { jobs } from '@10x-media/jobs'

export default buildConfig({
  plugins: [jobs({})],
})

definePlugin attaches two pieces of metadata to the returned plugin. The slug is the package name (@10x-media/jobs); Payload builds a slug-keyed map of registered plugins from it, which is how the plugins detect each other. Webhooks, for example, switches its delivery mode when it finds Jobs in that map. order controls when a plugin runs relative to its siblings: contributors run early (webhooks at order: 10), consumers late (automations at order: 100), so contributions are already in place when the consumer reads them. Both mechanisms are shown in action in Jobs family interop.

Every factory accepts disabled: true, which returns the incoming config untouched. Use it to switch a plugin off per environment without removing the call.

The opt-in convention

Optional features follow Payload's own form: false or omitted disables, true enables with defaults, an object enables and customizes.

jobs({
  reliability: true,                      // defaults
  queueControl: { queues: ['default', 'emails'] }, // customized
  // reliability: false,                  // off (same as omitting)
})

The same convention nests one level down where it fits, for example form-builder's per-type registries: fields: { number: false, rating: myFieldType } removes a built-in and adds a custom type in one object.

Subpath exports

Each package splits its surface into subpath exports so server code, client components, and metadata stay separate:

Some plugins add more: analytics ships ./adapters/*, ./geo, and ./testing; form-builder ships ./react (the frontend renderer) and ./styles.css.

Requirements

All plugins declare the same peers: payload@^3.82.0, react@^19.0.0, react-dom@^19.0.0, and @payloadcms/ui@^3.82.0. Node 22.18 or newer. Optional integrations are optional peer dependencies (for example @google-analytics/data and maxmind in analytics), so you install only what you use.