README.md

Payload Tree List Plugin

Important

This plugin is under development and is subject to BREAKING CHANGES. It is not yet recommended to use this in a production environment.

A plugin for Payload CMS that adds a collapsible Tree list view. This plugin depends on the Payload Nested Docs Plugin for its parent implementation.

This plugin is compatible only with Payload CMS version 3.x.

Installation / How to use

Minimum required payload version: 3.x

Install the plugin using yarn add @payloadcms/plugin-nested-docs payload-plugin-tree-list. Then, add the plugin to your Payload configuration file:

payload.config.ts:

import { buildConfig } from "payload";
import { nestedDocsPlugin } from "@payloadcms/plugin-nested-docs";
import { treeListPlugin } from "payload-plugin-tree-list";


export default buildConfig({
  ...
  plugins: [
    nestedDocsPlugin({ collections: ["posts"] }),
    treeListPlugin({ collections: ["posts"] }),
  ],
  ...
});

Testing locally

This project use yarn workspaces. Install all dependencies from root and build the plugin

yarn i
yarn build

To start the postgres database and the development server, run the following commands:

cd dev
cp .env.example .env
sh start-database.sh
yarn generate:importmap
yarn dev

Access http://localhost:3000/admin

The plugin is configured for pages collection