v3 Breaking Changes

[igordanchenko]

v3 Breaking Changes

Release 3.0 comes with a number of breaking changes. Please review the items applicable in your case.

Photo album component and CSS stylesheet

v3 provides 4 different components depending on the layout you intend to use. Each component comes with its own CSS stylesheet. CSS stylesheet is not optional!

Rows layout:

import { RowsPhotoAlbum } from "react-photo-album";
import "react-photo-album/rows.css";

Columns layout:

import { ColumnsPhotoAlbum } from "react-photo-album";
import "react-photo-album/columns.css";

Masonry layout:

import { MasonryPhotoAlbum } from "react-photo-album";
import "react-photo-album/masonry.css";

3-in-1:

If you use more than one layout in our app, you may opt for the aggregate component, which bundles all three layouts.

import PhotoAlbum from "react-photo-album";
import "react-photo-album/styles.css";

React version

React 18 is the minimum supported React version.

Node version

Node 18 is the minimum supported Node version.

ESM

The library is now ESM-only.

renderContainer

renderContainer is no longer supported. Use render.container instead.

renderRowContainer

renderRowContainer is no longer supported. Use render.track instead.

renderColumnContainer

renderColumnContainer is no longer supported. Use render.track instead.

renderPhoto

renderPhoto is no longer supported. Use render.image, render.wrapper, render.link, render.button or render.photo instead.

componentsProps.containerProps

componentsProps.containerProps is no longer supported. Use componentsProps.container instead.

componentsProps.rowContainerProps

componentsProps.rowContainerProps is no longer supported. Use componentsProps.track instead.

componentsProps.columnContainerProps

componentsProps.columnContainerProps is no longer supported. Use componentsProps.track instead.

componentsProps.imageProps

componentsProps.imageProps is no longer supported. Use componentsProps.image, componentsProps.wrapper, componentsProps.link or componentsProps.button instead.

Photo images prop

The deprecated images prop is no longer supported. Use srcSet instead.

[github-actions]

🎉 This issue has been resolved in version 3.0.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀