\n\n## Documentation\n\n**[Full documentation →](https://delmaredigital.github.io/payload-page-tree/)**\n\n[](https://deepwiki.com/delmaredigital/payload-page-tree)\n\n## Installation\n\n```bash\npnpm add @delmaredigital/payload-page-tree\n```\n\n## Quick Start\n\n### 1. Add the plugin\n\n```typescript\n// src/payload.config.ts\nimport { buildConfig } from 'payload'\nimport { pageTreePlugin } from '@delmaredigital/payload-page-tree'\nimport { Pages } from './collections/Pages'\n\nexport default buildConfig({\n collections: [Pages],\n plugins: [\n pageTreePlugin(), // Auto-detects 'pages' and 'posts' if they exist\n ],\n})\n```\n\n### 2. Define your collection\n\nYour collections **must** have a `slug` field. The plugin makes it read-only and auto-generates values from folder path + page segment.\n\n```typescript\n// src/collections/Pages/index.ts\nimport type { CollectionConfig } from 'payload'\n\nexport const Pages: CollectionConfig = {\n slug: 'pages',\n fields: [\n { name: 'title', type: 'text', required: true },\n {\n name: 'slug',\n type: 'text',\n required: true,\n unique: true,\n index: true,\n },\n ],\n}\n```\n\n> **Important:** Do NOT use Payload's `slugField()` helper. Use a plain text field — the plugin manages slugs via its own hooks.\n\n### 3. Frontend routing\n\n```typescript\n// app/[...slug]/page.tsx\nexport default async function Page({ params }: { params: { slug: string[] } }) {\n const fullSlug = params.slug.join('/')\n\n const { docs } = await payload.find({\n collection: 'pages',\n where: { slug: { equals: fullSlug } },\n limit: 1,\n })\n\n // ...\n}\n```\n\nThat's it! The plugin adds `folder`, `pageSegment`, `sortOrder`, and `slugHistory` fields automatically, and registers the tree view at `/admin/page-tree`.\n\n---\n\nFor configuration options, tree view features, URL history, organization scoping, extensibility, and more, see the **[full documentation](https://delmaredigital.github.io/payload-page-tree/)**.\n\n## Access control\n\nThe tree view calls fourteen endpoints under `/api/page-tree/*`. Two layers decide who may use them:\n\n1. **Endpoint gate** — the `access` option runs before every endpoint. By default it requires an authenticated Payload user (`401` without a user, `403` when denied).\n2. **Collection access rules** — every operation the endpoints perform runs with `overrideAccess: false` as the requesting user, so the `access` rules on your page and folder collections are always enforced.\n\n```typescript\npageTreePlugin({\n // Only admins may use the tree endpoints\n access: ({ req }) => req.user?.role === 'admin',\n})\n```\n\n> **Upgrading from 0.3.16 or earlier:** those versions registered the endpoints with no authentication and bypassed collection access rules. Upgrade, and review the `access` rules on your page and folder collections — they now govern the tree. See the [CHANGELOG](./CHANGELOG.md#0317---2026-09-09).\n\n## License\n\nMIT\n","readmeFilename":"README.md"}
![\"Starter](\"https://img.shields.io/badge/Starter_Template-Use_This-blue?style=for-the-badge&logo=github&logoColor=white\"){kind=icon}
\n