Skip to content

Commit c720ce3

Browse files
authored
docs: folders beta (#12500)
1 parent 3a73a67 commit c720ce3

File tree

3 files changed

+7
-0
lines changed

3 files changed

+7
-0
lines changed

docs/folders/overview.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,11 @@ Folders allow you to group documents across collections, and are a great way to
1010

1111
The configuration for folders is done in two places, the collection config and the Payload config. The collection config is where you enable folders, and the Payload config is where you configure the global folder settings.
1212

13+
<Banner type="warning">
14+
**Note:** The Folders feature is currently in beta and may be subject to
15+
change in minor versions updates prior to being stable.
16+
</Banner>
17+
1318
## Folder Configuration
1419

1520
On the payload config, you can configure the following settings under the `folders` property:

packages/payload/src/collections/config/types.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -347,6 +347,7 @@ export type CollectionAdminOptions = {
347347
enableRichTextRelationship?: boolean
348348
/**
349349
* Enables folders for this collection
350+
* @deprecated this property will move out of `admin` in the next patch
350351
*/
351352
folders?: CollectionFoldersConfiguration
352353
/**

packages/payload/src/config/types.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -985,6 +985,7 @@ export type Config = {
985985
endpoints?: Endpoint[]
986986
/**
987987
* Options for folder view within the admin panel
988+
* @experimental this feature may change in minor versions until it is fully stable
988989
*/
989990
folders?: RootFoldersConfiguration
990991
/**

0 commit comments

Comments
 (0)