Payload CMS Release: 2.18.1

Tag Name: v2.18.1

Release Date: 5/16/2024

Payload CMS LogoPayload CMS

Payload CMS is a modern, self-hosted headless content management system built with TypeScript, Node.js, and MongoDB. It's designed specifically for developers who want full control over their content management system while maintaining a powerful admin interface for content editors.

TL;DR

Payload CMS v2.18.1 - Image Cropping Fix

This patch release fixes an issue with image cropping functionality where the x and y values were unintentionally removed in a previous update. The fix restores the explicit crop coordinates needed for proper image manipulation, ensuring that image cropping works as expected in the admin UI.

Highlight of the Release

    • Fixed image cropping functionality by restoring explicit x and y coordinate values
    • Ensures consistent image manipulation behavior across the CMS

Migration Guide

No migration steps are required for this patch release. The fix is backward compatible and restores previously expected behavior.

If you implemented any workarounds to handle missing crop coordinates after updating to v2.18.0, you can now safely remove those workarounds.

Upgrade Recommendations

We recommend all users to upgrade to v2.18.1, especially if you're using image upload fields with cropping functionality. This is a patch release that fixes a regression in image cropping without introducing any breaking changes.

To upgrade:

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

Bug Fixes

Image Cropping Coordinates Restored

This release fixes an issue where the x and y coordinates for image cropping were unintentionally removed in PR #6364. The explicit crop coordinates are now properly included again, ensuring that:

  • Image crops are accurately positioned based on user selections
  • Crop data is correctly saved and retrieved
  • The admin UI properly displays and applies crop selections

This fix ensures that image cropping functionality works as expected and maintains backward compatibility with existing implementations.

New Features

No new features were added in this patch release. This is a bug fix release focused on restoring proper image cropping functionality.

Security Updates

No security fixes were included in this patch release.

Performance Improvements

No specific performance improvements were included in this patch release.

Impact Summary

This patch release addresses a specific regression in image cropping functionality where x and y coordinates were unintentionally removed. The impact is primarily on users who rely on image cropping features within Payload CMS.

The fix ensures that image crops are properly positioned and saved with the correct coordinate data, maintaining the expected behavior for content editors and developers. This release is particularly important for sites and applications that depend on precise image cropping capabilities.

No other changes or features were included in this release, making it a focused bug fix update with minimal risk.

Full Release Notes

Statistics:

File Changed5
Line Additions12
Line Deletions3
Line Changes15
Total Commits4

User Affected:

  • Can now properly use image cropping functionality with accurate x and y coordinates
  • Will experience more reliable and predictable image cropping results

Contributors:

denolfe