tabshift/payloadcms
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

feat(plugin-nested-docs): pass collection config as an arg to generateURL and generateLabel (#14086)

Browse Source 
Closes https://github.com/payloadcms/payload/issues/10378

We now pass `collection` containing the current collection's config into
the `generateURL` and `generateLabel` as a third parameter.

In the future we should change this into an object so we can more easily
insert new params.
This commit is contained in:
Paul
2025-10-06 06:38:46 -07:00
committed by GitHub
parent 3cf3f93e1f
commit db6ec3026c
3 changed files with 15 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/plugins/nested-docs.mdx
View File

@@ -129,10 +129,11 @@ nestedDocsPlugin({
The function takes two arguments and returns a string:
| Argument | Type | Description |
| -------- | -------- | -------------------------------------------- |
| `docs` | `Array` | An array of the breadcrumbs up to that point |
| `doc` | `Object` | The current document being edited |
| Argument | Type | Description |
| ------------ | -------- | --------------------------------------------- |
| `docs` | `Array` | An array of the breadcrumbs up to that point |
| `doc` | `Object` | The current document being edited |
| `collection` | `Object` | The collection config of the current document |
#### `generateURL`
@@ -148,10 +149,11 @@ nestedDocsPlugin({
})
```
| Argument | Type | Description |
| -------- | -------- | -------------------------------------------- |
| `docs` | `Array` | An array of the breadcrumbs up to that point |
| `doc` | `Object` | The current document being edited |
| Argument | Type | Description |
| ------------ | -------- | --------------------------------------------- |
| `docs` | `Array` | An array of the breadcrumbs up to that point |
| `doc` | `Object` | The current document being edited |
| `collection` | `Object` | The collection config of the current document |
#### `parentFieldSlug`

4
packages/plugin-nested-docs/src/types.ts
View File

@@ -1,4 +1,4 @@
import type { CollectionSlug } from 'payload'
import type { CollectionSlug, SanitizedCollectionConfig } from 'payload'
export type Breadcrumb = {
doc: string
@@ -9,11 +9,13 @@ export type Breadcrumb = {
export type GenerateURL = (
docs: Array<Record<string, unknown>>,
currentDoc: Record<string, unknown>,
collection: SanitizedCollectionConfig,
) => string
export type GenerateLabel = (
docs: Array<Record<string, unknown>>,
currentDoc: Record<string, unknown>,
collection: SanitizedCollectionConfig,
) => string
export type NestedDocsPluginConfig = {

4
packages/plugin-nested-docs/src/utilities/formatBreadcrumb.ts
View File

@@ -27,11 +27,11 @@ export const formatBreadcrumb = ({
const lastDoc = docs[docs.length - 1]!
if (typeof generateURL === 'function') {
url = generateURL(docs, lastDoc)
url = generateURL(docs, lastDoc, collection)
}
if (typeof generateLabel === 'function') {
label = generateLabel(docs, lastDoc)
label = generateLabel(docs, lastDoc, collection)
} else {
const title = collection.admin?.useAsTitle ? lastDoc[collection.admin.useAsTitle] : ''