Skip to content

Commit 2b673c1

Browse files
authored
docs(Welcome): add testing section, fix typos, remove outdated (#7965)
1 parent f71f4b1 commit 2b673c1

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

docs/Welcome.mdx

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,19 @@ import { VersionTable } from '@sb/components/VersionTable';
1515
[![](https://badgen.net/badge/maintained%20with/lerna?color=purple)](https://lernajs.io/)
1616
[![](https://badgen.net/github/stars/UI5/webcomponents-react?icon=github&color=black)](https://github.com/UI5/webcomponents-react/stargazers)
1717

18-
[Open Github Project](https://github.com/UI5/webcomponents-react)
18+
[Open GitHub Project](https://github.com/UI5/webcomponents-react)
1919

2020
UI5 Web Components for React is a Fiori compliant React library built on top of the UI5 Web Components.
2121
With the help of UI5 Web Components for React, you can use UI5 Web Components as if they were native React components.
22-
In addition to that, UI5 Web Components for React is providing complex components and layouts on top of the UI5 Web Components.
22+
In addition to that, UI5 Web Components for React provides complex components and layouts on top of the UI5 Web Components.
2323

2424
<TableOfContent />
2525

2626
## Requirements
2727

2828
- [React](https://www.npmjs.com/package/react) and [React-DOM](https://www.npmjs.com/package/react-dom) (**18.0.0 or higher**)
2929
- [Node.js](https://nodejs.org/) (**LTS version**)
30-
- If you're using [TypeScript](https://www.typescriptlang.org/) we recommend version **4.7** or later.
30+
- If you're using [TypeScript](https://www.typescriptlang.org/), we recommend version **4.7** or later.
3131

3232
## End of Support for Version 1.x
3333

@@ -38,8 +38,8 @@ The support for version 1.x of `ui5-webcomponents-react` has ended on **July 1,
3838
### Tutorial
3939

4040
You are new to UI5 Web Components for React and don't know where to start?<br />
41-
Then take a look at our [Tutorial Mission](https://developers.sap.com/mission.react-spa.html) at SAP Developers!
42-
There you get a first glimpse at how easy it is to create an Application with UI5 Web Components for React.<br />
41+
Then take a look at our [Tutorial Mission](https://developers.sap.com/mission.react-spa.html) at "SAP Developers"!
42+
There you will get a first glimpse at how easy it is to create an Application with UI5 Web Components for React.<br />
4343
In about an hour you will create a business dashboard from scratch and get familiar with some React basics in case you don't know them already.
4444

4545
### Examples & Templates
@@ -177,7 +177,7 @@ Available Themes:
177177

178178
### Configure Compact/Cozy setting
179179

180-
UI5 Web Components supports `Compact` and `Cozy` mode. It is set to `Cozy` by default. To enable `Compact`, provide the css class `ui5-content-density-compact` to any of your HTML elements and it apply compact size to all of its children.
180+
UI5 Web Components supports `Compact` and `Cozy` mode. It is set to `Cozy` by default. To enable `Compact`, provide the css class `ui5-content-density-compact` to any of your HTML elements and it will apply compact size to all of its children.
181181

182182
```html
183183
<body class="ui5-content-density-compact">
@@ -189,8 +189,6 @@ UI5 Web Components supports `Compact` and `Cozy` mode. It is set to `Cozy` by de
189189

190190
UI5 Web Components for React supports [TypeScript](https://www.typescriptlang.org/), therefore we also provide type interfaces for event parameters, public methods of `ui5-webcomponents`, and more.
191191

192-
You can find all available interfaces of the main package [here](https://github.com/UI5/webcomponents-react/tree/main/packages/main/src/interfaces) and for charts [here](https://github.com/UI5/webcomponents-react/tree/main/packages/charts/src/interfaces).
193-
194192
#### Example
195193

196194
Small app with a popover opened by clicking a button including type declarations:
@@ -232,6 +230,11 @@ export default function App() {
232230
`@ui5/webcomponents` offers a variety of [feature (side-effect) imports](https://ui5.github.io/webcomponents/docs/advanced/using-features/) that are available with `@ui5/webcomponents-react` as well.
233231
To use them you have to make sure they are imported before any other imports!
234232

233+
### Testing
234+
235+
We recommend testing components and running E2E tests in real browsers, e.g. by using Cypress, as JSDom (and other virtual DOM implementations) have limited custom element support.
236+
You can find out more about testing with Cypress [here](?path=/docs/testing-with-cypress-setup--docs), where you can also learn how to use our custom Cypress commands.
237+
235238
### Support
236239

237240
Feel free to open issues or ask us directly in the [`#webcomponents-react`](https://openui5.slack.com/archives/CSQEJ2J04) channel in the

0 commit comments

Comments
 (0)