Payload CMS Release: 2.16.0

TL;DR

Payload CMS v2.16.0 Release

This release introduces enhanced admin UI customization options with new field properties to control list visibility and filtering. It also addresses several important bugs, including GraphQL upload relation issues, drag handle visibility problems, and form builder hook override functionality.

Developers using Payload CMS will benefit from more granular control over their admin interface while enjoying improved stability across various features.

Highlight of the Release

• New admin UI customization options with disableListColumn and disableListFilter field properties
• Fixed GraphQL upload relations that were incorrectly returning null
• Improved UI consistency by hiding drag handles when sorting is disabled
• Fixed form builder plugin hook override functionality

Migration Guide

No migration steps are required for this release. The new field properties (disableListColumn and disableListFilter) are optional and can be added to existing field configurations without breaking changes.

Example usage of the new field properties:

{
  name: 'someField',
  type: 'text',
  admin: {
    disableListColumn: true, // This field won't appear as a column in list views
    disableListFilter: true  // This field won't be available as a filter option
  }
}

Upgrade Recommendations

This release contains useful admin UI enhancements and important bug fixes, particularly for users working with GraphQL upload relations and the Form Builder plugin.

We recommend all users upgrade to v2.16.0, especially if you:

• Use GraphQL for file uploads with relations
• Use the Form Builder plugin with custom hook overrides
• Want more control over your admin UI list views

The upgrade should be straightforward with no breaking changes reported. Simply update your Payload CMS dependency to version 2.16.0:

npm install [email protected]
# or
yarn add [email protected]

Bug Fixes

GraphQL Upload Relations Fix

Fixed an issue where GraphQL upload relations were incorrectly returning null. This ensures that when using GraphQL to upload files with relation fields, the relations are properly maintained and returned in the response.

UI Consistency Improvements

Resolved an issue where drag handles were still visible in the admin UI even when a collection was configured with admin.isSortable: false. The drag handles are now properly hidden when sorting is disabled, providing a more consistent user experience.

Form Builder Plugin Fixes

Addressed a bug in the Form Builder plugin where hook overrides were not working as intended. This fix ensures that custom hooks can be properly used to extend and customize form builder functionality.

Documentation Updates

Fixed a broken link in the Cloud plugin documentation that was pointing to the local development guide.

New Features

Enhanced Admin UI Customization

The v2.16.0 release introduces two new field properties that give developers more granular control over the admin interface:

• disableListColumn: When set to true, this prevents a field from appearing as a column in collection list views. This is particularly useful for fields that don't make sense in a tabular format or to simplify the UI by removing less important columns.

• disableListFilter: When set to true, this prevents a field from being used as a filter option in collection list views. This helps streamline the filtering interface by removing fields that aren't useful as filters.

These properties can be added to any field's admin configuration object, giving developers precise control over how fields behave in the admin UI without affecting the underlying data structure.

Security Updates

No security fixes were mentioned in this release.

Performance Improvements

No specific performance improvements were highlighted in this release. The focus was primarily on feature enhancements and bug fixes.

Impact Summary

Payload CMS v2.16.0 brings meaningful improvements to the admin interface customization capabilities while fixing several important bugs. The new field properties (disableListColumn and disableListFilter) give developers more control over how their admin UI presents information, allowing for cleaner and more focused list views.

The bug fixes address issues across different areas of the system:

• GraphQL users will benefit from fixed upload relations
• Admin UI users will see improved consistency with properly hidden drag handles
• Form Builder plugin users will experience correctly functioning hook overrides

This release represents a solid incremental improvement to Payload CMS with no breaking changes, making it a recommended upgrade for all users. The changes primarily impact the developer experience and admin UI, with downstream benefits for content editors working in the system.

Full Release Notes