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

Fix variable name in color directive example for Interactivity API #62912

Conversation

airman5573
Copy link
Contributor

@airman5573 airman5573 commented Jun 27, 2024

What?

This PR corrects a variable name in the color directive example code for the Interactivity API.

Why?

The current example code contains a minor error where 'color' is used instead of 'colors' in the destructured parameter. This could lead to confusion for developers trying to implement the color directive. By fixing this, I ensure that the documentation accurately reflects the correct usage of the API.

How?

The implementation involves a simple change in the example code:

  • Changed { directives: { color } } to { directives: { color: colors } } in the destructured parameter of the directive function.
  • Path is packages/interactivity/src/hooks.tsx line 234.

Testing Instructions

Testing Instructions for Keyboard

Screenshots or screencast

- Change 'color' to 'colors' in destructured parameter of example code
- Update ensures the example code accurately demonstrates correct usage
Copy link

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.

Unlinked Accounts

The following contributors have not linked their GitHub and WordPress.org accounts: @byeongin@shoplic.kr.

Contributors, please read how to link your accounts to ensure your work is properly credited in WordPress releases.

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

Unlinked contributors: byeongin@shoplic.kr.


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

@github-actions github-actions bot added the First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository label Jun 27, 2024
Copy link

👋 Thanks for your first Pull Request and for helping build the future of Gutenberg and WordPress, @airman5573! In case you missed it, we'd love to have you join us in our Slack community.

If you want to learn more about WordPress development in general, check out the Core Handbook full of helpful information.

Copy link
Member

@luisherranz luisherranz left a comment

Choose a reason for hiding this comment

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

Good catch!

@luisherranz luisherranz added [Type] Developer Documentation Documentation for developers [Packages] Interactivity /packages/interactivity labels Jun 27, 2024
@luisherranz luisherranz merged commit ea72cf1 into WordPress:trunk Jun 27, 2024
65 of 67 checks passed
@github-actions github-actions bot added this to the Gutenberg 18.8 milestone Jun 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository [Packages] Interactivity /packages/interactivity [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants