You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/compat/README.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,7 +47,7 @@ Following are the imports of duplicate custom element names:
47
47
### Experimental Patch Script
48
48
49
49
The `patch-compat-table` script (included in the `@ui5/webcomponents-react-cli` package) is developed to address specific compatibility issues that arise when using the legacy v1 Table component in conjunction with the `FilterBar` or `VariantManagement` components. These components internally rely on the v2 `Table`, and therefore conflicts will occur when using the v1 `Table`.
50
-
The script will change the custom element name by adding a `-v1` suffix (via `patch-package`) to all duplicate v1 table components.
50
+
The script will change the custom element name by adding a `-v1` suffix (via [patch-package](https://github.com/ds300/patch-package)) to all duplicate v1 table components.
51
51
52
52
> ⚠️ **Experimental**: This script is in experimental state and not subject to semantic versioning.
53
53
@@ -62,18 +62,18 @@ The script will change the custom element name by adding a `-v1` suffix (via `pa
62
62
**What it does**
63
63
64
64
<p>The script patches the `@ui5/webcomponents-compat` and `@ui5/webcomponents-react-compat` table component and subcomponents components and subcomponents to render with a different custom element name (tag name) compared to the v2 implementation.
65
-
This is done internally using [patch-package](https://github.com/ds300/patch-package) to adjust the implementation in the **node_modules**.</p>
65
+
This is done internally using `patch-package` to adjust the implementation in the **node_modules**.</p>
66
66
67
67
**How to use**
68
68
69
-
<p>**Install** the `@ui5/webcomponents-react-cli` and `@ui5/webcomponents-compat` packages:</p>
69
+
<p><b>Install</b> the `@ui5/webcomponents-react-cli` and `@ui5/webcomponents-compat` packages:</p>
70
70
71
71
```
72
72
// install `@ui5/webcomponents-compat` explicitly
73
73
npm i @ui5/webcomponents-react-cli @ui5/webcomponents-compat
74
74
```
75
75
76
-
<p>**Run** the script:</p>
76
+
<p><b>Run</b> the script:</p>
77
77
78
78
```
79
79
// ui5-wcr is an executable added by the `@ui5/webcomponents-react-cli` package
@@ -82,7 +82,7 @@ ui5-wcr patch-compat-table
82
82
83
83
<p>The `ui5-wcr` executable is provided by the `@ui5/webcomponents-react-cli` package. The `patch-compat-table` command applies the necessary patches.</p>
84
84
85
-
<p>**Recommendation:**</p>
85
+
<p><b>Recommendation:</b></p>
86
86
87
87
<p>Add the script as `postinstall` script in the `package.json`, so it runs after every module update.</p>
0 commit comments