diff --git a/content/collections/pages/collections.md b/content/collections/pages/collections.md index ce8463e1f..83ed0b632 100644 --- a/content/collections/pages/collections.md +++ b/content/collections/pages/collections.md @@ -37,6 +37,8 @@ content/collections/ Creating a collection in the control panel takes care of all of this for you automatically, so don't stress too hard about memorizing all the details. ::: +You can [organize the collections listing page](/control-panel/organizing-collection-listings) into named groups. + ## Entries Each entry has, at the very least, a title, published status, id, and _usually_ additional content fields. These content fields are determined by one or more [blueprints](/blueprints) set on the collection. diff --git a/content/collections/pages/organizing-collection-listings.md b/content/collections/pages/organizing-collection-listings.md new file mode 100644 index 000000000..b272131e0 --- /dev/null +++ b/content/collections/pages/organizing-collection-listings.md @@ -0,0 +1,140 @@ +--- +id: 5e16d45c-5fb5-43e3-b82f-c2f7bbc85264 +blueprint: page +title: 'Organizing Collection Listings' +intro: 'Group and reorder the collections in the Control Panel.' +template: page +related_entries: + - 7202c698-942a-4dc0-b006-b982784efb03 + - 452c268b-b885-4deb-8e46-1cc3ebc66e4f + - 2ce74b48-d3cc-4b8a-a8d4-f514c0b1d6ff + - 11434ba8-33f6-4229-b5d7-e4c9c3ea867e +--- +## Overview + +You can organize collections into named groups, and reorder both the groups and the collections within them. + +The [collections listing page](/content-modeling/collections) is currently the only one that can be grouped and reordered. + +
+ The collections listing page split into Marketing, Store, and Other groups + The collections listing page split into Marketing, Store, and Other groups +
The same collections as before, no longer in one long alphabetical run.
+
+ +## Accessing the organizer + +You can access the organizer through the **Organize** button in the listing header, next to the list/grid toggle. It's also in the [command palette](/control-panel/command-palette)! + +
+ The Organize Collections screen, showing two groups of collections with drag handles and an Add Group button + The Organize Collections screen, showing two groups of collections with drag handles and an Add Group button +
Sensibly organized collections. This sparks joy.
+
+ +## Organizing a listing + +Each group gets its own panel. Collections you haven't sorted yet wait in the **Other** panel at the bottom, trying not to take it personally. + +### Creating and deleting groups + +**Add Group** adds a group to the bottom of the screen. The pencil icon in a group's header renames it, and the trash icon deletes it. Collections in a deleted group return to **Other**. + +### Adding and removing collections + +**Add Collection** opens a searchable picker of the collections not already in that group. A collection can only be in one group at a time. + +To remove a collection, drag it to **Other** or click the trash icon on its row. Collections that no longer exist appear as **Unavailable**, so you can see what a group still references. + +### Reordering + +Drag the handle in a group's header to reorder the groups. Drag the handle on a collection's row to move it within a group, or into another one. + +### Saving + +Click **Save**, or hit ⌘ S. + +### Resetting + +**Reset Groups** in the organizer header deletes your saved groups, returning the listing to its default state. + +## How grouped listings behave + +Your listing keeps the order you saved, groups and collections alike. Sorting by a column header still works, though it sorts within each group rather than across the whole listing. + +Each group gets its own select-all checkbox, while actions apply to selected rows across all of them. + +Empty groups don't appear on the listing, only in the organizer. The grid view is grouped the same way. + +## Permissions + +Organizing requires the `manage preferences` [permission](/control-panel/permissions). + +## Storage + +Groups are saved in `resources/preferences.yaml`: + +```yaml +resource_indexes: + collections: + groups: + - + id: V1StGXR8Z5 + title: Marketing + items: + - blog + - case-studies + - landing-pages + - + id: kJ4mZq2LxA + title: Store + items: + - products + - product-categories +``` + +Each group's `items` are collection handles. Group `id`s are generated for you, and only need to be unique within the listing. + +Groups are site-wide, and not per-user or role. + +## Storing groups somewhere else + +To store groups elsewhere, point the `statamic.cp.resource_indexes.repository` config value at your own class: + +```php +// config/statamic/cp.php + +'resource_indexes' => [ + 'repository' => \App\ResourceIndexes\DatabaseGroupRepository::class, +], +``` + +Your class needs to implement the `GroupRepository` contract: + +```php +