Skip to content

Commit fe5c0e2

Browse files
committed
formatting
1 parent 6691958 commit fe5c0e2

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

packages/compat/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Following are the imports of duplicate custom element names:
4747
### Experimental Patch Script
4848

4949
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.
5151

5252
> ⚠️ **Experimental**: This script is in experimental state and not subject to semantic versioning.
5353
@@ -62,18 +62,18 @@ The script will change the custom element name by adding a `-v1` suffix (via `pa
6262
**What it does**
6363

6464
<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>
6666

6767
**How to use**
6868

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>
7070

7171
```
7272
// install `@ui5/webcomponents-compat` explicitly
7373
npm i @ui5/webcomponents-react-cli @ui5/webcomponents-compat
7474
```
7575

76-
<p>**Run** the script:</p>
76+
<p><b>Run</b> the script:</p>
7777

7878
```
7979
// ui5-wcr is an executable added by the `@ui5/webcomponents-react-cli` package
@@ -82,7 +82,7 @@ ui5-wcr patch-compat-table
8282

8383
<p>The `ui5-wcr` executable is provided by the `@ui5/webcomponents-react-cli` package. The `patch-compat-table` command applies the necessary patches.</p>
8484

85-
<p>**Recommendation:**</p>
85+
<p><b>Recommendation:</b></p>
8686

8787
<p>Add the script as `postinstall` script in the `package.json`, so it runs after every module update.</p>
8888

0 commit comments

Comments
 (0)