Add new photoswipe global settings to the settings page

Created on 11 October 2023, about 1 year ago
Updated 30 October 2023, about 1 year ago

Problem/Motivation

There are new photoswipe settings!

Please add a few to the settings page:

Make sure, that we adjust our min library version requirement to "5.4.1" (this is where "trapFocus" got introduced) and update any code requiring the library to use the newest 5.4.2 version.

Steps to reproduce

Proposed resolution

Remaining tasks

User interface changes

API changes

Data model changes

📌 Task
Status

Fixed

Version

5.0

Component

Code

Created by

🇩🇪Germany Grevil

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

  • Issue created by @Grevil
  • 🇩🇪Germany Anybody Porta Westfalica

    @Grevil: Please always add information about
    - Field type (checkbox, textfield, ...)
    - Default value
    - Required?

    With this to make implementation easier and faster. :) Saves time and mistakes.

  • 🇩🇪Germany Grevil

    Only the three zoom level configs should be required.
    Setting the correct field types should be no problem, and the default values are documented.

  • First commit to issue fork.
  • @lrwebks opened merge request.
  • Status changed to Needs review about 1 year ago
  • 🇩🇪Germany lrwebks Porta Westfalica

    Done with this one! I also updated the settings test to check the four new settings!
    On the page Adjusting Zoom Level I got a bit lost. I assume you meant the two zoom level attributes not yet implemented (Initial, Secondary)?
    Please review!

  • Issue was unassigned.
  • Status changed to RTBC about 1 year ago
  • 🇩🇪Germany Anybody Porta Westfalica

    Looks fine to me. @LRWebks I left a little comment for you.

  • Assigned to lrwebks
  • Status changed to Needs work about 1 year ago
  • 🇩🇪Germany Anybody Porta Westfalica

    Ah sorry! The update hook for existing installations is missing entirely. Missed that.

  • Status changed to Needs review about 1 year ago
  • 🇩🇪Germany lrwebks Porta Westfalica

    Added the update hook. Should be done now, so back to review it is!

  • Status changed to Needs work about 1 year ago
  • 🇩🇪Germany Anybody Porta Westfalica

    Nice!! Just code style comment

  • Assigned to Grevil
  • Status changed to Needs review about 1 year ago
  • 🇩🇪Germany Anybody Porta Westfalica

    LGTM!
    @Grevil if you agree, please merge!

  • Assigned to lrwebks
  • Status changed to Needs work about 1 year ago
  • 🇩🇪Germany Grevil

    Please search through the whole module, where older version of the js library might be used!

    E.g.:

    
                    "dist": {
                        "url": "https://github.com/dimsemenov/PhotoSwipe/archive/v5.3.8.zip",
    

    in the composer.json or

    public $photoswipeMinPluginVersion = '5.2.1';
    

    in "PhotoswipeAssetsManager".

    See issue summary:

    Make sure, that we adjust our min library version requirement to "5.4.1" (this is where "trapFocus" got introduced) and update any code requiring the library to use the newest 5.4.2 version.

    Furthermore, we should adjust the minimum version requirement on the module page and implement an empty update hook, which simply displays a message to the user, that he should update the js library. Something along the lines of:

    /**
     * A new setting was introduced please update the photoswipe js library to xxx.
     */
    function MY_MODULE_update_xxxx() {
    
    }
    
  • Assigned to Anybody
  • 🇩🇪Germany Grevil

    This might be a bit much for introducing settings, we might not actually use. @Anybody should decide whether to work on this issue or to postpone it for now.

  • Assigned to lrwebks
  • 🇩🇪Germany Anybody Porta Westfalica

    @Grevil: This seems close to be finished, so I'd suggest @LRWebks finishes the changes but we don't merge it too soon?
    Updating the library regularly makes sense anyway, also for other fixes. I guess an older library won't break things, the options just won't work (as they are not existing on the library end).

  • 🇩🇪Germany Grevil

    I guess an older library won't break things, the options just won't work

    Depends on the implementation! A js error will be thrown at least, which generally should be avoided!

  • 🇩🇪Germany Anybody Porta Westfalica

    A js error will be thrown at least

    That would be a problem, I had expected that if adding the further values to the options array, nothing happens, if the library doesn't know these.

    Still I think LRWebks should finish this and then we can take a deeper look.

  • Status changed to Needs review about 1 year ago
  • 🇩🇪Germany lrwebks Porta Westfalica

    Updated all the version requirements within the module and also implemented a small warning within the update hook to notify people with manually installed libraries that they need to update, just like some older update hooks did as well.
    I think this is done so far!

  • Assigned to Grevil
  • 🇩🇪Germany Anybody Porta Westfalica

    @Grevil could you take a look by time?

  • Assigned to lrwebks
  • Status changed to Needs work about 1 year ago
  • 🇩🇪Germany Grevil

    Made a few comments, otherwise LGTM! 🎉

  • Status changed to Needs review about 1 year ago
  • 🇩🇪Germany lrwebks Porta Westfalica

    Done again! :)

  • 🇩🇪Germany Grevil

    Great work @LRWebks! Just one minor addition, I forgot to comment on!

    I'll actually merge this, as most people will either use cdn or require the photoswipe js library via composer and both will update automatically. And the 2% manually downloading the js library have a perfectly fine update message AND log message. So yea RTBC!

  • Status changed to RTBC about 1 year ago
  • Issue was unassigned.
  • Status changed to Fixed about 1 year ago
  • Automatically closed - issue fixed for 2 weeks with no activity.

Production build 0.71.5 2024