yoast-components

Yoast components

React components for use within different Yoast React projects.

Installation

You can install yoast-components using npm:

npm install yoast-components

Usage

import 'Input' from 'yoast-components/forms/Input'

// Then you can Input in your React components

Testing

npm test

Code style

To test the code style:

grunt check

Contributing

Folder structure

Every component should have its own folder named lowercase with the relevant files inside of it. Every component must contain a JavaScript with the component definition in it and exported using export default [Component]. Any component can contain a SCSS file for relevant CSS and a README.md explaining how the component works.

Translation

We use i18n-calypso to localize all components. Refer to their documentation about how to use translate, moment and numberFormat. We don't use the mixin provided. Only use the higher order component to wrap components when they are exported, like so:

import { localize } from 'i18n-calypso'

export default localize( Component );

Security

If you discover any security related issues, please email security [at] yoast.com instead of using the issue tracker.

Credits

• Team Yoast
• All Contributors

License

We follow the GPL. Please see License file for more information.