@shoptet/ui

Reusable UI Library

This repository contains a collection of reusable React components that are purely visual. These components are designed to be used across multiple projects and should not handle data fetching, routing, or translations.

Caution: This is an early-stage development version of the Shoptet UI kit package. It is not recommended for production use

Please be aware that this version may contain bugs, incomplete features, or undergo significant changes before reaching a stable release. Use it at your own risk and for testing and development purposes only. Your feedback and contributions are appreciated to help improve the stability and functionality of the package. Refer to the documentation and release notes for more information on the current state of development. Thank you for your understanding.

Storybook

We have written a Storybook for the components to demonstrate how to use them.

The internal public version is currently available here: https://react.shoptet.cz/

Release

Release @shoptet/ui is made from the following steps

1. Create a PR with:
   • updated version in package.json (see Semantic Versioning)
   • Add a new headline version to CHANGELOG.md.
   • Copy the changes from CHANGELOG_UNRELEASED.md to CHANGELOG.md under the new headline
2. Deploy the Storybook using deploy-storybook
3. Notify about the new version in #design_system Slack channel, with listed changes from CHANGELOG.md

Publishing to NPM

[!NOTE] Publishing is possible only from the master branch because of secrets check. Read more about publishing packages to npm registry in our docs.

Use the following GitHub Actions workflow to publish a new version to NPM: https://github.com/shoptet/cms4/actions/workflows/publish-package-ui.yaml