payload/packages/plugin-nested-docs/README.md

Payload Breadcrumbs Plugin

A breadcrumbs for Payload CMS to easily allow for nested documents.

Core features:

Installation

  yarn add payload-plugin-breadcrumbs
  # OR
  npm i payload-plugin-breadcrumbs

Basic Usage

In the plugins array of your Payload config, call the plugin with options:

import { buildConfig } from 'payload/config';
import breadcrumbs from 'payload-plugin-breadcrumbs';

const config = buildConfig({
  plugins: [
    breadcrumbs({
      collections: [''],
      parentFieldSlug: '',
      breadcrumbsFieldSlug: '',
      generateLabel: '',
      generateURL: ''
    })
  ]
});

export default config;

Options

• collections

  An array of collections slugs to enable breadcrumbs.

  TypeScript

  All types can be directly imported:

  import {
    BreadcrumbsConfig,
   } from 'payload-plugin-breadcrumbs/dist/types';
  

  Screenshots