Skip to main content

Upgrade Notes

v2.x​

React 19 + MUI 7​

Version 2.0 is a major upgrade that targets React 19 and MUI v7. Both peer dependencies have breaking changes.

Peer dependency changes:

Packagev1.xv2.x
react / react-dom^1819.1.0 (exact)
@mui/material^5^7.1.1
@mui/icons-material^5^7.1.1
react-router-dom^6^7.11.0

MUI v7 breaking changes that affect consumers:

  • sx prop object syntax for theme callbacks has changed in some components. If you extended theme types, check for TypeScript errors.
  • The createTheme palette.mode key still works but the internal palette resolver has changed. If you merged library themes with custom palette overrides, re-test your colours.

New exports in v2​

  • AppProvider / useApp / useAppOptional — new app-level context
  • useSyncedSearchParams — URL search param sync hook
  • AsyncAutoCompleteV2 — typed, more flexible autocomplete
  • StatusActivationModal — extracted from StatusToggle
  • PREFERENCE_KEYS, DEFAULT_PREFERENCES, loadPreferencesFromStorage, savePreferencesToStorage — preference utilities

Removed in v2​

  • useApiAsync hook — removed; use React Query or similar. The type ApiAsyncResponse is still exported for migration.
  • Direct CSS file imports from within component files — all styles are now emitted via style.css only.

v1.x​

Refer to CHANGELOG.md in the repository for v1 release history.