Skip to content
Back to search

webcomponents-react

A wrapper implementation for React of the UI5 Web Components that are compliant with the SAP Fiori User Experience

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today

Check it deeper on your machine

It has changed since its scan on 11 Nov 2026.

As a Claude Code plugin, install it and then ask Claude Code:

/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/UI5/webcomponents-react with scanskillsafety

Or from a terminal, clone it and run it:

git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/UI5/webcomponents-react'

It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/ui5--webcomponents-react/badge.svg)](/listings/ui5--webcomponents-react)

HTML

<a href="/listings/ui5--webcomponents-react"><img src="/api/listings/ui5--webcomponents-react/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

Install `@ui5/webcomponents-react` along with the `@ui5/webcomponents` and `@ui5/webcomponents-fiori` peer-dependencies as dependencies in your project:

npm install @ui5/webcomponents-react @ui5/webcomponents @ui5/webcomponents-fiori

**Note:** If you import anything from another `@ui5/webcomponents-xyz` package, we recommend installing it as a dependency as well, even if it’s already included through another package.

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 224 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. <a name="top"></a>
  2. <p align="center">
  3. <img src="https://raw.githubusercontent.com/UI5/webcomponents-react/main/assets/Logo-Sticker.png" alt="UI5 Web Components for React Logo" />
  4. </p>
  5. <p align="center">
  6. <a href='https://coveralls.io/github/UI5/webcomponents-react'>
  7. <img src='https://coveralls.io/repos/github/UI5/webcomponents-react/badge.svg' alt='Coverage Status' />
  8. </a>
  9. <a href="https://ui5-slack-invite.cfapps.eu10.hana.ondemand.com/" target="_blank">
  10. <img alt="Slack Badge" src="https://badgen.net/badge/slack/Join OpenUI5 Slack workspace/blue?icon=slack">
  11. </a>
  12. <a href="https://openui5.slack.com/archives/CSQEJ2J04" target="_blank">
  13. <img alt="Slack Badge" src="https://badgen.net/badge/slack/webcomponents-react/orange?icon=slack">
  14. </a>
  15. <a href="https://api.reuse.software/info/github.com/UI5/webcomponents-react" target="_blank">
  16. <img alt="REUSE Status" src="https://api.reuse.software/badge/github.com/UI5/webcomponents-react"/>
  17. </a>
  18. </p>
  19. `ui5-webcomponents-react` is providing a Fiori-compliant React implementation by leveraging the [UI5 Web Components](https://github.com/UI5/webcomponents).
  20. ## Resources
  21. You can find our documentation under the following links:
  22. - [Stable Release Documentation](https://ui5.github.io/webcomponents-react/)
  23. - [Nightly Release Documentation](https://ui5.github.io/webcomponents-react/nightly/)
  24. - [V1 Release Documentation](https://ui5.github.io/webcomponents-react/v1/)
  25. ## Packages Overview
  26. - [@ui5/webcomponents-react](https://github.com/UI5/webcomponents-react/tree/main/packages/main) - Main Package
  27. [![](https://badgen.net/npm/v/@ui5/webcomponents-react?icon=npm)](https://www.npmjs.com/package/@ui5/webcomponents-react)
  28. - [@ui5/webcomponents-react-charts](https://github.com/UI5/webcomponents-react/tree/main/packages/charts) - Charts Package (**[deprecated](https://github.com/UI5/webcomponents-react/tree/main/packages/charts#deprecation-notice)**)
  29. [![](https://badgen.net/npm/v/@ui5/webcomponents-react-charts?icon=npm)](https://www.npmjs.com/package/@ui5/webcomponents-react-charts)
  30. - [@ui5/webcomponents-react-base](https://github.com/UI5/webcomponents-react/tree/main/packages/base) - Base Package
  31. [![](https://badgen.net/npm/v/@ui5/webcomponents-react-base?icon=npm)](https://www.npmjs.com/package/@ui5/webcomponents-react-base)
  32. - [@ui5/webcomponents-react-compat](https://github.com/UI5/webcomponents-react/tree/main/packages/compat) - Legacy Components Package
  33. [![](https://badgen.net/npm/v/@ui5/webcomponents-react-compat?icon=npm)](https://www.npmjs.com/package/@ui5/webcomponents-react-compat)
  34. - [@ui5/webcomponents-react-cli](https://github.com/UI5/webcomponents-react/tree/main/packages/cli) - Wrapper Generation & Code-Mod Package
  35. [![](https://badgen.net/npm/v/@ui5/webcomponents-react-cli?icon=npm)](https://www.npmjs.com/package/@ui5/webcomponents-react-cli)
  36. - [@ui5/webcomponents-cypress-commands](https://github.com/UI5/webcomponents-react/tree/main/packages/cypress-commands) - Custom Cypress Commands & Queries Package
  37. [![](https://badgen.net/npm/v/@ui5/webcomponents-cypress-commands?icon=npm)](https://www.npmjs.com/package/@ui5/webcomponents-cypress-commands)
  38. - [@ui5/webcomponents-ai-react](https://github.com/UI5/webcomponents-react/tree/main/packages/ai) - React wrapper for the `@ui5/webcomponents-ai` Package
  39. [![](https://badgen.net/npm/v/@ui5/webcomponents-ai-react?icon=npm)](https://www.npmjs.com/package/@ui5/webcomponents-ai-react)
  40. <!-- *********************************************************************** -->
  41. <a name="requirements"></a>
  42. ## Requirements
  43. - [React](https://www.npmjs.com/package/react) and [React-DOM](https://www.npmjs.com/package/react-dom) (**18.0.0 or higher**)
  44. - [Node.js](https://nodejs.org/) (**LTS version**)
  45. - If you're using [TypeScript](https://www.typescriptlang.org/) we recommend version **4.7** or later.
  46. <!-- *********************************************************************** -->
  47. <a name="download"></a>
  48. ## Download and Installation
  49. You can install `@ui5/webcomponents-react` along with the required peer-dependencies based on the components you plan to use. **In most cases, the recommended installation is the most maintainable option.**
  50. ### Recommended Installation
  51. Install `@ui5/webcomponents-react` along with the `@ui5/webcomponents` and `@ui5/webcomponents-fiori` peer-dependencies as dependencies in your project:
  52. ```sh
  53. npm install @ui5/webcomponents-react @ui5/webcomponents @ui5/webcomponents-fiori
  54. ```
  55. **Note:** If you import anything from another `@ui5/webcomponents-xyz` package, we recommend installing it as a dependency as well, even if it’s already included through another package.
  56. ### Minimal Installation
  57. Since version `v2.14.0` of `@ui5/webcomponents-react`, `@ui5/webcomponents-fiori` is an optional peer-dependency. You will still need to install it if:
  58. - You want to use any [component](https://ui5.github.io/webcomponents/components/fiori/) from the `@ui5/webcomponents-fiori` package.
  59. - You want to use the [VariantManagement](https://ui5.github.io/webcomponents-react/v2/?path=/docs/inputs-variantmanagement--docs) component.
  60. - You import anything from the `@ui5/webcomponents-fiori` package.
  61. ```sh
  62. npm install @ui5/webcomponents-react @ui5/webcomponents
  63. ```
  64. **Note:** Most popular bundlers enable tree-shaking for production builds, so there’s no difference in the final bundle size between the recommended and minimal installations.
  65. > ⚠️ **Warning**
  66. >
  67. > If your bundler does **not** support tree-shaking, you must use **subpath imports**.
  68. >
  69. > Otherwise, since `@ui5/webcomponents-react` re-exports all components, **every component** (including those that depend on the `@ui5/webcomponents-fiori` package) will be included in your bundle, which will lead to errors due to the missing module.
  70. >
  71. > **✅ Do:**
  72. >
  73. > ```tsx
  74. > import { Button } from '@ui5/webcomponents-react/Button';
  75. > ```
  76. >
  77. > **❌ Don’t:**
  78. >
  79. > ```tsx
  80. > import { Button } from '@ui5/webcomponents-react';
  81. > ```
  82. #### Importing Assets
  83. The default assets import (`import '@ui5/webcomponents-react/dist/Assets.js';`) includes assets from the fiori package. Due to a limitation of Next.js (top-level await is not supported), we can't dynamically import the assets based on the installed packages.
  84. If you are using the minimal installation, please import the assets manually as follows:
  85. ```ts
  86. import '@ui5/webcomponents/dist/Assets.js';
  87. import '@ui5/webcomponents-react/dist/json-imports/i18n.js';
  88. //fetch
  89. import '@ui5/webcomponents/dist/Assets-fetch.js';
  90. import '@ui5/webcomponents-react/dist/json-imports/i18n-fetch.js';
  91. //node
  92. import '@ui5/webcomponents/dist/Assets-node.js';
  93. import '@ui5/webcomponents-react/dist/json-imports/i18n-node.js';
  94. ```
  95. ## End of Support for Version 1.x
  96. The support for version 1.x of `ui5-webcomponents-react` has ended on **July 1, 2025**. We recommend migrating to version 2.x as soon as possible. For more information, please refer to our [Migration Guide](https://ui5.github.io/webcomponents-react/v2/?path=/docs/migration-guide--docs).
  97. <!-- *********************************************************************** -->
  98. ## Getting Started
  99. ### Tutorial
  100. You are new to UI5 Web Components for React and don't know where to start?<br />
  101. Then take a look at our [Tutorial Mission](https://developers.sap.com/mission.react-spa.html) at “SAP Developers”!
  102. There you get a first glimpse at how easy it is to create an Application with UI5 Web Components for React.<br />
  103. 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.
  104. ### SAP Devtoberfest 2024 session
  105. In the [SAP Devtoberfest 2024](https://www.youtube.com/watch?v=lvpN3eK39h8) session, we showcased the most prominent new features in version 2 of UI5 Web Components and UI5 Web Components for React, and provided an example of how to migrate from version 1 to version 2 using our [Codemod](https://ui5.github.io/webcomponents-react/v2/?path=/docs/migration-guide--docs#codemod).
  106. ### SAP Devtoberfest 2023 session
  107. [Here](https://www.youtube.com/watch?v=zyOxgjoSnGw) you can find the video of our session for the SAP Devtoberfest 2023 (aired Sep 29, 2023). There we briefly explain why UI5 Web Components for React exist at all, where the project fits into the SAP UI stack and what advantages our wrapper has over implementations that use pure ui5-webcomponents.
  108. For the main part, we show how you could create a simple Movie Database UI, first by using our `Vite` template and then with our `Next.js` template.
  109. ### Examples & Templates
  110. You can find a curated list of project templates and examples on our [Project Templates & Examples page](https://ui5.github.io/webcomponents-react/v2/?path=/docs/project-templates-examples--docs).
  111. ### Add `@ui5/webcomponents-react` to an existing app
  112. 1. Install all [required dependencies](#download-and-installation)
  113. 2. Import the `ThemeProvider` component and wrap your root component with it:
  114. ```tsx
  115. import { ThemeProvider } from '@ui5/webcomponents-react/ThemeProvider';
  116. ...
  117. createRoot(document.getElementById('root') as HTMLElement).render(
  118. <ThemeProvider>
  119. <App />
  120. </ThemeProvider>,
  121. );
  122. ```
  123. 3. Use `@ui5/webcomponents-react` components in your app by importing them.
  124. For example, to use the `Button` component you need to import it:
  125. ```jsx
  126. import { Button } from '@ui5/webcomponents-react/Button'; // loads ui5-button wrapped in a ui5-webcomponents-react component
  127. ```
  128. 4. Add the imported component to your JSX:
  129. ```jsx
  130. <Button onClick={() => alert('Hello World!')}>Hello world!</Button>
  131. ```
  132. ### Browser Support
  133. UI5 Web Components for React supports the same [browsers and respective versions](https://github.com/UI5/webcomponents#browser-support) as UI5 Web Components.
  134. <!-- *********************************************************************** -->
  135. <a name="issues"></a>
  136. ## Known Issues
  137. Please take a look at our [GitHub Issues](https://github.com/UI5/webcomponents-react/issues).
  138. <!-- *********************************************************************** -->
  139. <a name="support"></a>
  140. ## How to obtain support
  141. We welcome all comments, suggestions, questions, and bug reports. Feel free to [open issues](https://github.com/UI5/webcomponents-react/issues/new/choose) or chat with us directly in the [`#webcomponents-react`](https://openui5.slack.com/archives/CSQEJ2J04) channel in the
  142. [OpenUI5 Community Slack](https://ui5-slack-invite.cfapps.eu10.hana.ondemand.com/).
  143. Please note that you have to join this Slack workspace via [this link](https://ui5-slack-invite.cfapps.eu10.hana.ondemand.com/) if you are not part of it already.
  144. <!-- *********************************************************************** -->
  145. <a name="contributing"></a>
  146. ## Contributing
  147. Please check our [Contribution Guidelines](/CONTRIBUTING.md).

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.