Summary

This PR adds support for custom collection-level views in Payload CMS, resolving issue payloadcms#15386.

Changes

• Update CollectionAdminOptions type to allow custom views at collection level
• Create helper function to check for custom collection views by route
• Modify getRouteData.ts to check for custom collection views before defaulting to edit views
• Add test collection with custom grid view
• Add E2E test to verify routing works
• Fix TypeScript errors
• Address code review feedback
• Run security scan (no issues)
• Ensure folders take precedence over custom views
• Fix TypeScript build errors in dependent packages

Implementation Details

Type Changes (packages/payload/src/collections/config/types.ts)

Added index signature with union type [key: string]: AdminViewConfig | EditConfig | { actions?: CustomComponent[]; Component?: PayloadComponent } | undefined to allow custom views at the collection level while maintaining compatibility with existing edit and list properties.

Routing Order

The routing logic checks in this priority order:

1. Trash views - /collections/:slug/trash
2. Folder views - /collections/:slug/:folderSlug (built-in feature)
3. Custom collection views - /collections/:slug/:customPath (NEW)
4. Edit views - /collections/:slug/:id or /collections/:slug/create

This ensures built-in features like folders maintain priority over custom views.

Routing Logic (packages/next/src/views/Root/getRouteData.ts)

Added check for custom collection views, positioned after folders but before edit views.

Helper Function (packages/next/src/views/Root/getCustomCollectionViewByRoute.ts)

Created helper to find custom collection views by matching the current route against configured view paths, skipping known view types (edit and list).

Example Usage

const mediaCollection = {
  slug: 'media',
  admin: {
    components: {
      views: {
        grid: {
          Component: '@/components#GridView',
          path: '/grid',
          exact: true,
        },
      },
    },
  },
  // ...
}

Accessible at: /collections/media/grid

Security

• CodeQL scan: No issues found
• No dependencies added
• No security vulnerabilities introduced

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.