File size: 1,557 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 |
# Components
A library of React components designed for use in Automattic products.
## Installation
Install the components and the color schemes they depend on.
```bash
yarn add @automattic/components @automattic/calypso-color-schemes
```
## Usage
```jsx
// import the color variables - you only need to do this once in your entire application
import '@automattic/calypso-color-schemes';
// import the component you wish to use
import { Button } from '@automattic/components';
const CallToAction = () => (
<>
<Button primary onClick={ () => alert( 'Thank you for taking action!' ) }>
Take action now!
</Button>
</>
);
```
Some components require CSS styles from `@wordpress/components`, which you will need to load in order for them to appear correctly. Within WordPress, add the `wp-components` stylesheet as a dependency of your plugin's stylesheet. See [wp_enqueue_style documentation](https://developer.wordpress.org/reference/functions/wp_enqueue_style/#parameters) for how to specify dependencies.
In non-WordPress projects, import the `build-style/style.css` file directly, located at `node_modules/@wordpress/components/build-style/style.css`.
## Development Workflow
This package is developed as part of the Calypso monorepo. Run `yarn`
in the root of the repository to get the required `devDependencies`.
### Tests
`yarn run test-packages`
`yarn run test-packages:watch`
### Using [Storybook](https://storybook.js.org/)
To see stories within this package, run `yarn workspace @automattic/components run storybook:start`.
|