Package Exports

@wordpress/components
@wordpress/components/build-style/style.css

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@wordpress/components) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Component Reference

This packages includes a library of generic WordPress components to be used for creating common UI elements shared between screens and features of the WordPress dashboard.

Installation

Install the module

npm install @wordpress/components --save

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 ES2015+ such as lower versions of IE then using core-js or @babel/polyfill will add support for these methods. Learn more about it in Babel docs.

Usage

Within Gutenberg, these components can be accessed by importing from the components root directory:

/**
 * WordPress dependencies
 */
import { Button } from '@wordpress/components';

export default function MyButton() {
    return <Button>Click Me!</Button>;
}

Many components also include styles which will need to be output in order to appear correctly. Within WordPress, you can add the wp-components stylesheet as a dependency of your plugin's stylesheet. In other projects, you can link to the build-style/style.css file directly.

Code is Poetry.