Skip to content

Commit 2af4bce

Browse files
authored
docs: add migration guide for v0.16.0 (#1569)
1 parent 518d4c4 commit 2af4bce

File tree

2 files changed

+39
-34
lines changed

2 files changed

+39
-34
lines changed

docs/2-MigrationGuide.stories.mdx

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ or the [changelog](https://github.com/SAP/ui5-webcomponents-react/blob/master/CH
1515

1616
## Table of Contents
1717

18+
- [0.15.x to 0.16.0](#migrating-from-015x-to-0160)
1819
- [0.14.x to 0.15.0](#migrating-from-014x-to-0150)
1920
- [0.13.x to 0.14.0](#migrating-from-013x-to-0140)
2021
- [0.12.x to 0.13.0](#migrating-from-012x-to-0130)
@@ -23,6 +24,44 @@ or the [changelog](https://github.com/SAP/ui5-webcomponents-react/blob/master/CH
2324
- [0.9.x to 0.10.0](#migrating-from-09x-to-0100)
2425
- [0.8.x to 0.9.0](#migrating-from-08x-to-090)
2526

27+
## Migrating from 0.15.x to 0.16.0
28+
29+
<br />
30+
31+
### Changed import path for `ComposedChartPlaceholder`
32+
33+
The import path of the `ComposedChartPlaceholder` has changed. You can now import the placeholder from `@ui5/webcomponents-react-charts/dist/ComposedChartPlaceholder` or directly from `@ui5/webcomponents-react-charts`.
34+
35+
```jsx
36+
import { ComposedChartPlaceholder } from '@ui5/webcomponents-react-charts/dist/ComposedChartPlaceholder';
37+
//or
38+
import { ComposedChartPlaceholder } from '@ui5/webcomponents-react-charts';
39+
```
40+
41+
### API Updates
42+
43+
#### FilterBar
44+
45+
If `useToolbar` is set to false, the entire toolbar above the filter items is hidden. The search input, variants, and the "Show/Hide FilterBar" button is not available with this mode. The rest of the buttons are displayed next to the filter items.
46+
47+
If you have used the `useToolbar` prop to hide the "Show/Hide Filters" button, but still want to display the search or variants, you can now use the `hideToggleFiltersButton`.
48+
49+
Before:
50+
51+
```jsx
52+
<FilterBar search={<Input placeholder={'Search'} />} useToolbar={false}>
53+
...
54+
</FilterBar>
55+
```
56+
57+
Now:
58+
59+
```jsx
60+
<FilterBar search={<Input placeholder={'Search'} />} hideToggleFiltersButton>
61+
...
62+
</FilterBar>
63+
```
64+
2665
## Migrating from 0.14.x to 0.15.0
2766

2867
<br />

yarn.lock

Lines changed: 0 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -3765,14 +3765,6 @@
37653765
"@typescript-eslint/typescript-estree" "4.23.0"
37663766
debug "^4.1.1"
37673767

3768-
"@typescript-eslint/scope-manager@4.22.1":
3769-
version "4.22.1"
3770-
resolved "https://registry.yarnpkg.com/@typescript-eslint/scope-manager/-/scope-manager-4.22.1.tgz#5bb357f94f9cd8b94e6be43dd637eb73b8f355b4"
3771-
integrity sha512-d5bAiPBiessSmNi8Amq/RuLslvcumxLmyhf1/Xa9IuaoFJ0YtshlJKxhlbY7l2JdEk3wS0EnmnfeJWSvADOe0g==
3772-
dependencies:
3773-
"@typescript-eslint/types" "4.22.1"
3774-
"@typescript-eslint/visitor-keys" "4.22.1"
3775-
37763768
"@typescript-eslint/scope-manager@4.23.0":
37773769
version "4.23.0"
37783770
resolved "https://registry.yarnpkg.com/@typescript-eslint/scope-manager/-/scope-manager-4.23.0.tgz#8792ef7eacac122e2ec8fa2d30a59b8d9a1f1ce4"
@@ -3781,29 +3773,11 @@
37813773
"@typescript-eslint/types" "4.23.0"
37823774
"@typescript-eslint/visitor-keys" "4.23.0"
37833775

3784-
"@typescript-eslint/types@4.22.1":
3785-
version "4.22.1"
3786-
resolved "https://registry.yarnpkg.com/@typescript-eslint/types/-/types-4.22.1.tgz#bf99c6cec0b4a23d53a61894816927f2adad856a"
3787-
integrity sha512-2HTkbkdAeI3OOcWbqA8hWf/7z9c6gkmnWNGz0dKSLYLWywUlkOAQ2XcjhlKLj5xBFDf8FgAOF5aQbnLRvgNbCw==
3788-
37893776
"@typescript-eslint/types@4.23.0":
37903777
version "4.23.0"
37913778
resolved "https://registry.yarnpkg.com/@typescript-eslint/types/-/types-4.23.0.tgz#da1654c8a5332f4d1645b2d9a1c64193cae3aa3b"
37923779
integrity sha512-oqkNWyG2SLS7uTWLZf6Sr7Dm02gA5yxiz1RP87tvsmDsguVATdpVguHr4HoGOcFOpCvx9vtCSCyQUGfzq28YCw==
37933780

3794-
"@typescript-eslint/typescript-estree@4.22.1":
3795-
version "4.22.1"
3796-
resolved "https://registry.yarnpkg.com/@typescript-eslint/typescript-estree/-/typescript-estree-4.22.1.tgz#dca379eead8cdfd4edc04805e83af6d148c164f9"
3797-
integrity sha512-p3We0pAPacT+onSGM+sPR+M9CblVqdA9F1JEdIqRVlxK5Qth4ochXQgIyb9daBomyQKAXbygxp1aXQRV0GC79A==
3798-
dependencies:
3799-
"@typescript-eslint/types" "4.22.1"
3800-
"@typescript-eslint/visitor-keys" "4.22.1"
3801-
debug "^4.1.1"
3802-
globby "^11.0.1"
3803-
is-glob "^4.0.1"
3804-
semver "^7.3.2"
3805-
tsutils "^3.17.1"
3806-
38073781
"@typescript-eslint/typescript-estree@4.23.0":
38083782
version "4.23.0"
38093783
resolved "https://registry.yarnpkg.com/@typescript-eslint/typescript-estree/-/typescript-estree-4.23.0.tgz#0753b292097523852428a6f5a1aa8ccc1aae6cd9"
@@ -3817,14 +3791,6 @@
38173791
semver "^7.3.2"
38183792
tsutils "^3.17.1"
38193793

3820-
"@typescript-eslint/visitor-keys@4.22.1":
3821-
version "4.22.1"
3822-
resolved "https://registry.yarnpkg.com/@typescript-eslint/visitor-keys/-/visitor-keys-4.22.1.tgz#6045ae25a11662c671f90b3a403d682dfca0b7a6"
3823-
integrity sha512-WPkOrIRm+WCLZxXQHCi+WG8T2MMTUFR70rWjdWYddLT7cEfb2P4a3O/J2U1FBVsSFTocXLCoXWY6MZGejeStvQ==
3824-
dependencies:
3825-
"@typescript-eslint/types" "4.22.1"
3826-
eslint-visitor-keys "^2.0.0"
3827-
38283794
"@typescript-eslint/visitor-keys@4.23.0":
38293795
version "4.23.0"
38303796
resolved "https://registry.yarnpkg.com/@typescript-eslint/visitor-keys/-/visitor-keys-4.23.0.tgz#7215cc977bd3b4ef22467b9023594e32f9e4e455"

0 commit comments

Comments
 (0)