Skip to content

docs(MigrationGuide): add note about ui5wc enums #6272

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 27, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/MigrationGuide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,24 @@ npx @ui5/webcomponents-react-cli codemod --transform v2 \

The minimum required `react` and `react-dom` version is now `18.0.0`.

### UI5 Web Components Enums are no longer exported

Previously, we created enums for all props that used multiple string values to set the corresponding design, mode, etc. Since enums for web components have been exported directly by UI5 Web Components for some time, we had been proxying the imports to avoid breaking changes.

With version 2, we took the opportunity to remove all proxied enums, so they must now be imported directly from `@ui5/webcomponents` or the corresponding package.

**Note:** You can use our [Codemod](#codemod) to simplify the refactoring process.

For example:

```js
// v1
import { ButtonDesign } from '@ui5/webcomponents-react';

// v2
import ButtonDesign from '@ui5/webcomponents/dist/types/ButtonDesign.js';
```

### Removed `react-jss`

UI5 Web Components for React is no longer relying on `react-jss` internally, hence the dependency is now removed and the `react-jss` ThemeProvider is no longer rendered as part of our `ThemeProvider`.
Expand Down
Loading