AGENTS.md

July 27, 2026 ยท View on GitHub

Status

This package contains UI components that are intended to be used anywhere in a general way (global), or specifically in the block editor.

We are currently in the process of rewriting the global components to be in the new @wordpress/ui package. Refer to the use-recommended-components ESLint rule for guidance on which components to use.

For components not explicitly listed in the use-recommended-components rule, locate the component's Storybook source within this package and use its status guidance. This guidance is more authoritative than the experimental tag or component prefix.

Forms

Is the form going to edit items of a dataset, rather than simply submitting data somewhere? If so, consider using DataForm from the @wordpress/dataviews package.

For adding validation, consider using the Validated Form Components.

Storybook

Don't forget to check a component's Storybook documentation for additional usage guidance. The Storybook links (public base URL) are also useful to present to a human when they are asking for help with a component.