Getting Started
Upgrading
Move an app to a newer UIX version: read the release notes, update the packages and follow the migration steps.
Summary
Each UIX package has its own version, and these docs always show the latest release. To move your app to it, read what changed, update the packages in one command, and follow the migration steps of any release that needs them.
Read the release notes
Open Release notes and read every release between the version in your package.json and the latest one.
Until @anantya/uix reaches 1.0.0, a minor release such as 0.3.0 can change the API. From 1.0.0, only a major release can. Every release that changes the API lists the migration steps to follow.
Update the packages
pnpm update --latest @anantya/uix @anantya/icons--latest installs the newest version even outside the range in your package.json, such as 0.3.0 when it says ^0.2.1. @anantya/tokens and @anantya/core update with @anantya/uix.
Follow the migration steps
Make the changes each release's migration steps describe, oldest release first. Then run your type check and build: a renamed or removed prop shows up as a type error.
Something deprecated keeps working for at least one more minor release and warns in the browser console while you develop. Its page links to what replaces it.
Related
- Release notes: every release of every package, newest first
- Installation: the setup each release builds on
- Support: ask the UIX team about a change