close
Skip to content

Admin UI: add documentation#76484

Open
simison wants to merge 2 commits intotrunkfrom
update/admin-ui-docs
Open

Admin UI: add documentation#76484
simison wants to merge 2 commits intotrunkfrom
update/admin-ui-docs

Conversation

@simison
Copy link
Member

@simison simison commented Mar 13, 2026

Related to adding Storybook:

What?

Closes

Documents Admin UI package APIs.

Why?

Makes adopting Page componentry easier outside Gutenberg.

How?

  • Very basic documentation of available props and how different components work together.

Testing Instructions

Read the rendered README.md

Testing Instructions for Keyboard

Screenshots or screencast

Before After

Use of AI Tools

@simison simison added the [Package] Admin UI /packages/admin-ui label Mar 13, 2026
@github-actions
Copy link

Warning: Type of PR label mismatch

To merge this PR, it requires exactly 1 label indicating the type of PR. Other labels are optional and not being checked here.

  • Required label: Any label starting with [Type].
  • Labels found: [Package] Admin UI.

Read more about Type labels in Gutenberg. Don't worry if you don't have the required permissions to add labels; the PR reviewer should be able to help with the task.

2 similar comments
@github-actions
Copy link

Warning: Type of PR label mismatch

To merge this PR, it requires exactly 1 label indicating the type of PR. Other labels are optional and not being checked here.

  • Required label: Any label starting with [Type].
  • Labels found: [Package] Admin UI.

Read more about Type labels in Gutenberg. Don't worry if you don't have the required permissions to add labels; the PR reviewer should be able to help with the task.

@github-actions
Copy link

Warning: Type of PR label mismatch

To merge this PR, it requires exactly 1 label indicating the type of PR. Other labels are optional and not being checked here.

  • Required label: Any label starting with [Type].
  • Labels found: [Package] Admin UI.

Read more about Type labels in Gutenberg. Don't worry if you don't have the required permissions to add labels; the PR reviewer should be able to help with the task.

Comment on lines +15 to +25
## Stylesheet Dependencies

AdminUI depends on stylesheets `@wordpress/theme`. In a WordPress admin page context, these are loaded automatically. For applications outside WordPress, you will need to include this stylesheet:

```bash
npm install @wordpress/theme
```

```tsx
import '@wordpress/theme/design-tokens.css';
```
Copy link
Member Author

@simison simison Mar 13, 2026

Choose a reason for hiding this comment

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

Copy link
Member

Choose a reason for hiding this comment

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

These stylesheet instructions are not necessarily accurate at the moment (in @wordpress/ui and @wordpress/dataviews readmes too) so I'm going to prepare a better one.

@github-actions
Copy link

github-actions bot commented Mar 13, 2026

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: simison <simison@git.wordpress.org>
Co-authored-by: mirka <0mirka00@git.wordpress.org>
Co-authored-by: youknowriad <youknowriad@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
Copy link

Flaky tests detected in 4438ff8.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/23046214263
📝 Reported issues:

@jameskoster jameskoster requested a review from youknowriad March 13, 2026 12:41
## API
_This package assumes that your code will run in an **ES2015+** environment. If you're using an environment that has limited or no support for such language features and APIs, you should include [the polyfill shipped in `@wordpress/babel-preset-default`](https://github.com/WordPress/gutenberg/tree/HEAD/packages/babel-preset-default#polyfill) in your code._

<!-- START TOKEN(Autogenerated API docs) -->
Copy link
Contributor

Choose a reason for hiding this comment

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

Why did we remove the automatic docs generation, should we keep it and add all this information as comments (so it gets included here)

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

Labels

[Package] Admin UI /packages/admin-ui

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants