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

Help modal dialog: inaccurate description for the Insert link keyboard shortcut #54148

Open
afercia opened this issue Sep 4, 2023 · 1 comment
Labels
[Focus] Accessibility (a11y) Changes that impact accessibility and need corresponding review (e.g. markup changes). [Package] Edit Post /packages/edit-post [Package] Edit Site /packages/edit-site [Package] Edit Widgets /packages/edit-widgets [Type] Bug An existing feature does not function as intended

Comments

@afercia
Copy link
Contributor

afercia commented Sep 4, 2023

Description

Noticed while looking into #51737

In the Keyboard shortcuts modal dialog, the description for the Ctrl/Cmd+k shortcut is:

Convert the selected text into a link.

That's inaccurate. The shortcut works also without a selection, when the cursor is within any block with text. It works also when the cursor isn't inside any text and it's actially in an empty space. That's how it always worked in WordPress since ages. There are good reasons for this behavior, as it provides users with more flexibility.

However, the current description actually hides how this feature works and it's misleading. It doesn't help with discoverability. The descritpion should be simpler and mroe generic, to match the actual behavior:

  • No text selection is required to add a link.
  • Links can be added also to other elements, for example an inline image within a paragraph block. The description only mentions text so it's inaccurate and pointlessy too specific.

Step-by-step reproduction instructions

  • Go to the Post Editor > Options > Keyboard shortcuts
  • The Keyboard shortcuts modal dialog opens.
  • Observe the description of the Ctrl/Cmd+k keyboard shortcut within the section 'Text formatting'.

Screenshots, screen recording, code snippet

Screenshot 2023-09-04 at 10 11 53

Environment info

No response

Please confirm that you have searched existing issues in the repo.

Yes

Please confirm that you have tested with all plugins deactivated except Gutenberg.

Yes

@afercia afercia added [Type] Bug An existing feature does not function as intended [Focus] Accessibility (a11y) Changes that impact accessibility and need corresponding review (e.g. markup changes). [Package] Edit Post /packages/edit-post [Package] Edit Widgets /packages/edit-widgets [Package] Edit Site /packages/edit-site labels Sep 4, 2023
@t-hamano
Copy link
Contributor

t-hamano commented Sep 5, 2023

For reference, the Classic Editor explains it as Insert/edit link (Ctrl+K). How about Insert or edit a link. etc.?

classic-editor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Focus] Accessibility (a11y) Changes that impact accessibility and need corresponding review (e.g. markup changes). [Package] Edit Post /packages/edit-post [Package] Edit Site /packages/edit-site [Package] Edit Widgets /packages/edit-widgets [Type] Bug An existing feature does not function as intended
Projects
None yet
Development

No branches or pull requests

2 participants