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

Add component props docs #60350

Merged
merged 3 commits into from Apr 2, 2024
Merged

Conversation

mikeybinns
Copy link
Contributor

What?

Adds documentation around how to get component props the recommended way.

Why?

Fixes #60193
It better showcases the project's preferred method of retrieving component props.

How?

It adds this documentation

Testing Instructions

N/A

Testing Instructions for Keyboard

N/A

Screenshots or screencast

N/A

Copy link

github-actions bot commented Apr 1, 2024

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: mikeybinns <mikeybinns@git.wordpress.org>
Co-authored-by: mirka <0mirka00@git.wordpress.org>
Co-authored-by: rafaucau <rafaucau@git.wordpress.org>

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 Apr 1, 2024
Copy link

github-actions bot commented Apr 1, 2024

👋 Thanks for your first Pull Request and for helping build the future of Gutenberg and WordPress, @mikeybinns! 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.

@mirka mirka self-requested a review April 2, 2024 04:49
@mirka mirka added [Type] Developer Documentation Documentation for developers [Package] Components /packages/components labels Apr 2, 2024
Copy link
Member

@mirka mirka left a comment

Choose a reason for hiding this comment

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

Great, thank you! I just had some stylistic nits for consistency 👍

packages/components/README.md Outdated Show resolved Hide resolved
packages/components/README.md Outdated Show resolved Hide resolved
Co-authored-by: Lena Morita <lena@jaguchi.com>
@mirka mirka enabled auto-merge (squash) April 2, 2024 22:43
@mirka mirka merged commit 1655ed0 into WordPress:trunk Apr 2, 2024
54 of 55 checks passed
@github-actions github-actions bot added this to the Gutenberg 18.1 milestone Apr 2, 2024
@mikeybinns mikeybinns deleted the add-component-props-docs branch April 2, 2024 23:02
cbravobernal pushed a commit to garridinsi/gutenberg that referenced this pull request Apr 9, 2024
* add docs about component props

* Apply suggestions from code review

Co-authored-by: Lena Morita <lena@jaguchi.com>

---------

Co-authored-by: mikeybinns <mikeybinns@git.wordpress.org>
Co-authored-by: mirka <0mirka00@git.wordpress.org>
Co-authored-by: rafaucau <rafaucau@git.wordpress.org>
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 [Package] Components /packages/components [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Components package: Export Props types as Public API
2 participants