Want to see what's happened lately? Check the changelog 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.

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:

import { Alert } from '@cimpress/react-components';

A sample page with documentation for all components is available here.

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

Commit Message Format

This specification is inspired by the Angular commit message format.

This project has precise rules on Git commit message formatting. This both allows for an easier to read commit history as well as enabling automated releases.

Each commit consists of a header, body, and footer.

<header>
<EMPTY LINE>
<body>
<EMPTY LINE>
<footer>

The header MUST always be included with every commit. The body IS OPTIONAL. Include a body when additional information provides context to the commit. The footer IS OPTIONAL.

Commit Message Header

<type>(<scope>): <summary>

The type and summary fields are MANDATORY. The scope is optional.

Type

MUST be one of the following:

feat: A new feature
- Note: feat can be appended with a "!" to indicate a BREAKING CHANGE.
fix: A bug fix
- Note: fix can be appended with a "!" to indicate a BREAKING CHANGE.
build: Changes that affect the build system or external dependencies (example scopes: typescript, npm)
ci: Changes to our CI configuration files and scripts (example scopes: gitlab-ci)
docs: Documentation only changes
perf: A code change that improves performance
refactor: A code change that neither fixes a bug nor adds a feature
test: Adding missing tests or correcting existing tests
chore: A code change to configs or other project utilties. (example scopes: readme, linting, formatting)

Scope

If a scope is included it should be the name of the code area affected or the name of a specific react-component which was changed or added.

Summary

Use the summary field to provide a short, informative description of the change:

Use the imperative, present tense: "change" not "changed" nor "changes"
DO NOT capitalize the first letter of the summary
no dot (.) at the end

Commit Message Body

Just as in the summary field of the header use the same rules for changes.

Explain the reason or motivation for the change within the body. It should answer the question as to why you are making the change.

Commit Message Footer

The footer can contain information about breaking changes, deprecations, or the place to reference GitLab issues or related merge requests.

feat: update button with new api for providing a theme
<BLANK LINE>
<additional description of why this is needed or breaking>
<BLANK LINE>
<BLANK LINE>
BREAKING CHANGE: replace button with new props api to enhance experience

feat: add new component to project
<BLANK LINE>
<additional description of why this is needed or breaking>
<BLANK LINE>
<BLANK LINE>
Closes: #<issue_number>

FAQs

What is @cimpress/react-components?

Is @cimpress/react-components popular?

Is @cimpress/react-components well maintained?

Package last updated on 13 Apr 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install