Update Optimus UI

Updating an Optimus UI project to a newer version with ng update.

Overview #

All @openng/optimus-ui packages — the components, themes, locale definitions, Tailwind CSS plugin and their internal dependencies — are versioned and released together, so an update always moves the whole suite to a single new version. Optimus UI supports ng update, the Angular CLI's own update mechanism, which bumps every installed Optimus UI package in one step and runs any automated code migrations shipped with the new version.

Major versions follow Angular's: when a new Angular major ships, a matching Optimus UI major is released for it. Minor and patch releases stay within the same Angular major and are drop-in updates.

This page is about updating a project that already uses Optimus UI. To move an existing PrimeNG workspace across, see the migration guide instead.

Updating #

Run ng update without arguments at any time to list the updates available in your workspace, Optimus UI included.

ng update

To update within the current major, pass the main package. The Angular CLI resolves the rest: @openng/optimus-ui declares all its companion packages as a group, so every installed @openng/optimus-ui-* package — themes, locale, Tailwind CSS plugin and the internal runtime packages — is updated together and the suite cannot end up on mixed versions.

ng update @openng/optimus-ui

Like any ng update run, the command expects a clean git working tree so its changes can be reviewed or reverted in isolation — commit or stash your work first.

Angular Version Compatibility #

Each Optimus UI major targets a single Angular major.

Optimus UI	Angular
v2	v22
v1	v21

To move to a new major, update Angular first — the Angular update guide covers that step — then update Optimus UI to the matching major by passing the target version. For example, from v1 on Angular v21:

ng update @angular/core@22 @angular/cli@22
ng update @openng/optimus-ui@2

Review the release notes of the target version for breaking changes before you start.

Release Notes #

Every version is published with its notes on the GitHub releases page, covering new features, fixes and any breaking changes or manual steps a release requires. Check the notes for the target version before a major update.