Skip to content

Commit eeabc52

Browse files
committed
docs(core): add documentation for customizing slug and labels
1 parent e7e6a1c commit eeabc52

1 file changed

Lines changed: 13 additions & 1 deletion

File tree

src/types/pluginOptions.ts

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -543,13 +543,25 @@ export type CollectionConfig = {
543543
time?: Duration
544544
}
545545

546+
/**
547+
* 📝 Uses internal payload CMS configuration for labels
548+
*
549+
* 📖 You can customize the plugin's built-in collection label.
550+
* @see {@link https://payloadcms.com/docs/configuration/collections#config-options}
551+
*/
546552
labels?:
547553
| {
548554
plural?: LabelFunction | StaticLabel | undefined
549555
singular?: LabelFunction | StaticLabel
550556
}
551557
| undefined
552-
558+
/**
559+
* 📝 Uses internal payload CMS configuration for slug
560+
*
561+
* 📖 You can customize the plugin's built-in collection slug.
562+
*
563+
* @see {@link https://payloadcms.com/docs/configuration/collections#config-options}
564+
*/
553565
slug?: (typeof allowedSlugs)[number] | ({} & string)
554566

555567
/**

0 commit comments

Comments
 (0)