diff --git a/common/changes/@itwin/appui-react/MBudrevicius-ErrorBoundaryTests_2024-10-22-13-14.json b/common/changes/@itwin/appui-react/MBudrevicius-ErrorBoundaryTests_2024-10-22-13-14.json deleted file mode 100644 index 8a68955dd26..00000000000 --- a/common/changes/@itwin/appui-react/MBudrevicius-ErrorBoundaryTests_2024-10-22-13-14.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@itwin/appui-react", - "comment": "Added error boundary to popout widgets.", - "type": "none" - } - ], - "packageName": "@itwin/appui-react" -} diff --git a/common/changes/@itwin/appui-react/changelogs-4.17.x_2024-12-16-11-00.json b/common/changes/@itwin/appui-react/changelogs-4.17.x_2024-12-16-11-00.json deleted file mode 100644 index 03d902ffad7..00000000000 --- a/common/changes/@itwin/appui-react/changelogs-4.17.x_2024-12-16-11-00.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "changes": [ - { - "comment": "", - "type": "none", - "packageName": "@itwin/appui-react" - } - ], - "packageName": "@itwin/appui-react", - "email": "10091419+GerardasB@users.noreply.github.com" -} \ No newline at end of file diff --git a/common/changes/@itwin/appui-react/changelogs-4.17.1_2024-10-28-08-58.json b/common/changes/@itwin/appui-react/changelogs-5.0.0_2024-12-16-13-22.json similarity index 100% rename from common/changes/@itwin/appui-react/changelogs-4.17.1_2024-10-28-08-58.json rename to common/changes/@itwin/appui-react/changelogs-5.0.0_2024-12-16-13-22.json diff --git a/common/changes/@itwin/appui-react/css-compat_2024-11-19-16-11.json b/common/changes/@itwin/appui-react/css-compat_2024-11-19-16-11.json deleted file mode 100644 index 3393c35368c..00000000000 --- a/common/changes/@itwin/appui-react/css-compat_2024-11-19-16-11.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@itwin/appui-react", - "comment": "", - "type": "none" - } - ], - "packageName": "@itwin/appui-react" -} \ No newline at end of file diff --git a/common/changes/@itwin/appui-react/itwinui-peer_2024-11-13-14-05.json b/common/changes/@itwin/appui-react/itwinui-peer_2024-11-13-14-05.json deleted file mode 100644 index 0b82600c2e0..00000000000 --- a/common/changes/@itwin/appui-react/itwinui-peer_2024-11-13-14-05.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@itwin/appui-react", - "comment": "Move @itwin/itwinui-react to peerDependencies.", - "type": "none" - } - ], - "packageName": "@itwin/appui-react" -} \ No newline at end of file diff --git a/common/changes/@itwin/appui-react/modal-frontstage-back_2024-12-13-14-49.json b/common/changes/@itwin/appui-react/modal-frontstage-back_2024-12-13-14-49.json deleted file mode 100644 index a41dca0b720..00000000000 --- a/common/changes/@itwin/appui-react/modal-frontstage-back_2024-12-13-14-49.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@itwin/appui-react", - "comment": "Add ModalFrontstageButton component.", - "type": "none" - } - ], - "packageName": "@itwin/appui-react" -} \ No newline at end of file diff --git a/common/changes/@itwin/appui-react/redux-update_2024-12-11-15-11.json b/common/changes/@itwin/appui-react/redux-update_2024-12-11-15-11.json deleted file mode 100644 index b9af5b31ce5..00000000000 --- a/common/changes/@itwin/appui-react/redux-update_2024-12-11-15-11.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@itwin/appui-react", - "comment": "Update `redux` and `react-redux` versions.", - "type": "none" - } - ], - "packageName": "@itwin/appui-react" -} diff --git a/common/changes/@itwin/appui-react/remove-icons-generic_2024-12-11-15-42.json b/common/changes/@itwin/appui-react/remove-icons-generic_2024-12-11-15-42.json deleted file mode 100644 index 646f921a565..00000000000 --- a/common/changes/@itwin/appui-react/remove-icons-generic_2024-12-11-15-42.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@itwin/appui-react", - "comment": "Remove `@bentley/icons-generic` dependency.", - "type": "none" - } - ], - "packageName": "@itwin/appui-react" -} diff --git a/common/changes/@itwin/appui-react/remove-internal-tag-from-widgetdef-defaultstate_2024-12-04-19-17.json b/common/changes/@itwin/appui-react/remove-internal-tag-from-widgetdef-defaultstate_2024-12-04-19-17.json deleted file mode 100644 index f7f3f087f39..00000000000 --- a/common/changes/@itwin/appui-react/remove-internal-tag-from-widgetdef-defaultstate_2024-12-04-19-17.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@itwin/appui-react", - "comment": "the @internal tag was removed from WidgetDef.defaultState", - "type": "none" - } - ], - "packageName": "@itwin/appui-react" -} \ No newline at end of file diff --git a/common/changes/@itwin/appui-react/todd-addfrontstage-nonbeta_2024-11-29-17-23.json b/common/changes/@itwin/appui-react/todd-addfrontstage-nonbeta_2024-11-29-17-23.json deleted file mode 100644 index bf50f2ea77e..00000000000 --- a/common/changes/@itwin/appui-react/todd-addfrontstage-nonbeta_2024-11-29-17-23.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@itwin/appui-react", - "comment": "Removed beta tag from addFrontstage", - "type": "none" - } - ], - "packageName": "@itwin/appui-react" -} \ No newline at end of file diff --git a/common/changes/@itwin/appui-react/tool-icons_2024-12-11-13-21.json b/common/changes/@itwin/appui-react/tool-icons_2024-12-11-13-21.json deleted file mode 100644 index 3393c35368c..00000000000 --- a/common/changes/@itwin/appui-react/tool-icons_2024-12-11-13-21.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@itwin/appui-react", - "comment": "", - "type": "none" - } - ], - "packageName": "@itwin/appui-react" -} \ No newline at end of file diff --git a/common/changes/@itwin/components-react/MBudrevicius-RemoveIconsGeneric_2024-10-23-10-21.json b/common/changes/@itwin/components-react/MBudrevicius-RemoveIconsGeneric_2024-10-23-10-21.json deleted file mode 100644 index 10c4dfca669..00000000000 --- a/common/changes/@itwin/components-react/MBudrevicius-RemoveIconsGeneric_2024-10-23-10-21.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@itwin/components-react", - "comment": "Removed some references on @bentley/icons-generic", - "type": "none" - } - ], - "packageName": "@itwin/components-react" -} \ No newline at end of file diff --git a/common/changes/@itwin/components-react/add-missing-peer_2024-12-09-19-16.json b/common/changes/@itwin/components-react/add-missing-peer_2024-12-09-19-16.json deleted file mode 100644 index b7e7de56d76..00000000000 --- a/common/changes/@itwin/components-react/add-missing-peer_2024-12-09-19-16.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@itwin/components-react", - "comment": "Remove `@itwin/core-geometry` usage from `@itwin/components-react`", - "type": "none" - } - ], - "packageName": "@itwin/components-react" -} diff --git a/common/changes/@itwin/components-react/changelogs-4.17.x_2024-12-16-11-00.json b/common/changes/@itwin/components-react/changelogs-4.17.x_2024-12-16-11-00.json deleted file mode 100644 index c6e61b24119..00000000000 --- a/common/changes/@itwin/components-react/changelogs-4.17.x_2024-12-16-11-00.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "changes": [ - { - "comment": "", - "type": "none", - "packageName": "@itwin/components-react" - } - ], - "packageName": "@itwin/components-react", - "email": "10091419+GerardasB@users.noreply.github.com" -} \ No newline at end of file diff --git a/common/changes/@itwin/components-react/changelogs-4.17.1_2024-10-28-08-58.json b/common/changes/@itwin/components-react/changelogs-5.0.0_2024-12-16-13-22.json similarity index 100% rename from common/changes/@itwin/components-react/changelogs-4.17.1_2024-10-28-08-58.json rename to common/changes/@itwin/components-react/changelogs-5.0.0_2024-12-16-13-22.json diff --git a/common/changes/@itwin/components-react/css-compat_2024-11-19-16-11.json b/common/changes/@itwin/components-react/css-compat_2024-11-19-16-11.json deleted file mode 100644 index d2d24b087cf..00000000000 --- a/common/changes/@itwin/components-react/css-compat_2024-11-19-16-11.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@itwin/components-react", - "comment": "", - "type": "none" - } - ], - "packageName": "@itwin/components-react" -} \ No newline at end of file diff --git a/common/changes/@itwin/components-react/itwinui-peer_2024-11-13-14-05.json b/common/changes/@itwin/components-react/itwinui-peer_2024-11-13-14-05.json deleted file mode 100644 index b780d50daa4..00000000000 --- a/common/changes/@itwin/components-react/itwinui-peer_2024-11-13-14-05.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@itwin/components-react", - "comment": "Move @itwin/itwinui-react to peerDependencies.", - "type": "none" - } - ], - "packageName": "@itwin/components-react" -} \ No newline at end of file diff --git a/common/changes/@itwin/components-react/mast-property-grid-callback-to-show-only-editor_2024-10-31-10-15.json b/common/changes/@itwin/components-react/mast-property-grid-callback-to-show-only-editor_2024-10-31-10-15.json deleted file mode 100644 index 5fcf3fd6581..00000000000 --- a/common/changes/@itwin/components-react/mast-property-grid-callback-to-show-only-editor_2024-10-31-10-15.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@itwin/components-react", - "comment": "Added a callback to `VirtualizedPropertyGrid` which determines which editors should always be visible", - "type": "none" - } - ], - "packageName": "@itwin/components-react" -} \ No newline at end of file diff --git a/common/changes/@itwin/core-react/changelogs-4.17.x_2024-12-16-11-00.json b/common/changes/@itwin/core-react/changelogs-4.17.x_2024-12-16-11-00.json deleted file mode 100644 index 15452bcf414..00000000000 --- a/common/changes/@itwin/core-react/changelogs-4.17.x_2024-12-16-11-00.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "changes": [ - { - "comment": "", - "type": "none", - "packageName": "@itwin/core-react" - } - ], - "packageName": "@itwin/core-react", - "email": "10091419+GerardasB@users.noreply.github.com" -} \ No newline at end of file diff --git a/common/changes/@itwin/core-react/changelogs-4.17.1_2024-10-28-08-58.json b/common/changes/@itwin/core-react/changelogs-5.0.0_2024-12-16-13-22.json similarity index 100% rename from common/changes/@itwin/core-react/changelogs-4.17.1_2024-10-28-08-58.json rename to common/changes/@itwin/core-react/changelogs-5.0.0_2024-12-16-13-22.json diff --git a/common/changes/@itwin/core-react/css-compat_2024-11-19-16-11.json b/common/changes/@itwin/core-react/css-compat_2024-11-19-16-11.json deleted file mode 100644 index 17ffb558418..00000000000 --- a/common/changes/@itwin/core-react/css-compat_2024-11-19-16-11.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@itwin/core-react", - "comment": "", - "type": "none" - } - ], - "packageName": "@itwin/core-react" -} \ No newline at end of file diff --git a/common/changes/@itwin/core-react/itwinui-peer_2024-11-13-14-05.json b/common/changes/@itwin/core-react/itwinui-peer_2024-11-13-14-05.json deleted file mode 100644 index c326977df70..00000000000 --- a/common/changes/@itwin/core-react/itwinui-peer_2024-11-13-14-05.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@itwin/core-react", - "comment": "Move @itwin/itwinui-react to peerDependencies.", - "type": "none" - } - ], - "packageName": "@itwin/core-react" -} \ No newline at end of file diff --git a/common/changes/@itwin/core-react/remove-icons-generic_2024-12-11-15-42.json b/common/changes/@itwin/core-react/remove-icons-generic_2024-12-11-15-42.json deleted file mode 100644 index 17ffb558418..00000000000 --- a/common/changes/@itwin/core-react/remove-icons-generic_2024-12-11-15-42.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@itwin/core-react", - "comment": "", - "type": "none" - } - ], - "packageName": "@itwin/core-react" -} \ No newline at end of file diff --git a/common/changes/@itwin/imodel-components-react/changelogs-4.17.x_2024-12-16-11-00.json b/common/changes/@itwin/imodel-components-react/changelogs-4.17.x_2024-12-16-11-00.json deleted file mode 100644 index ae715799c54..00000000000 --- a/common/changes/@itwin/imodel-components-react/changelogs-4.17.x_2024-12-16-11-00.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "changes": [ - { - "comment": "", - "type": "none", - "packageName": "@itwin/imodel-components-react" - } - ], - "packageName": "@itwin/imodel-components-react", - "email": "10091419+GerardasB@users.noreply.github.com" -} \ No newline at end of file diff --git a/common/changes/@itwin/imodel-components-react/changelogs-4.17.1_2024-10-28-08-58.json b/common/changes/@itwin/imodel-components-react/changelogs-5.0.0_2024-12-16-13-22.json similarity index 100% rename from common/changes/@itwin/imodel-components-react/changelogs-4.17.1_2024-10-28-08-58.json rename to common/changes/@itwin/imodel-components-react/changelogs-5.0.0_2024-12-16-13-22.json diff --git a/common/changes/@itwin/imodel-components-react/css-compat_2024-11-19-16-11.json b/common/changes/@itwin/imodel-components-react/css-compat_2024-11-19-16-11.json deleted file mode 100644 index 98181801665..00000000000 --- a/common/changes/@itwin/imodel-components-react/css-compat_2024-11-19-16-11.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@itwin/imodel-components-react", - "comment": "", - "type": "none" - } - ], - "packageName": "@itwin/imodel-components-react" -} \ No newline at end of file diff --git a/common/changes/@itwin/imodel-components-react/itwinui-peer_2024-11-13-14-05.json b/common/changes/@itwin/imodel-components-react/itwinui-peer_2024-11-13-14-05.json deleted file mode 100644 index ff020df86c1..00000000000 --- a/common/changes/@itwin/imodel-components-react/itwinui-peer_2024-11-13-14-05.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@itwin/imodel-components-react", - "comment": "Move @itwin/itwinui-react to peerDependencies.", - "type": "none" - } - ], - "packageName": "@itwin/imodel-components-react" -} \ No newline at end of file diff --git a/common/changes/@itwin/imodel-components-react/remove-icons-generic_2024-12-11-15-42.json b/common/changes/@itwin/imodel-components-react/remove-icons-generic_2024-12-11-15-42.json deleted file mode 100644 index 98181801665..00000000000 --- a/common/changes/@itwin/imodel-components-react/remove-icons-generic_2024-12-11-15-42.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@itwin/imodel-components-react", - "comment": "", - "type": "none" - } - ], - "packageName": "@itwin/imodel-components-react" -} \ No newline at end of file diff --git a/common/changes/@itwin/imodel-components-react/tool-icons_2024-12-11-13-21.json b/common/changes/@itwin/imodel-components-react/tool-icons_2024-12-11-13-21.json deleted file mode 100644 index abd87cf9bfa..00000000000 --- a/common/changes/@itwin/imodel-components-react/tool-icons_2024-12-11-13-21.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "changes": [ - { - "packageName": "@itwin/imodel-components-react", - "comment": "Add `ToolUtilities` to define a Tool icon as a React element.", - "type": "none" - } - ], - "packageName": "@itwin/imodel-components-react" -} \ No newline at end of file diff --git a/docs/changehistory/5.0.0.md b/docs/changehistory/5.0.0.md new file mode 100644 index 00000000000..95cc0919b92 --- /dev/null +++ b/docs/changehistory/5.0.0.md @@ -0,0 +1,239 @@ +# 5.0.0 Change Notes + +Table of contents: + +- [Drop support for iTwin.js 3.x](#drop-support-for-itwinjs-3x) +- [Drop support for React 17.x](#drop-support-for-react-17x) +- [Drop support for iTwinUI 2.x](#drop-support-for-itwinui-2x) +- [Restrict access to `@internal` APIs](#restrict-access-to-internal-apis) +- [Drop CommonJS modules](#drop-commonjs-modules) +- [Style sheet changes](#style-sheet-changes) +- [Move iTwinUI to `peerDependencies`](#move-itwinui-to-peerdependencies) +- [@itwin/appui-react](#itwinappui-react) + - [Removals](#removals) + - [Additions](#additions) + - [Changes](#changes) +- [@itwin/components-react](#itwincomponents-react) + - [Deprecations](#deprecations) + - [Additions](#additions-1) + - [Changes](#changes-1) +- [@itwin/core-react](#itwincore-react) + - [Changes](#changes-2) +- [@itwin/imodel-components-react](#itwinimodel-components-react) + - [Additions](#additions-2) + +## Drop support for iTwin.js 3.x + +iTwin.js 3.x is in the end-of-life phase as described in the [version support policy](https://www.itwinjs.org/learning/api-support-policies/#version-support-status). + +iTwin.js peer dependency ranges have been updated to exclude version `^3.7.0`. [#1050](https://github.com/iTwin/appui/pull/1050) + +Application consumers of AppUI should upgrade to the latest [iTwin.js 4.x](https://www.itwinjs.org/changehistory/) version. Packages that depend on AppUI should update to the minimum required iTwin.js 4.x version. + +Support for newer versions of iTwin.js will be added in future AppUI releases. + +## Drop support for React 17.x + +React peer dependency ranges have been updated to exclude version `^17.0.0`. [#1054](https://github.com/iTwin/appui/pull/1054) + +Application consumers of AppUI should upgrade to the latest [React 18.x](https://react.dev/blog/2022/03/08/react-18-upgrade-guide) version. Packages that depend on AppUI should update to the minimum required React 18.x version. + +Support for newer versions of React will be added in future AppUI releases. + +## Drop support for iTwinUI 2.x + +iTwinUI 2.x is in the end-of-life phase as described in the [version support policy](https://github.com/iTwin/iTwinUI/wiki/Support-policy#version-support-status). + +AppUI packages will no longer support the iTwinUI 2.x version out of the box. Previously, AppUI would install both iTwinUI 2.x and iTwinUI 3.x to set up both versions when using the `ThemeManager` or popout windows. [#1058](https://github.com/iTwin/appui/pull/1058) + +Application consumers of AppUI should upgrade to the latest [iTwinUI 3.x](https://github.com/iTwin/iTwinUI/releases) version. Packages that depend on AppUI should update to the minimum required iTwinUI 3.x version. + +Applications that want to continue using iTwinUI 2.x in AppUI must be wrapped with the `ThemeProvider` from iTwinUI 2.x. +Additionally, to use iTwinUI 2.x in child windows and popout widgets, applications can use the newly introduced `childWindow` prop to wrap the content of child windows. For example: + +```tsx +import { ThemeProvider } from "@itwin/itwinui-react-v2"; + +function ChildWindow(props: React.PropsWithChildren<{}>) { + // Wrap content of child windows with `ThemeProvider` from iTwinUI 2.x + return {props.children}; +} + +function App() { + return ; +} +``` + +Support for newer versions of iTwinUI will be added in future AppUI releases. + +## Restrict access to `@internal` APIs + +AppUI packages now correctly define an `exports` field in their `package.json` files to prevent consumers from importing the `@internal` APIs directly from submodules. [#1048](https://github.com/iTwin/appui/pull/1048) + +This change might break consumers that rely on importing APIs directly from unsupported submodules. Currently supported export paths: + +- Main barrel file, i.e. `@itwin/appui-react` +- `package.json` subpath, i.e. `@itwin/appui-react/package.json` +- All SCSS files, i.e. `@itwin/core-react/lib/core-react/_typography.scss`. SCSS exports are available to facilitate the AppUI 5.0 adoption and will be removed in the next major version. + +To fix the import issue, consumers should update their import paths to use the supported export paths. For example: + +```tsx +// Before +import { Widget } from "@itwin/appui-react/lib/esm/appui-react/widgets/Widget"; + +// After +import { Widget } from "@itwin/appui-react"; +``` + +SCSS imports and variables should be replaced with iTwinUI CSS variables: + +```scss +// Before +@import "~@itwin/core-react/lib/cjs/core-react/style/themecolors"; + +.component { + background-color: $buic-background-1; +} + +// After +.component { + background-color: var(--iui-color-background); +} +``` + +Additionally, all `@internal` API exports are removed from the barrel file, as consumers should never use `@internal` APIs directly. [#1060](https://github.com/iTwin/appui/pull/1060) + +> [!CAUTION] +> There are still a number of `@internal` APIs that are exported with their related public types, such as class methods, fields, or namespace functions. These should never be used directly and are subject to change without notice. + +If the currently used API is not exported from the barrel file and there is no reasonable replacement, please [file an issue](https://github.com/iTwin/appui/issues/new/choose) and describe your use case. + +## Drop CommonJS modules + +Support for CommonJS modules has been removed from all AppUI packages. [#1081](https://github.com/iTwin/appui/pull/1081) + +To facilitate the migration, the `exports` field has been updated to support legacy `cjs` and `esm` import paths in SCSS files. For example, `@import "@itwin/core-react/lib/cjs/core-react/base/base.scss"` will continue to work correctly by resolving to `@import "@itwin/core-react/lib/core-react/base/base.scss"`. Additionally, SCSS files are still delivered in `cjs` and `esm` directories to support a wider range of bundlers [#1125](https://github.com/iTwin/appui/pull/1125). +However, consumers should avoid importing SCSS partial files, as these are deprecated and will be removed in the next major version. + +Additionally, file extensions are provided in import declarations, which are [mandatory for ES modules](https://nodejs.org/api/esm.html#mandatory-file-extensions). [#1056](https://github.com/iTwin/appui/pull/1056) + +## Style sheet changes + +SCSS files have been updated to use the [`@use`](https://sass-lang.com/documentation/at-rules/use/) rule instead of the [deprecated](https://sass-lang.com/documentation/breaking-changes/import/) [`@import`](https://sass-lang.com/documentation/at-rules/import/) rule. [#1085](https://github.com/iTwin/appui/pull/1085) + +To avoid breaking existing SCSS of AppUI consumers, [`@forward`](https://sass-lang.com/documentation/at-rules/forward/) rules were added to SCSS partial files to forward previously imported SCSS modules. + +Additionally, all internal usage of `--buic` CSS variables and `$buic` SCSS variables have been replaced with [iTwinUI CSS variables](https://itwinui.bentley.com/docs/variables). [#1079](https://github.com/iTwin/appui/pull/1079) + +Consumers of AppUI are expected to avoid using AppUI `SCSS` partial files directly and instead use the available CSS variables from iTwinUI. + +## Move iTwinUI to `peerDependencies` + +AppUI packages now specify `@itwin/itwinui-react` as a [peer dependency](https://docs.npmjs.com/cli/v10/configuring-npm/package-json#peerdependencies). This change means that application consumers should explicitly specify the latest version of iTwinUI in their `package.json` dependencies. This change simplifies the process of ensuring that a single version of the iTwinUI package is installed per major version without using version overrides. [#1115](https://github.com/iTwin/appui/pull/1115) + +## @itwin/appui-react + +### Removals + +- Removed the `FrameworkChildWindows.useCreateRoot` method, which existed solely to prevent runtime warnings when using `React 18.x`. Consumers should remove usages of `useCreateRoot` when upgrading. [#1054](https://github.com/iTwin/appui/pull/1054) +- Removed the [activateDroppedTab](https://github.com/iTwin/appui/discussions/679) preview feature, as the behavior of the preview feature is now enabled by default. Additionally, a widget tab's drag-and-drop logic is updated to activate the dropped tab only if it was active when the drag interaction was initiated. It is safe for consumers to remove the preview feature from their `PreviewFeaturesProvider`. [#1071](https://github.com/iTwin/appui/pull/1071) +- Removed the [newToolbars](https://github.com/iTwin/appui/discussions/924) preview feature, as the behavior of the preview feature is now enabled by default. It is safe for consumers to remove the preview feature from their `PreviewFeaturesProvider`. [#1072](https://github.com/iTwin/appui/pull/1072) + +### Additions + +- Added the `childWindow` prop to the `ConfigurableUiContent` component, allowing consumers to provide a wrapper component for child windows and popout widgets. [#1058](https://github.com/iTwin/appui/pull/1058) +- The `StatusBarPopover` component now accepts all props that are accepted by the `Popover` component from `@itwin/itwinui-react`. [#1068](https://github.com/iTwin/appui/pull/1068) +- Add `backButton` property to `ModalFrontstageInfo` interface to allow specifying of a custom back button for a modal frontstage. Additionally `ModalFrontstageButton` component is added to maintain visual consistency between modal frontstages. [#1156](https://github.com/iTwin/appui/pull/1156) + + ```tsx + UiFramework.frontstages.openModalFrontstage({ + ...info, + backButton: ( + { + const result = window.confirm("Are you sure you want to go back?"); + if (!result) return; + UiFramework.frontstages.closeModalFrontstage(); + }} + /> + ), + }); + ``` + +### Changes + +- Popout widgets are now displayed in a flow layout to match the layout of floating, stage panel, and popout widgets when `reparentPopoutWidgets` is enabled. [#1049](https://github.com/iTwin/appui/pull/1049) +- Use React portal instead of creating a separate element tree for each child window. [#1062](https://github.com/iTwin/appui/pull/1062) +- Removed incorrect usage of the internal `IModelApp.renderSystem.options.displaySolarShadows` check from `useSolarDataProvider`. The `wantShadows` property of the viewport display style is used instead. [#1066](https://github.com/iTwin/appui/pull/1066) +- Removed several references to `@bentley/icons-generic` by either reusing similar icons from `@itwin/itwinui-icons` or inlining the icons directly. [#1074](https://github.com/iTwin/appui/pull/1074) +- Add error boundary to popout widgets. [#1075](https://github.com/iTwin/appui/pull/1075) +- Updated the styling of the `BackstageAppButton` and `NestedFrontstageAppButton` components to match the updated toolbars. [#1078](https://github.com/iTwin/appui/pull/1078) +- The new toolbars will now handle snap opacity mode when it is enabled. [#1082](https://github.com/iTwin/appui/pull/1082) +- Bump `FrameworkFrontstages.addFrontstage` method to `@public`. [#1134](https://github.com/iTwin/appui/pull/1134) +- Add `defaultState` getter that returns the default state configuration of the widget to `WidgetDef` class. [#1141](https://github.com/iTwin/appui/pull/1141) +- Specified additional version ranges in redux related peer dependencies. `redux` version is updated from `^4.1.0` to `^4.1.0 || ^5.0.0` and `react-redux` version is updated from `^7.2.2` to `^7.2.2 || ^8.0.0 || ^9.0.0`. This enables consumers to utilize latest redux capabilities. See [redux release v5.0.0](https://github.com/reduxjs/redux/releases/tag/v5.0.0) for migration tips. [#1151](https://github.com/iTwin/appui/pull/1151) + +## @itwin/components-react + +### Deprecations + +- Deprecated the `FavoritePropertiesRenderer.renderFavorites` method in favor of an overload that doesn't take the `createRoot` function as an argument. [#1054](https://github.com/iTwin/appui/pull/1054) + +### Additions + +- Added the `IMergingPropertyDataProvider` interface, which combines any number of `IPropertyDataProvider` instances, and added the `createMergedPropertyDataProvider` factory function that creates an `IMergingPropertyDataProvider` instance. [#1040](https://github.com/iTwin/appui/pull/1040) +- Added a callback to `VirtualizedPropertyGrid` which determines which editors should always be visible. [#1090](https://github.com/iTwin/appui/pull/1090) + +### Changes + +- Removed a dependency to `@bentley/icons-generic` by reusing icons from `@itwin/itwinui-icons`. [#1074](https://github.com/iTwin/appui/pull/1074) + +## @itwin/core-react + +### Changes + +- Removed the `resize-observer-polyfill` dependency because `ResizeObserver` is well supported by modern browsers, eliminating the need for a polyfill. [#1045](https://github.com/iTwin/appui/pull/1045) + +## @itwin/imodel-components-react + +### Additions + +- Added `ToolUtilities` namespace that contains utilities for working with iTwin.js core `Tool` class. [#1150](https://github.com/iTwin/appui/pull/1150) + + - `ToolUtilities.defineIcon` function allows defining an icon for a tool type using a React element. This is a supplement for an existing `Tool.iconSpec` property that adds additional `iconElement` property to the tool type. + + ```tsx + // Before + export class MyTool extends Tool { + public static iconSpec = "icon-placeholder"; + } + + // After + class MyCoreTool extends Tool { + public static iconSpec = "icon-placeholder"; + } + export const MyTool = ToolUtilities.defineIcon( + MyCoreTool, + + ); + ``` + + Alternatively, consumers can simply add an `iconElement` property of `ReactElement` type to the tool class. + + ```tsx + export class MyTool extends Tool { + public static iconSpec = "icon-placeholder"; + public static iconElement = (); + } + ``` + + > Newly defined `iconElement` property needs to be read by the consumers to display the icon in a toolbar, unless the `ToolbarItemUtilities.createForTool` helper is used when creating toolbar items. + + - `ToolUtilities.isWithIcon` function is a type guard that checks if a tool has a React icon element defined. Which is useful to read the icon element from the tool type. + + ```tsx + if (ToolUtilities.isWithIcon(MyTool)) { + MyTool.iconElement; // ReactElement + } + ``` diff --git a/docs/changehistory/NextVersion.md b/docs/changehistory/NextVersion.md index 438e9bfe814..5ec6e734bda 100644 --- a/docs/changehistory/NextVersion.md +++ b/docs/changehistory/NextVersion.md @@ -1,84 +1 @@ # NextVersion - -- [@itwin/appui-react](#itwinappui-react) - - [Additions](#additions) - - [Changes](#changes) -- [@itwin/components-react](#itwincomponents-react) - - [Additions](#additions-1) -- [@itwin/imodel-components-react](#itwinimodel-components-react) - - [Additions](#additions-2) - -## @itwin/appui-react - -### Additions - -- Add `backButton` property to `ModalFrontstageInfo` interface to allow specifying of a custom back button for a modal frontstage. Additionally `ModalFrontstageButton` component is added to maintain visual consistency between modal frontstages. [#1156](https://github.com/iTwin/appui/pull/1156) - - ```tsx - UiFramework.frontstages.openModalFrontstage({ - ...info, - backButton: ( - { - const result = window.confirm("Are you sure you want to go back?"); - if (!result) return; - UiFramework.frontstages.closeModalFrontstage(); - }} - /> - ), - }); - ``` - -### Changes - -- Specified additional version ranges in redux related peer dependencies. `redux` version is updated from `^4.1.0` to `^4.1.0 || ^5.0.0` and `react-redux` version is updated from `^7.2.2` to `^7.2.2 || ^8.0.0 || ^9.0.0`. This enables consumers to utilize latest redux capabilities. See [redux release v5.0.0](https://github.com/reduxjs/redux/releases/tag/v5.0.0) for migration tips. [#1151](https://github.com/iTwin/appui/pull/1151) - -## @itwin/components-react - -### Additions - -- Added a callback to `VirtualizedPropertyGrid` which determines which editors should always be visible. [#1090](https://github.com/iTwin/appui/pull/1090) - -## @itwin/imodel-components-react - -### Additions - -- Added `ToolUtilities` namespace that contains utilities for working with iTwin.js core `Tool` class. [1150](https://github.com/iTwin/appui/pull/1150) - - - `ToolUtilities.defineIcon` function allows defining an icon for a tool type using a React element. This is a supplement for an existing `Tool.iconSpec` property that adds additional `iconElement` property to the tool type. - - ```tsx - // Before - export class MyTool extends Tool { - public static iconSpec = "icon-placeholder"; - } - - // After - class MyCoreTool extends Tool { - public static iconSpec = "icon-placeholder"; - } - export const MyTool = ToolUtilities.defineIcon( - MyCoreTool, - - ); - ``` - - Alternatively, consumers can simply add an `iconElement` property of `ReactElement` type to the tool class. - - ```tsx - export class MyTool extends Tool { - public static iconSpec = "icon-placeholder"; - public static iconElement = (); - } - ``` - - > [!NOTE] - > Newly defined `iconElement` property needs to be read by the consumers to display the icon in a toolbar, unless the `ToolbarItemUtilities.createForTool` helper is used when creating toolbar items. - - - `ToolUtilities.isWithIcon` function is a type guard that checks if a tool has a React icon element defined. Which is useful to read the icon element from the tool type. - - ```tsx - if (ToolUtilities.isWithIcon(MyTool)) { - MyTool.iconElement; // ReactElement - } - ``` diff --git a/ui/appui-react/CHANGELOG.json b/ui/appui-react/CHANGELOG.json index 78f1f535eb9..84602d94211 100644 --- a/ui/appui-react/CHANGELOG.json +++ b/ui/appui-react/CHANGELOG.json @@ -1,6 +1,102 @@ { "name": "@itwin/appui-react", "entries": [ + { + "version": "5.0.0", + "tag": "@itwin/appui-react_v5.0.0", + "date": "Mon, 16 Dec 2024 11:43:27 GMT", + "comments": { + "none": [ + { + "comment": "Added error boundary to popout widgets." + }, + { + "comment": "Removed check on displaySolarShadows in SolarDataProvider." + }, + { + "comment": "Update `MessageManager.addMessage` to ignore messages that are already active." + }, + { + "comment": "Update the styling of `BackstageAppButton`." + }, + { + "comment": "Remove `activateDroppedTab` preview feature which is now enabled by default." + }, + { + "comment": "Dropped tab will be activated only if it was active when drag interaction was initiated." + }, + { + "comment": "Drop support for CommonJS modules." + }, + { + "comment": "Drop support for iTwin.js 3.x." + }, + { + "comment": "Drop support for iTwinUI 2.x" + }, + { + "comment": "Remove `newToolbars` preview feature which is now enabled by default." + }, + { + "comment": "Drop support for React 17.x." + }, + { + "comment": "Display popout widgets in flow layout to match floating and stage panel widgets." + }, + { + "comment": "Fix an issue where resizing a panel would sometimes select widget contents." + }, + { + "comment": "Add `-webkit` prefix to `user-select` CSS property to fix selection issues on Safari." + }, + { + "comment": "Remove `@internal` API exports from the barrel file." + }, + { + "comment": "Move @itwin/itwinui-react to peerDependencies." + }, + { + "comment": "Add ModalFrontstageButton component." + }, + { + "comment": "Use React portal instead of creating a separate root for each child window." + }, + { + "comment": "Update `redux` and `react-redux` versions." + }, + { + "comment": "Remove `@bentley/icons-generic` dependency." + }, + { + "comment": "the @internal tag was removed from WidgetDef.defaultState" + }, + { + "comment": "Expose all `Popover` props in `StatusBarPopover` component." + }, + { + "comment": "Removed beta tag from addFrontstage" + }, + { + "comment": "Handle snap toolbar opacity in toolbars." + }, + { + "comment": "Added 2 preview features. One to allow letters in accudraw input fields. The other one to disable colors in accudraw xyz fields. " + }, + { + "comment": "Provide file extension in import declarations." + }, + { + "comment": "Add `exports` field to `package.json`." + }, + { + "comment": "Replaced SCSS `@import` rules with `@use` rules." + }, + { + "comment": "Replace buic variables with iTwinUI CSS variables." + } + ] + } + }, { "version": "4.17.6", "tag": "@itwin/appui-react_v4.17.6", diff --git a/ui/appui-react/CHANGELOG.md b/ui/appui-react/CHANGELOG.md index 64b503c37b1..1cd76e621e8 100644 --- a/ui/appui-react/CHANGELOG.md +++ b/ui/appui-react/CHANGELOG.md @@ -1,6 +1,41 @@ # Change Log - @itwin/appui-react -This log was last generated on Wed, 20 Nov 2024 14:27:46 GMT and should not be manually modified. +This log was last generated on Mon, 16 Dec 2024 11:43:27 GMT and should not be manually modified. + +## 5.0.0 +Mon, 16 Dec 2024 11:43:27 GMT + +### Updates + +- Added error boundary to popout widgets. +- Removed check on displaySolarShadows in SolarDataProvider. +- Update `MessageManager.addMessage` to ignore messages that are already active. +- Update the styling of `BackstageAppButton`. +- Remove `activateDroppedTab` preview feature which is now enabled by default. +- Dropped tab will be activated only if it was active when drag interaction was initiated. +- Drop support for CommonJS modules. +- Drop support for iTwin.js 3.x. +- Drop support for iTwinUI 2.x +- Remove `newToolbars` preview feature which is now enabled by default. +- Drop support for React 17.x. +- Display popout widgets in flow layout to match floating and stage panel widgets. +- Fix an issue where resizing a panel would sometimes select widget contents. +- Add `-webkit` prefix to `user-select` CSS property to fix selection issues on Safari. +- Remove `@internal` API exports from the barrel file. +- Move @itwin/itwinui-react to peerDependencies. +- Add ModalFrontstageButton component. +- Use React portal instead of creating a separate root for each child window. +- Update `redux` and `react-redux` versions. +- Remove `@bentley/icons-generic` dependency. +- the @internal tag was removed from WidgetDef.defaultState +- Expose all `Popover` props in `StatusBarPopover` component. +- Removed beta tag from addFrontstage +- Handle snap toolbar opacity in toolbars. +- Added 2 preview features. One to allow letters in accudraw input fields. The other one to disable colors in accudraw xyz fields. +- Provide file extension in import declarations. +- Add `exports` field to `package.json`. +- Replaced SCSS `@import` rules with `@use` rules. +- Replace buic variables with iTwinUI CSS variables. ## 4.17.6 Wed, 20 Nov 2024 14:27:46 GMT @@ -2518,4 +2553,3 @@ Fri, 12 Oct 2018 23:00:10 GMT ### Updates - Initial release - diff --git a/ui/components-react/CHANGELOG.json b/ui/components-react/CHANGELOG.json index d7f588dc70a..c03dbc1a99b 100644 --- a/ui/components-react/CHANGELOG.json +++ b/ui/components-react/CHANGELOG.json @@ -1,6 +1,57 @@ { "name": "@itwin/components-react", "entries": [ + { + "version": "5.0.0", + "tag": "@itwin/components-react_v5.0.0", + "date": "Mon, 16 Dec 2024 11:43:27 GMT", + "comments": { + "none": [ + { + "comment": "Add MergingPropertyDataProvider which combines multiple property data providers into a single one." + }, + { + "comment": "Removed some references on @bentley/icons-generic" + }, + { + "comment": "Remove `@itwin/core-geometry` usage from `@itwin/components-react`" + }, + { + "comment": "Drop support for CommonJS modules." + }, + { + "comment": "Drop support for iTwin.js 3.x." + }, + { + "comment": "Drop support for React 17.x." + }, + { + "comment": "Remove `@internal` API exports from the barrel file." + }, + { + "comment": "Move @itwin/itwinui-react to peerDependencies." + }, + { + "comment": "Added a callback to `VirtualizedPropertyGrid` which determines which editors should always be visible" + }, + { + "comment": "Update FilterBuilder UI according to UX team's new specs" + }, + { + "comment": "Provide file extension in import declarations." + }, + { + "comment": "Add `exports` field to `package.json`." + }, + { + "comment": "Replaced SCSS `@import` rules with `@use` rules." + }, + { + "comment": "Replace buic variables with iTwinUI CSS variables." + } + ] + } + }, { "version": "4.17.6", "tag": "@itwin/components-react_v4.17.6", diff --git a/ui/components-react/CHANGELOG.md b/ui/components-react/CHANGELOG.md index c702c952961..822e2f452fb 100644 --- a/ui/components-react/CHANGELOG.md +++ b/ui/components-react/CHANGELOG.md @@ -1,6 +1,26 @@ # Change Log - @itwin/components-react -This log was last generated on Wed, 20 Nov 2024 14:27:46 GMT and should not be manually modified. +This log was last generated on Mon, 16 Dec 2024 11:43:27 GMT and should not be manually modified. + +## 5.0.0 +Mon, 16 Dec 2024 11:43:27 GMT + +### Updates + +- Add MergingPropertyDataProvider which combines multiple property data providers into a single one. +- Removed some references on @bentley/icons-generic +- Remove `@itwin/core-geometry` usage from `@itwin/components-react` +- Drop support for CommonJS modules. +- Drop support for iTwin.js 3.x. +- Drop support for React 17.x. +- Remove `@internal` API exports from the barrel file. +- Move @itwin/itwinui-react to peerDependencies. +- Added a callback to `VirtualizedPropertyGrid` which determines which editors should always be visible +- Update FilterBuilder UI according to UX team's new specs +- Provide file extension in import declarations. +- Add `exports` field to `package.json`. +- Replaced SCSS `@import` rules with `@use` rules. +- Replace buic variables with iTwinUI CSS variables. ## 4.17.6 Wed, 20 Nov 2024 14:27:46 GMT @@ -2138,4 +2158,3 @@ Fri, 12 Oct 2018 23:00:10 GMT ### Updates - Initial release - diff --git a/ui/core-react/CHANGELOG.json b/ui/core-react/CHANGELOG.json index fa4036dfea1..ada610d409f 100644 --- a/ui/core-react/CHANGELOG.json +++ b/ui/core-react/CHANGELOG.json @@ -1,6 +1,45 @@ { "name": "@itwin/core-react", "entries": [ + { + "version": "5.0.0", + "tag": "@itwin/core-react_v5.0.0", + "date": "Mon, 16 Dec 2024 11:43:27 GMT", + "comments": { + "none": [ + { + "comment": "Drop support for CommonJS modules." + }, + { + "comment": "Drop support for iTwin.js 3.x." + }, + { + "comment": "Drop support for React 17.x." + }, + { + "comment": "Remove a polyfill for ResizeObserver since the API is supported in modern browsers." + }, + { + "comment": "Remove `@internal` API exports from the barrel file." + }, + { + "comment": "Move @itwin/itwinui-react to peerDependencies." + }, + { + "comment": "Provide file extension in import declarations." + }, + { + "comment": "Add `exports` field to `package.json`." + }, + { + "comment": "Replaced SCSS `@import` rules with `@use` rules." + }, + { + "comment": "Replace buic variables with iTwinUI CSS variables." + } + ] + } + }, { "version": "4.17.6", "tag": "@itwin/core-react_v4.17.6", diff --git a/ui/core-react/CHANGELOG.md b/ui/core-react/CHANGELOG.md index de8eed268e0..70042ed961f 100644 --- a/ui/core-react/CHANGELOG.md +++ b/ui/core-react/CHANGELOG.md @@ -1,6 +1,22 @@ # Change Log - @itwin/core-react -This log was last generated on Wed, 20 Nov 2024 14:27:46 GMT and should not be manually modified. +This log was last generated on Mon, 16 Dec 2024 11:43:27 GMT and should not be manually modified. + +## 5.0.0 +Mon, 16 Dec 2024 11:43:27 GMT + +### Updates + +- Drop support for CommonJS modules. +- Drop support for iTwin.js 3.x. +- Drop support for React 17.x. +- Remove a polyfill for ResizeObserver since the API is supported in modern browsers. +- Remove `@internal` API exports from the barrel file. +- Move @itwin/itwinui-react to peerDependencies. +- Provide file extension in import declarations. +- Add `exports` field to `package.json`. +- Replaced SCSS `@import` rules with `@use` rules. +- Replace buic variables with iTwinUI CSS variables. ## 4.17.6 Wed, 20 Nov 2024 14:27:46 GMT @@ -1909,4 +1925,3 @@ Fri, 12 Oct 2018 23:00:10 GMT ### Updates - Initial release - diff --git a/ui/imodel-components-react/CHANGELOG.json b/ui/imodel-components-react/CHANGELOG.json index 98ff8d6d8a5..d3a4ac634d7 100644 --- a/ui/imodel-components-react/CHANGELOG.json +++ b/ui/imodel-components-react/CHANGELOG.json @@ -1,6 +1,45 @@ { "name": "@itwin/imodel-components-react", "entries": [ + { + "version": "5.0.0", + "tag": "@itwin/imodel-components-react_v5.0.0", + "date": "Mon, 16 Dec 2024 11:43:27 GMT", + "comments": { + "none": [ + { + "comment": "Drop support for CommonJS modules." + }, + { + "comment": "Drop support for iTwin.js 3.x." + }, + { + "comment": "Drop support for React 17.x." + }, + { + "comment": "Remove `@internal` API exports from the barrel file." + }, + { + "comment": "Move @itwin/itwinui-react to peerDependencies." + }, + { + "comment": "Add `ToolUtilities` to define a Tool icon as a React element." + }, + { + "comment": "Provide file extension in import declarations." + }, + { + "comment": "Add `exports` field to `package.json`." + }, + { + "comment": "Replaced SCSS `@import` rules with `@use` rules." + }, + { + "comment": "Replace buic variables with iTwinUI CSS variables." + } + ] + } + }, { "version": "4.17.6", "tag": "@itwin/imodel-components-react_v4.17.6", diff --git a/ui/imodel-components-react/CHANGELOG.md b/ui/imodel-components-react/CHANGELOG.md index 8c2017e96ec..865014f4889 100644 --- a/ui/imodel-components-react/CHANGELOG.md +++ b/ui/imodel-components-react/CHANGELOG.md @@ -1,6 +1,22 @@ # Change Log - @itwin/imodel-components-react -This log was last generated on Wed, 20 Nov 2024 14:27:46 GMT and should not be manually modified. +This log was last generated on Mon, 16 Dec 2024 11:43:27 GMT and should not be manually modified. + +## 5.0.0 +Mon, 16 Dec 2024 11:43:27 GMT + +### Updates + +- Drop support for CommonJS modules. +- Drop support for iTwin.js 3.x. +- Drop support for React 17.x. +- Remove `@internal` API exports from the barrel file. +- Move @itwin/itwinui-react to peerDependencies. +- Add `ToolUtilities` to define a Tool icon as a React element. +- Provide file extension in import declarations. +- Add `exports` field to `package.json`. +- Replaced SCSS `@import` rules with `@use` rules. +- Replace buic variables with iTwinUI CSS variables. ## 4.17.6 Wed, 20 Nov 2024 14:27:46 GMT @@ -593,4 +609,3 @@ Mon, 24 Jan 2022 14:00:52 GMT - Update to latest types/react package - Update ViewportComponent to function component that properly processes async method to get viewState. - Lock down and update version numbers so docs will build. -