payload-plugin-tree-list

KO | EN

gitlite — search

#javascript #php #android #python #cms #hacktoberfest #nodejs #machine-learning #java #golang #react #bot

payload-plugin-tree-list

★ 50 Open GitHub ↗

A plugin for Payload CMS that adds a collapsible Tree list view.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Payload Tree List Plugin

> [!CAUTION]
> This repository is obsolete and is no longer actively maintained due to changes implemented by PayloadCMS since version 3.

----

A plugin for [Payload CMS](https://github.com/payloadcms/payload) that adds a collapsible Tree list view. This plugin depends on the [Payload Nested Docs Plugin](https://github.com/payloadcms/payload/tree/beta/packages/plugin-nested-docs) for its parent implementation.

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

![Payload Tree List Plugin Example with some items open and other closed](https://raw.githubusercontent.com/italodr/payload-plugin-tree-list/main/images/payload-plugin-tree-list.gif)

## 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:

```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

```sh
yarn i
yarn build
```

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

```sh
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

payload-plugin-tree-list

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README