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.

Sign up for GitHub

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: avoid key to focus caption #25493

Merged
merged 1 commit into from
Sep 21, 2020
Merged

Image block: avoid key to focus caption #25493

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 1 addition & 5 deletions packages/block-library/src/image/edit.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,14 +272,10 @@ export function ImageEdit( {
[ `size-${ sizeSlug }` ]: sizeSlug,
} );

// Focussing the image caption after inserting an image relies on the
// component remounting. This needs to be fixed.
const key = !! url;

return (
<>
{ controls }
<Block.figure ref={ ref } className={ classes } key={ key }>
<Block.figure ref={ ref } className={ classes }>
{ url && (
<Image
attributes={ attributes }
Expand Down
17 changes: 15 additions & 2 deletions packages/block-library/src/image/image.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import {
ToolbarGroup,
ToolbarButton,
} from '@wordpress/components';
import { useViewportMatch } from '@wordpress/compose';
import { useViewportMatch, usePrevious } from '@wordpress/compose';
import { useSelect, useDispatch } from '@wordpress/data';
import {
BlockControls,
Expand All @@ -28,7 +28,7 @@ import {
__experimentalImageURLInputUI as ImageURLInputUI,
MediaReplaceFlow,
} from '@wordpress/block-editor';
import { useEffect, useState } from '@wordpress/element';
import { useEffect, useState, useRef } from '@wordpress/element';
import { __, sprintf } from '@wordpress/i18n';
import { getPath } from '@wordpress/url';
import { createBlock } from '@wordpress/blocks';
Expand Down Expand Up @@ -80,6 +80,8 @@ export default function Image( {
onUploadError,
containerRef,
} ) {
const captionRef = useRef();
const prevUrl = usePrevious( url );
const image = useSelect(
( select ) => {
const { getMedia } = select( 'core' );
Expand Down Expand Up @@ -142,6 +144,16 @@ export default function Image( {
.then( ( blob ) => setExternalBlob( blob ) );
}, [ id, url, isSelected, externalBlob ] );

// Focus the caption after inserting an image from the placeholder. This is
// done to preserve the behaviour of focussing the first tabbable element
// when a block is mounted. Previously, the image block would remount when
// the placeholder is removed. Maybe this behaviour could be removed.
useEffect( () => {
if ( url && ! prevUrl && isSelected ) {
captionRef.current.focus();
}
}, [ url, prevUrl ] );
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I understand now, thanks for the separate PR. I think this implementation is better but I wonder if focusing the block (the container) is actually better after selecting an image.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe @jasmussen has ideas.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you walk me through the challenge?

This is what I see in the shipping product:

before

This is what I see in this branch:

after

They seem the same, and seem okay to me. There's a piece I'm missing.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@youknowriad To be honest, I would love if we focus the container instead. This makes much more sense to be and it's something I've proposed before as a general behaviour (focus container, and if it's editable it automatically sets the caret).
@jasmussen No behaviour change to master in the branch. The question is if the placeholder => image focus change to caption is good.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are we ok with merging this PR in the meantime?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The focus-the-container vs. focus-the-caption-field sounds like a good accessibility question. Pinging @afercia to check this out.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the ping. To my understanding there's no practical change to the keyboard interaction, right? @ellatrix

On a side note: I think we discussed but never established a good principle for the "initial focus" on the blocks. Generally, setting focus on a place that makes great part of the block UI "skipped" isn't ideal. Not to mention that The image block isn't fully operable with keyboard yet. For exampe, I can't find a way to move focus to the caption toolbar.


function onResizeStart() {
toggleSelection( false );
}
Expand Down Expand Up @@ -486,6 +498,7 @@ export default function Image( {
{ img }
{ ( ! RichText.isEmpty( caption ) || isSelected ) && (
<RichText
ref={ captionRef }
tagName="figcaption"
placeholder={ __( 'Write caption…' ) }
value={ caption }
Expand Down