Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Image block: Revise lightbox UI to remove 'behaviors' #53851

Merged
merged 20 commits into from
Sep 15, 2023

Commits on Aug 21, 2023

  1. Configuration menu
    Copy the full SHA
    08bb1ed View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    c93f1b6 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    25aa1c6 View commit details
    Browse the repository at this point in the history
  4. Restructured use of global behaviors

    Simplified the `__experimentalUseGlobalBehaviors` function by removing the 'source' parameter. Now, the function directly uses 'userConfig' for getting raw data and 'mergedConfig' for variable value.
    michalczaplinski committed Aug 21, 2023
    Configuration menu
    Copy the full SHA
    a8c09c9 View commit details
    Browse the repository at this point in the history

Commits on Aug 28, 2023

  1. Configuration menu
    Copy the full SHA
    fac2e3a View commit details
    Browse the repository at this point in the history
  2. Remove the reference to behaviors in Global styles and first iteratio…

    …n of updates to the lightbox UI
    michalczaplinski committed Aug 28, 2023
    Configuration menu
    Copy the full SHA
    dfc1c46 View commit details
    Browse the repository at this point in the history

Commits on Aug 29, 2023

  1. Configuration menu
    Copy the full SHA
    51e4802 View commit details
    Browse the repository at this point in the history

Commits on Aug 30, 2023

  1. Configuration menu
    Copy the full SHA
    b416558 View commit details
    Browse the repository at this point in the history
  2. Adjust schema properties count assertion

    Previously, the test was checking whether schema properties array had exactly 10 elements
    We're now checking for exactly 9 elements instead.
    michalczaplinski committed Aug 30, 2023
    Configuration menu
    Copy the full SHA
    321a213 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    0021116 View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    6951a86 View commit details
    Browse the repository at this point in the history

Commits on Sep 6, 2023

  1. Configuration menu
    Copy the full SHA
    92b084f View commit details
    Browse the repository at this point in the history

Commits on Sep 7, 2023

  1. Configuration menu
    Copy the full SHA
    232161a View commit details
    Browse the repository at this point in the history
  2. Do not remove behaviors attribute from Image block's block.json.

    Behaviors are deprecated for 2 more releases and will be removed then.
    michalczaplinski committed Sep 7, 2023
    Configuration menu
    Copy the full SHA
    cabe31b View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    aa4450e View commit details
    Browse the repository at this point in the history

Commits on Sep 11, 2023

  1. Configuration menu
    Copy the full SHA
    91b86ef View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    f9e48f4 View commit details
    Browse the repository at this point in the history

Commits on Sep 14, 2023

  1. Configuration menu
    Copy the full SHA
    8b95f4a View commit details
    Browse the repository at this point in the history

Commits on Sep 15, 2023

  1. Image block: UI updates for the image lightbox (#54071)

    * Add initial implementation of image settings panel
    
    * Remove unnecessary code and fix reset functionality
    
    * Add UI to image block inspector
    
    * Add `lightbox` to the valid `theme.json` settings
    
    * Fix a bug with image selector and integrate with global styles
    
    * Update `theme.json` schema
    
    * Added the `@since`annotation
    
    * Refactor image settings panel and screen block
    
    Simplified the ImageSettingsPanel and ScreenBlock components. More specific changes:
     - Removed `name` and `settings` from the ImageSettingsPanel
     - Use `userSettings` instead of `settings` in the ImageSettingsPanel
     - Modified `onChangeLightbox` logic, it now takes a new setting instead of a boolean and directly passes to `onChange`
     - Updated the ScreenBlock component to account for this refactor
    
    * Add showUI option to lightbox settings
    
    A new option has been added to the lightbox settings in the Theme JSON reference guide and Gutenberg class. This `showUI` option allows users to toggle whether the Lightbox UI is displayed in the block editor or not. Also, updated the JSON schema accordingly to reflect these changes in theme.json files.
    
    * Add defaults for the `lightbox` to the GB `theme.json`
    
    * Change the falsy checks in image.js
    
    * Add filters; add legacy support for behaviors syntax
    
    I moved the logic to determine whether the lightbox should display
    or not to two render_block_data filters.
    
    One of these filters is inside of the index.php
    so that itc can exist in WP core, the other inside of blocks.php
    in order to offer legacy support for the Behaviors syntax in
    the Gutenberg plugin.
    
    Using the render_block_data instead of render_block allows us to
    store a 'lightboxEnabled' value on the block, which we can use to
    determine whether the lightbox should be rendered in these two
    separate locations relatively cleanly without needing to touch
    the markup.
    
    I added behaviors back to the valid top-level keys so that we can
    read it to offer legacy support.
    
    Lastly, I set the lightbox.enabled attribute to NULL by default
    so that we can determine whether the Behaviors syntax should override
    it or not.
    
    * Fix linter errors & add more expansive comments.
    
    * If no value is set for the lightbox in the Global Styles, then the block editor UI should inherit the value from `theme.json`.
    
    Likewise, if no value is set in the block attributes, the block editor UI should inherit the value from the Global Styles of the Image.
    
    * Rename `showUI` to `allowEditing`
    
    * Fix the `theme.json` schema
    
    * Use the globalPath for the settings on the PHP side
    
    * Add backwards support for enabling fade animation via the legacy syntax
    
    * Fix PHP linter errors
    
    * Fix error when checking lightbox['enabled'] value in global settings
    
    * Empty commit
    
    * Remove the default `false` value for `lightbox.enabled`attribute.
    
    * Add deprecation notice for 'behaviors' in image block
    
    I needed to add 'behaviors' back to the block.json attributes
    in order to read them on the JavaScript side in the editor
    to fire the deprecation notice.
    
    * Add deprecation for  attribute in image block
    
    * Remove obsolete code now that block deprecation is in place
    
    * Add support for 'lightbox: true' syntax
    
    * Fix lightbox 'checked' attribute being read improperly
    
    * Add conditional display for settings panel at image block level
    
    * Fix an error with the theme.json schema.
    
    * Update docs with `npm run build:docs`
    
    * Copy `class-wp-theme-json-schema.php` from core
     into `class-wp-theme-json-schema-gutenberg.php`
    
    * Add a theme.json migration to v3 away from behaviors and to a new, simpler syntax used by the lightbox.
    
    * Remove the `null` value from lightbox.enabled in `lib/theme.json`
    
    * Remove `behaviors` from VALID_TOP_LEVEL_KEYS & VALID_SETTINGS
    
    * Revise backwards compatibility for behaviors; add deprecation to block_supports
    
    * Remove outdated comment
    
    * Update outdated comment
    
    * Update comment and shuffle the lines so the diff is easier on the eyes.
    
    * Update comment to explain why we use userSettings in image-settings-panel.js
    
    * Remove support for legacy fade configuration
    
    * Resolve lint error
    
    * Add clarifying comment regarding lightbox markup
    
    * Rename the migrate function to reflect that it's not a v3 migration
    
    * Add a `@since` in `gutenberg_should_render_lightbox` docblock
    
    * Add support for reading top-level 'lightbox' setting in editor
    
    By default, we read the lightbox settings underneath the 'core/image'
    in theme.json; however, the 'enabled' property there is undefined by default,
    which means it should be possible to declare a top-level setting for the lightbox
    that overrides an undefined block-level setting.
    
    While this appeared to be working on the PHP side, the UI wasn't accurately
    reflecting this inheritance structure, so this commit fixes that.
    
    Users should now be able to define a top-level lightbox setting as either
    'lightbox: true' or 'lightbox: { enabled: true }' that will be used
    if the block-level lightbox setting for 'enabled' is undefined.
    
    * Revert "Add support for reading top-level 'lightbox' setting in editor"
    
    This reverts commit 2f5f122.
    
    * Add correct deprecation mentioning the Gutenberg version
    
    * Move 'allowEditing' to top-level settings
    
    * Fix top-level lightbox setting not being read properly
    
    * Fix 'false' values in theme.json not being stored in settings object
    
    * Fix error wherein 'undefined' was being passed to input component
    
    * Fix bug wherein lightbox UI would disappear if user value was set
    
    * Remove inheritance when determining whether to enable lightbox
    
    Rather than trying to check if the 'enabled' has been set or not
    and falling back to other levels of the theme.json inheritance
    structure, I decided to just read and use the settings as defined
    in theme.json. This is the expected behavior in Gutenberg from
    what I understand and has less edge cases.
    
    * Update comment
    
    * Update whitespace in theme.json
    
    Co-authored-by: Alex Lende <alex+github.com@lende.xyz>
    
    * Add docblocks to clarify that `class-wp-theme-json-schema-gutenberg.php` is only put in GB as a temporary migration.
    
    * Add comments to clarify that behaviors.php is temporarily added to GB an will be removed in a future version.
    
    * Added integration fixtures for the lightbox
    
    * Fix incorrect reading of global lightbox settings
    
    * Clarify the comment getting the global lightbox settings
    
    * Fix PHPCS parenthesis error 🤦‍♂️
    
    * Move lightbox settings to the block level
    
    * Remove support for shorthand
    
    * Remove 'lightbox' from hooks.js and add `.enabled` & `.allowEditing` to class-wp-theme-json-gutenberg.php
    
    ---------
    
    Co-authored-by: Michal Czaplinski <mmczaplinski@gmail.com>
    Co-authored-by: Alex Lende <alex+github.com@lende.xyz>
    3 people authored Sep 15, 2023
    Configuration menu
    Copy the full SHA
    1b3a480 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    ef8c396 View commit details
    Browse the repository at this point in the history