Skip to content

Added readme for keyboard shortcut - #69462

Open
vk17-starlord wants to merge 1 commit into
WordPress:trunkfrom
vk17-starlord:keyboard-shortcut-component
Open

vk17-starlord wants to merge 1 commit into
WordPress:trunkfrom
vk17-starlord:keyboard-shortcut-component

Conversation

@vk17-starlord

Copy link
Copy Markdown
Contributor

PR Description

What?
Closes Issue #52063

This PR adds a README.md file for the keyboard-shortcuts component in the Gutenberg project.

Why?
The keyboard-shortcuts component was missing a README.md file, which is crucial for providing documentation and clarity on the component's purpose and usage.

How?

  • Created a new README.md file for the keyboard-shortcuts component.
  • Detailed the KeyboardShortcuts component, including its usage, available shortcuts, and implementation.
  • Followed the structure and content style of the alignment-control README as a reference.

Testing Instructions

  1. Navigate to the keyboard-shortcuts component directory.
  2. Ensure the new README.md file is present and contains relevant information about the component.
  3. Review the content to verify it aligns with Gutenberg documentation standards.

Testing Instructions for Keyboard

  • Navigate through the documentation using keyboard shortcuts to ensure accessibility.

@vk17-starlord
vk17-starlord requested a review from ellatrix as a code owner March 6, 2025 09:01
@github-actions

github-actions Bot commented Mar 6, 2025

Copy link
Copy Markdown

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: vk17-starlord <vineet2003@git.wordpress.org>
Co-authored-by: mburridge <mburridge@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@Mamaduka Mamaduka added the [Type] Developer Documentation Documentation for developers label Mar 6, 2025

_Note:_ The `KeyboardShortcuts` component should be rendered within a `BlockEditorProvider`.

### Available Shortcuts

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Can we avoid listing all the shortcuts because it might become outdated quickly.

- **Focus Toolbar** (`Alt + F10`): Navigate to nearest toolbar
- **List View Collapse** (`Alt + L`): Collapse all other items in list view

### Implementation

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This is implementation details and I don't think it's useful in a README.

});
```

### Categories

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Same not needed.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

[Type] Developer Documentation Documentation for developers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add README.md file for keyboard-shortcuts component

3 participants