Is there a V4 -> V5 migration guide?

dimsemenov / PhotoSwipe

JavaScript image gallery for mobile and desktop, modular, framework independent

http://photoswipe.com

MIT License

24.18k stars 3.31k forks source link

Is there a V4 -> V5 migration guide? #1929

Open ajssd opened 2 years ago

ajssd commented 2 years ago

Is there a step-by-step migration guide for upgrading from V4 to V5? We have a lot of code developed using V4, following the steps described at https://photoswipe.com/v4-docs/getting-started.html. It'd be great to have a well-documented guide to converting to V5.

dimsemenov commented 2 years ago

There is no step-by-step migration guide, as API significantly changed.

In v5 initialization is simplified - you no longer need to add pswp structure HTML or bind click event manually. So the easiest way is to completely re-write the old initialization.
v4 required a separate JS file for the "UI", this is no longer the case.
Basic events/methods/properties are kept the same.

arnowelzel commented 2 years ago

Update: my WordPress plugin now includes PhotoSwipe 5 offically and the specific branch for that does no longer exist. So just have a look here:

PhotoSwipe 4: https://github.com/arnowelzel/lightbox-photoswipe/blob/main/src/js/frontend.js

PhotoSwipe 5: https://github.com/arnowelzel/lightbox-photoswipe/blob/main/assets/ps5/frontend.js

acwolff commented 2 years ago

The link https://github.com/arnowelzel/lightbox-photoswipe/tree/photoswipe5 gives error 404

arnowelzel commented 2 years ago

@acwolff that's the reason why I added another comment.