{"id":20484474,"url":"https://github.com/sap-samples/ui5-webcomponents-sample-react","last_synced_at":"2025-04-07T10:29:35.150Z","repository":{"id":37103164,"uuid":"171362623","full_name":"SAP-samples/ui5-webcomponents-sample-react","owner":"SAP-samples","description":"UI5 Web Components Sample TODO application built with React.","archived":false,"fork":false,"pushed_at":"2025-03-07T13:03:15.000Z","size":18297,"stargazers_count":56,"open_issues_count":6,"forks_count":23,"subscribers_count":13,"default_branch":"main","last_synced_at":"2025-03-31T09:06:57.270Z","etag":null,"topics":["reactjs","sample","sample-code","ui5","ui5-webcomponents"],"latest_commit_sha":null,"homepage":"https://sap-samples.github.io/ui5-webcomponents-sample-react/ ","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SAP-samples.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-02-18T22:02:54.000Z","updated_at":"2024-12-16T09:37:54.000Z","dependencies_parsed_at":"2023-11-21T14:04:51.089Z","dependency_job_id":"1f8d8d2d-b38e-4059-907f-096ccf6d4c01","html_url":"https://github.com/SAP-samples/ui5-webcomponents-sample-react","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SAP-samples%2Fui5-webcomponents-sample-react","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SAP-samples%2Fui5-webcomponents-sample-react/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SAP-samples%2Fui5-webcomponents-sample-react/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SAP-samples%2Fui5-webcomponents-sample-react/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SAP-samples","download_url":"https://codeload.github.com/SAP-samples/ui5-webcomponents-sample-react/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247635366,"owners_count":20970723,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["reactjs","sample","sample-code","ui5","ui5-webcomponents"],"created_at":"2024-11-15T16:22:46.150Z","updated_at":"2025-04-07T10:29:35.126Z","avatar_url":"https://github.com/SAP-samples.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![UI5 logo](/docs/images/UI5_logo_wide.png)\n[![CI](https://github.com/SAP-samples/ui5-webcomponents-sample-react/actions/workflows/ci.yml/badge.svg)](https://github.com/SAP-samples/ui5-webcomponents-sample-react/actions/workflows/ci.yml)\n[![REUSE status](https://api.reuse.software/badge/github.com/SAP-samples/ui5-webcomponents-sample-react)](https://api.reuse.software/info/github.com/SAP-samples/ui5-webcomponents-sample-react)\n\n# UI5 Web Components React Sample Application\n\n\n[React](https://reactjs.org/) sample application to demonstrate the usage of the [UI5 Web Components](https://github.com/SAP/ui5-webcomponents). It shows how to bind properties, to subscribe to events, using nested components and the bootstrapped React build.\n \nThis project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).\n \n## Prerequisites\n- [Node.js](https://nodejs.org/) (**version 8.5 or higher** ⚠️)\n- [Yarn](https://yarnpkg.com/en/) (Optional usage of yarn)\n\n## Getting started\n1. [Clone this repository](https://help.github.com/articles/cloning-a-repository/) using the [GitHub Command line tool](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) and navigate into the downloaded directory.\n    ```sh\n    git clone https://github.com/SAP-samples/ui5-webcomponents-sample-react.git\n    cd ui5-webcomponents-sample-react\n    ```\n2. Install all dependencies\n    ```sh\n    npm install\n    ```\n\n3.  Start a local server and run the application. (The running application can be found here: http://localhost:3000)\n    ```sh\n    npm start\n    ```\n\n## Noteworthy\n \n### Consume UI5 Web Components\nImport the desired component(s) in your app to define the UI5 Web Component.\n \nFor example, to use ```ui5-button``` you need to import it:\n \n```js\nimport \"@ui5/webcomponents/dist/Button\"; // loads ui5-button\n```\n \nThen, you can use the custom element in an HTML page:\n \n```html\n\u003cui5-button\u003eHello world!\u003c/ui5-button\u003e\n```\n\n## Browser support\n\nCurrently Chrome, Safari, Firefox and Edge (Chromium-based) support Web Components natively.\n\n\n## Configure React Build\nWhen UI5 Web Components are used they include all of their translation files and CLDR data files in the application bundle.\nIn order to decrease the bundle size of the application a custom Webpack configuration should be provided.\n(This configuration is already done for this project, so you will NOT be able to run ``` npm run eject```, because it is\none time operation, which can NOT be reverted.)\n\n1. Eject the react build with ```npm run eject```\n2. Open ```config/webpack.config.js``` file and add the following lines before the last loader:\n```js\n{\n  test: [/cldr\\/.*\\.json$/, /i18n\\/.*\\.json$/],\n  loader: 'file-loader',\n  options: {\n    name: 'static/media/[name].[hash:8].[ext]',\n  },\n  type: 'javascript/auto'\n},\n// \"file\" loader makes sure those assets get served by WebpackDevServer.\n// When you `import` an asset, you get its (virtual) filename.\n// In production, they would get copied to the `build` folder.\n// This loader doesn't use a \"test\" so it will catch all modules\n// that fall through the other loaders.\n```\n\n### Where is the npm package?\n- [UI5 Web Components](https://www.npmjs.com/package/@ui5/webcomponents)\n\n## Limitations\nNo limitations known.\n\n## Known Issues\nNo major bugs known.\n\n## Support\nWe welcome all comments, suggestions, questions, and bug reports. Please follow our [Support Guidelines](https://github.com/SAP/ui5-webcomponents/blob/main/SUPPORT.md#-content) on how to report an issue, or chat with us in the `#webcomponents` channel of the [OpenUI5 Community Slack](https://ui5-slack-invite.cfapps.eu10.hana.ondemand.com/).\n\n## Contribute to UI5 Web Components\nPlease check our [Contribution Guidelines](https://github.com/SAP/ui5-webcomponents/blob/main/CONTRIBUTING.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsap-samples%2Fui5-webcomponents-sample-react","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsap-samples%2Fui5-webcomponents-sample-react","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsap-samples%2Fui5-webcomponents-sample-react/lists"}