Skip to content

Commit 46d6185

Browse files
Lukas742Lukas742
authored
docs(VersionTable): outline repo-package mappings (#7632)
1 parent 09d8d19 commit 46d6185

File tree

2 files changed

+120
-18
lines changed

2 files changed

+120
-18
lines changed

‎.storybook/components/VersionTable.tsx

Lines changed: 118 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import iconArrowDown from '@ui5/webcomponents-icons/dist/slim-arrow-down.js';
22
import iconArrowRight from '@ui5/webcomponents-icons/dist/slim-arrow-right.js';
3-
import { Button, MessageStrip } from '@ui5/webcomponents-react';
3+
import { Button, MessageStrip, Link } from '@ui5/webcomponents-react';
44
import { ThemingParameters } from '@ui5/webcomponents-react-base';
55
import { Fragment, useState } from 'react';
66
import versionInfo from '../../config/version-info.json';
@@ -17,20 +17,125 @@ export function VersionTable() {
1717
</MessageStrip>
1818
<p>
1919
<b>
20-
In order to allow patching releases of UI5 Web Components by yourself, <code>@ui5/webcomponents</code> and
21-
&nbsp;
22-
<code>@ui5/webcomponents-fiori</code> are peer dependencies of <code>@ui5/webcomponents-react</code>. The
23-
following table gives an overview of the required peer dependencies per version:
20+
In order to allow patching releases of UI5 Web Components by yourself, packages from{' '}
21+
<Link href={'https://github.com/SAP/ui5-webcomponents'} target={'_blank'}>
22+
ui5-webcomponents
23+
</Link>{' '}
24+
are peer dependencies of{' '}
25+
<Link href={'https://github.com/SAP/ui5-webcomponents-react'}>ui5-webcomponents-react</Link> packages.
2426
</b>
2527
</p>
28+
<p>If you&apos;re not clear which package is developed in which repo, expand the table below.</p>
29+
30+
<details>
31+
<summary>Show Package to Repository Mapping</summary>
32+
33+
<table>
34+
<thead>
35+
<tr>
36+
<th>Repository</th>
37+
<th>Packages</th>
38+
</tr>
39+
</thead>
40+
<tbody>
41+
<tr>
42+
<td>
43+
<Link href={'https://github.com/SAP/ui5-webcomponents'} target={'_blank'}>
44+
ui5-webcomponents
45+
</Link>
46+
</td>
47+
<td>
48+
<ul>
49+
<li>
50+
<code>@ui5/webcomponents</code> — main components (buttons, inputs, popups, tables, etc.)
51+
</li>
52+
<li>
53+
<code>@ui5/webcomponents-fiori</code> — Fiori-specific / semantic components
54+
</li>
55+
<li>
56+
<code>@ui5/webcomponents-ai</code> — AI-specific components
57+
</li>
58+
<li>
59+
<code>@ui5/webcomponents-base</code> — the framework/base utilities
60+
</li>
61+
<li>
62+
<code>@ui5/webcomponents-icons</code> — SAP Icons collection
63+
</li>
64+
<li>
65+
<code>@ui5/webcomponents-icons-tnt</code> — TNT icons collection
66+
</li>
67+
<li>
68+
<code>@ui5/webcomponents-icons-business-suite</code> — Business Suite icons collection
69+
</li>
70+
<li>
71+
<code>@ui5/webcomponents-theming</code> — theming assets
72+
</li>
73+
<li>
74+
<code>@ui5/webcomponents-localization</code> — i18n / CLDR assets
75+
</li>
76+
<li>
77+
<code>@ui5/webcomponents-tools</code> — libraries, configuration files and build artifacts
78+
</li>
79+
<li>
80+
<code>@ui5/create-package</code> — helper to create new UI5 Web Components packages
81+
</li>
82+
<li>
83+
<code>@ui5/webcomponents-compat</code> — legacy / v1 compatibility package
84+
</li>
85+
</ul>
86+
</td>
87+
</tr>
88+
<tr>
89+
<td>
90+
<Link href={'https://github.com/SAP/ui5-webcomponents-react'} target={'_blank'}>
91+
ui5-webcomponents-react
92+
</Link>
93+
</td>
94+
<td>
95+
<ul>
96+
<li>
97+
<code>@ui5/webcomponents-react</code> — main React wrapper package
98+
</li>
99+
<li>
100+
<code>@ui5/webcomponents-ai-react</code> — React wrapper for the <code>@ui5/webcomponents-ai</code>{' '}
101+
package
102+
</li>
103+
<li>
104+
<code>@ui5/webcomponents-react-base</code> — utility / base helpers for the React wrappers
105+
</li>
106+
<li>
107+
<code>@ui5/webcomponents-react-charts</code> — chart components
108+
</li>
109+
<li>
110+
<code>@ui5/webcomponents-react-cli</code> — wrapper generation & codemod tooling
111+
</li>
112+
<li>
113+
<code>@ui5/webcomponents-cypress-commands</code> — custom Cypress commands & queries
114+
</li>
115+
<li>
116+
<code>@ui5/webcomponents-react-compat</code> — legacy / v1 compatibility package
117+
</li>
118+
</ul>
119+
</td>
120+
</tr>
121+
</tbody>
122+
</table>
123+
</details>
124+
26125
<table>
27126
<thead>
28127
<tr>
29128
<th>
30-
<code>@ui5/webcomponents-react</code> version
129+
<Link href={'https://github.com/SAP/ui5-webcomponents-react'} target={'_blank'}>
130+
ui5-webcomponents-react
131+
</Link>{' '}
132+
Versions
31133
</th>
32134
<th>
33-
<code>@ui5/webcomponents</code> & <code>@ui5/webcomponents-fiori</code> version
135+
<Link href={'https://github.com/SAP/ui5-webcomponents'} target={'_blank'}>
136+
ui5-webcomponents
137+
</Link>{' '}
138+
Versions
34139
</th>
35140
</tr>
36141
</thead>
@@ -113,6 +218,12 @@ export function VersionTable() {
113218
})}
114219
</tbody>
115220
</table>
221+
222+
<MessageStrip hideCloseButton>
223+
Please note that if a version doesn&apos;t start with a patch-version of 0 (e.g. <code>~1.10.3</code>), only the
224+
specified version is supported and the previous patch-versions will most likely not work with{' '}
225+
<code>@ui5/webcomponents-react</code>.
226+
</MessageStrip>
116227
</>
117228
);
118229
}

‎docs/Welcome.mdx

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -54,18 +54,9 @@ First of all, you need to add the `@ui5/webcomponents-react` dependency to your
5454
npm install @ui5/webcomponents @ui5/webcomponents-react @ui5/webcomponents-fiori
5555
```
5656

57-
<VersionTable />
57+
#### Versions Table
5858

59-
<MessageStrip
60-
hideCloseButton
61-
children={
62-
<>
63-
Please note that if a <code>@ui5/webcomponents</code> or <code>@ui5/webcomponents-fiori</code> version doesn't
64-
start with a patch-version of 0 (e.g. <code>~1.10.3</code>), only the specified version is supported and the
65-
previous patch-versions will most likely not work with <code>@ui5/webcomponents-react</code>.
66-
</>
67-
}
68-
/>
59+
<VersionTable />
6960

7061
In order to use `@ui5/webcomponents-react` you have to wrap your application's root component into the `ThemeProvider`.<br/>
7162
You will find this component most likely in `src/index.js`:

0 commit comments

Comments
 (0)