Open UI Kit Core Versions

Understand how Open UI Kit Core versions are released and how to plan upgrades.

Current package

The docs show the latest published Open UI Kit Core package from npm. For published package details, use the npm package page or the repository releases.

• Package: @open-ui-kit/core
• Current npm version: shown in the docs header and notifications, with a workspace fallback when npm cannot be reached
• Repository: outshift-open/open-ui-kit

Versioning strategy

Open UI Kit Core follows Semantic Versioning 2.0.0. Version numbers use the major.minor.patch format.

• Major releases can include breaking changes and migration work.
• Minor releases add backwards-compatible features and component improvements.
• Patch releases include fixes, small refinements, and documentation updates.

Upgrade guidance

When upgrading:

1. Read the release notes for breaking changes and peer dependency updates.
2. Update @open-ui-kit/core together with compatible peer dependency versions.
3. Run your visual checks for shared application surfaces such as navigation, tables, dialogs, and forms.
4. Check any custom sx overrides that reach into component internals.

Pre-release changes

Experimental APIs may change before they become stable. Treat undocumented internals as implementation details and prefer the documented component props wherever possible.

Notable migration notes

Theme mode in ThemeProvider

Open UI Kit Core 1.6 moved dark and light mode state into ThemeProvider. Use useThemeMode() inside the provider to read or change the active mode.

import { ThemeProvider, useThemeMode } from '@open-ui-kit/core';

function ThemeToggle() {
  const { isDarkMode, toggleTheme } = useThemeMode();

  return (
    <button type="button" onClick={toggleTheme}>
      Switch to {isDarkMode ? 'light' : 'dark'} mode
    </button>
  );
}

export function App() {
  return (
    <ThemeProvider defaultDarkMode={false}>
      <ThemeToggle />
    </ThemeProvider>
  );
}

Upgrade checklist:

• Wrap the app, Storybook preview, or local playground with ThemeProvider.
• Replace older theme-mode wiring with useThemeMode().
• Use defaultDarkMode when you need an initial dark theme.
• Keep useThemeMode() calls under the provider.

Release process

The package uses semantic-release and Conventional Commits to determine release versions. Stable releases are published to npm with the latest tag, while beta releases are published with the beta tag for preview testing.