Image: Reimplement lightbox trigger as a minimal button in corner of image #55212
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -103,12 +103,10 @@ store( | |
| context.core.image.lastFocusedElement = | ||
| window.document.activeElement; | ||
| context.core.image.scrollDelta = 0; | ||
| context.core.image.pointerType = event.pointerType; | ||
|
|
||
| context.core.image.lightboxEnabled = true; | ||
| setStyles( context, context.core.image.imageRef ); | ||
|
|
||
| context.core.image.scrollTopReset = | ||
| window.pageYOffset || | ||
|
|
@@ -137,7 +135,7 @@ store( | |
| false | ||
| ); | ||
| }, | ||
| hideLightbox: async ( { context, event } ) => { | ||
| context.core.image.hideAnimationEnabled = true; | ||
| if ( context.core.image.lightboxEnabled ) { | ||
| // We want to wait until the close animation is completed | ||
|
|
@@ -154,9 +152,16 @@ store( | |
| }, 450 ); | ||
|
|
||
| context.core.image.lightboxEnabled = false; | ||
|
|
||
| // We want to avoid drawing attention to the button | ||
| // after the lightbox closes for mouse and touch users. | ||
| // Note that the `event.pointerType` property returns | ||
| // as an empty string if a keyboard fired the event. | ||
| if ( event.pointerType === '' ) { | ||
| context.core.image.lastFocusedElement.focus( { | ||
| preventScroll: true, | ||
| } ); | ||
| } | ||
| } | ||
| }, | ||
| handleKeydown: ( { context, actions, event } ) => { | ||
|
|
@@ -191,11 +196,12 @@ store( | |
| } | ||
| } | ||
| }, | ||
| // This is fired just by lazily loaded | ||
| // images on the page, not all images. | ||
| handleLoad: ( { context, effects, ref } ) => { | ||
| context.core.image.imageLoaded = true; | ||
| context.core.image.imageCurrentSrc = ref.currentSrc; | ||
| effects.core.image.setButtonStyles( { | ||
| context, | ||
| ref, | ||
| } ); | ||
|
|
@@ -258,17 +264,14 @@ store( | |
| effects: { | ||
| core: { | ||
| image: { | ||
| initOriginImage: ( { context, ref } ) => { | ||
| context.core.image.imageRef = ref; | ||
| if ( ref.complete ) { | ||
| context.core.image.imageLoaded = true; | ||
| context.core.image.imageCurrentSrc = ref.currentSrc; | ||
| } | ||
| }, | ||
| initLightbox: async ( { context, ref } ) => { | ||
| if ( context.core.image.lightboxEnabled ) { | ||
| const focusableElements = | ||
| ref.querySelectorAll( focusableSelectors ); | ||
|
|
@@ -279,10 +282,17 @@ store( | |
| focusableElements.length - 1 | ||
| ]; | ||
|
|
||
| // We want to avoid drawing unnecessary attention to the close | ||
| // button for mouse and touch users. Note that even if opening | ||
| // the lightbox via keyboard, the event fired is of type | ||
| // `pointerEvent`, so we need to rely on the `event.pointerType` | ||
| // property, which returns an empty string for keyboard events. | ||
| if ( context.core.image.pointerType === '' ) { | ||
| ref.querySelector( '.close-button' ).focus(); | ||
| } | ||
|
Comment on lines
+285
to
+292
There was a problem hiding this comment. Why don't we want to focus the close button when opening the button by clicking the image? Right now, it keeps the active element outside of the modal, which I believe is not correct, right? There was a problem hiding this comment. That was a point brought up some folks from design a while back — they did not want a close button at all because they felt it would distract and be unnecessary. I figured adding this so the focus ring doesn't become visible and draw attention to the close button would be a good move. Personally I would prefer to not have my attention immediately drawn to a close button when trying to get a better view of an image. There was a problem hiding this comment. There are potential accessibility issues here, though. The context would indeed be incorrect for folks who activate the lightbox using a mouse while also using a screen reader. Is this a use case we should handle? I'm currently searching Google for guidance around this, and will also ping @afercia @joedolson @alexstine for feedback. There was a problem hiding this comment. The problem is that with that approach we are losing the focus and it is causing some issues. When opening an image by clicking on it:
|
||
| } | ||
| }, | ||
| setButtonStyles: ( { context, ref } ) => { | ||
| const { | ||
| naturalWidth, | ||
| naturalHeight, | ||
|
|
@@ -291,54 +301,71 @@ store( | |
| } = ref; | ||
|
|
||
| // If the image isn't loaded yet, we can't | ||
| // calculate where the button should be. | ||
| if ( naturalWidth === 0 || naturalHeight === 0 ) { | ||
| return; | ||
| } | ||
|
|
||
| const figure = ref.parentElement; | ||
| const figureWidth = ref.parentElement.clientWidth; | ||
|
|
||
| // We need special handling for the height because | ||
| // a caption will cause the figure to be taller than | ||
| // the image, which means we need to account for that | ||
| // when calculating the placement of the button in the | ||
| // top right corner of the image. | ||
| let figureHeight = ref.parentElement.clientHeight; | ||
| const caption = figure.querySelector( 'figcaption' ); | ||
| if ( caption ) { | ||
| const captionComputedStyle = | ||
| window.getComputedStyle( caption ); | ||
| figureHeight = | ||
| figureHeight - | ||
| caption.offsetHeight - | ||
| parseFloat( captionComputedStyle.marginTop ) - | ||
| parseFloat( captionComputedStyle.marginBottom ); | ||
| } | ||
|
|
||
| const buttonOffsetTop = figureHeight - offsetHeight; | ||
| const buttonOffsetRight = figureWidth - offsetWidth; | ||
|
|
||
| // In the case of an image with object-fit: contain, the | ||
| // size of the <img> element can be larger than the image itself, | ||
| // so we need to calculate where to place the button. | ||
| if ( context.core.image.scaleAttr === 'contain' ) { | ||
| // Natural ratio of the image. | ||
| const naturalRatio = naturalWidth / naturalHeight; | ||
| // Offset ratio of the image. | ||
| const offsetRatio = offsetWidth / offsetHeight; | ||
|
|
||
| if ( naturalRatio >= offsetRatio ) { | ||
| // If it reaches the width first, keep | ||
| // the width and compute the height. | ||
| const referenceHeight = | ||
| offsetWidth / naturalRatio; | ||
| context.core.image.imageButtonTop = | ||
| ( offsetHeight - referenceHeight ) / 2 + | ||
| buttonOffsetTop + | ||
| 10; | ||
| context.core.image.imageButtonRight = | ||
| buttonOffsetRight + 10; | ||
| } else { | ||
| // If it reaches the height first, keep | ||
| // the height and compute the width. | ||
| const referenceWidth = | ||
| offsetHeight * naturalRatio; | ||
| context.core.image.imageButtonTop = | ||
| buttonOffsetTop + 10; | ||
| context.core.image.imageButtonRight = | ||
| ( offsetWidth - referenceWidth ) / 2 + | ||
| buttonOffsetRight + | ||
| 10; | ||
| } | ||
| } else { | ||
| context.core.image.imageButtonTop = | ||
| buttonOffsetTop + 10; | ||
| context.core.image.imageButtonRight = | ||
| buttonOffsetRight + 10; | ||
| } | ||
| }, | ||
| setStylesOnResize: ( { state, context, ref } ) => { | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same as with the close button: if we navigate to a lightbox with the keyboard, but I close it using a click, I lose the focus, which I assume is not correct, right?