Skip to content

docs(VersionTable): add ">=" for latest wcr version #4406

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.

Sign up for GitHub

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 2 commits into from
Mar 24, 2023
Merged

docs(VersionTable): add ">=" for latest wcr version #4406

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1398025
docs(VersionTable): add ">=" for last wcr version
Lukas742 Mar 23, 2023
b8ab8bf
add note about unsupported versions
Lukas742 Mar 23, 2023
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
8 changes: 6 additions & 2 deletions .storybook/components/VersionTable.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ export function VersionTable() {
</tr>
</thead>
<tbody>
{Object.entries(versionInfo).map(([wcVersion, wcrVersion]) => {
{Object.entries(versionInfo).map(([wcVersion, wcrVersion], index, arr) => {
const lastEntry = index + 1 === arr.length;
if (wcrVersion.startsWith('0')) {
return null;
}
Expand All @@ -43,7 +44,10 @@ export function VersionTable() {

return (
<tr key={wcrVersion}>
<td>{wcrVersions.join(', ')}</td>
<td>
{lastEntry ? '>= ' : ''}
{wcrVersions.join(', ')}
</td>
<td>~{wcVersion}</td>
</tr>
);
Expand Down
14 changes: 13 additions & 1 deletion docs/Welcome.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,17 @@ npm install @ui5/webcomponents @ui5/webcomponents-react @ui5/webcomponents-fiori

<VersionTable />

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

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

Expand Down Expand Up @@ -113,7 +124,8 @@ UI5 Web Components and UI5 Web Components for React are both coming with the `sa
children={
<>
UI5 Web Components for React uses the theme configuration of UI5 Web Components. Please also have a look at their{' '}
<Link href="https://sap.github.io/ui5-webcomponents/playground/advanced/configuration/#theme">documentation</Link>.
<Link href="https://sap.github.io/ui5-webcomponents/playground/advanced/configuration/#theme">documentation</Link>
.
</>
}
/>
Expand Down