Nifty Procrastination Machine

    @wordpress/components
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/wordpress__components package

    19.0.0 • Public • Published

    Component Reference

    This package 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 such language features and APIs, you should include the polyfill shipped in @wordpress/babel-preset-default in your code.

    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 include CSS to add style, you will need to add in order to appear correctly. Within WordPress, add the wp-components stylesheet as a dependency of your plugin's stylesheet. See wp_enqueue_style documentation for how to specify dependencies.

    In non-WordPress projects, link to the build-style/style.css file directly, it is located at node_modules/@wordpress/components/build-style/style.css.



    Code is Poetry.

    Docs & examples

    You can browse the components docs and examples at https://wordpress.github.io/gutenberg/

    Contributing

    See CONTRIBUTING.md for the contributing guidelines for the @wordpress/components package.

    Install

    npm i @wordpress/components

    DownloadsWeekly Downloads

    37,882

    Version

    19.0.0

    License

    GPL-2.0-or-later

    Unpacked Size

    13.1 MB

    Total Files

    4155

    Last publish

    Collaborators

    • ryanwelcher
    • adamziel
    • garypendergast
    • aduth
    • riad
    • adamsilverstein
    • gziolo
    • ntwb
    • noisysocks
    • kadamwhite
    • jorgefilipecosta
    • ellatrix
    • iandunn206
    • whyisjake
    • ockham
    • sirreal
    • nosolosw
    • wpisabel
    • ntsekouras
    • nerrad
    • desrosj
    • talldanwp
    • peterwilsoncc