Versioning policy
Cimpress UI packages follow semantic versioning. This page outlines the rules we follow when determining the impact of changes that we make to Cimpress UI packages.
Changes to public API
Section titled “Changes to public API”Cimpress UI team considers the following to be part of the public API:
- stable components and their stable props
- CSS variables intended for public use (color, spacing, radius, etc.)
- package entrypoints and import paths
- ecosystem compatibility (see our ecosystem support policy for more information)
Breaking changes to the public API will happen only in major updates. They will usually be preceded by warnings and deprecations, and in most cases an automatic migration script will be provided to streamline the migration process.
Changes outside of public API
Section titled “Changes outside of public API”The following is not considered as part of public API:
- internal DOM structure of components
- specific CSS properties used to style components
- CSS class names
- any unstable component/prop/variable (that has a name prefixed with
UNSTABLE_)
Breaking changes outside of the public API can occur in any release.