@cimpress/react-components
Version:
React components to support the MCP styleguide
38 lines (24 loc) • 1.67 kB
Markdown
# MCP MEX React Components
## About
React components to support the MCP UX style guide. Hopefully they make your life easier.
Want to see what's happened lately? Check the [changelog](https://gitlab.com/Cimpress-Technology/internal-open-source/component-library/react-components/blob/master/CHANGELOG.md) for the latest updates. If you're looking for a concise summary of how to update to the latest version, check out the [migration document](https://gitlab.com/Cimpress-Technology/internal-open-source/component-library/react-components/blob/master/MIGRATION.md).
## Development
* Clone this repo
* Run ```npm install```
* This project is powered by React and Docusaurus.
* Run ```npm start``` and navigate to localhost:8080 in your browser.
## Using
You can install this package from NPM under the name `@cimpress/react-components`, like so:
```
npm install @cimpress/react-components
```
To reduce bundle size, import only the component you want, for example:
```javascript
import { Alert } from '@cimpress/react-components';
```
A sample page with documentation for all components is available [here](https://static.ux.cimpress.io/react-components/latest).
## Semantic Release and Conventional Commits
This project uses Semantic-Release to manage publishing to NPM. In order to adhere to a common standard, the conventional commit standard is used to enable Semantic-Release to publish the appropriate MAJOR, MINOR, or PATCH version according to semvar based on the `type` in the commit.
### Resources
- [Semantic-Release](https://semantic-release.gitbook.io/semantic-release/)
- [Conventional Commits](https://www.conventionalcommits.org/en/)