@wordpress/admin-ui

Generic components to be used to build the Admin UI.

Installation

Install the module

npm install @wordpress/admin-ui --save

API

Breadcrumbs

Renders a breadcrumb navigation trail.

All items except the last one must provide a to prop for navigation. In development mode, an error is thrown when a non-last item is missing to. The last item represents the current page and its to prop is optional. Only the last item (when it has no to prop) is rendered as an h1.

Usage

<Breadcrumbs
    items={ [
        { label: 'Home', to: '/' },
        { label: 'Settings', to: '/settings' },
        { label: 'General' },
    ] }
/>

Parameters

• props BreadcrumbsProps:
• props.items BreadcrumbsProps[ 'items' ]: The breadcrumb items to display.

NavigableRegion

Undocumented declaration.

Page

Undocumented declaration.

Contributing to this package

This is an individual package that’s part of the Gutenberg project. The project is organized as a monorepo. It’s made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to npm and used by WordPress as well as other software projects.

To find out more about contributing to this package or Gutenberg as a whole, please read the project’s main contributor guide.