admin-ui: Update package README to clarify purpose and distinguish from ui package#76943
admin-ui: Update package README to clarify purpose and distinguish from ui package#76943
Conversation
|
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 If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
youknowriad
left a comment
There was a problem hiding this comment.
Thanks, that's a way better description haha
|
Flaky tests detected in 7283c34. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/23817591743
|
…ckage (#76943) Co-authored-by: aduth <aduth@git.wordpress.org> Co-authored-by: youknowriad <youknowriad@git.wordpress.org> Co-authored-by: ciampo <mciampini@git.wordpress.org>
…ckage (#76943) Co-authored-by: aduth <aduth@git.wordpress.org> Co-authored-by: youknowriad <youknowriad@git.wordpress.org> Co-authored-by: ciampo <mciampini@git.wordpress.org>
What?
Updates
@wordpress/admin-uipackage README description to clarify the purpose of the package and distinguish it from other component packages like@wordpress/uiand@wordpress/components.Why?
To make it clearer what types of code would be expected to belong in this package.
Before these changes, related packages had very similar descriptions which made it difficult for someone to differentiate:
@wordpress/ui: "React UI components for the WordPress Design System, built on themeable design tokens"@wordpress/components: "generic WordPress components to be used for creating common UI elements shared between screens and features of the WordPress dashboard"@wordpress/admin-ui: "Generic components to be used to build the Admin UI"This creates difficulty for both maintainers and consumers:
How?
This has evolved from a few recent discussions about the purpose of the
@wordpress/admin-uipackage and fit for certain components, as well as currentPagecomponent and enhancements supporting page header standardization.Starting from a fundamental question: Why does this package exist? Personally, my view is that it holds value both in how we abstract components, and in what it contains today, which is largely the composition of common admin page layouts. It's a higher level of abstraction than what we expect to exist in
@wordpress/ui, similar to how@wordpress/dataviewscomposes design system components for a functional purpose. This is all in service of the goal to provide a cohesive, predictable experience for users.Testing Instructions
This is documentation-only changes. Review the changes for accuracy.