{"id":15023950,"url":"https://github.com/sap/ui5-webcomponents-ngx","last_synced_at":"2026-03-04T14:03:15.497Z","repository":{"id":65761493,"uuid":"577838073","full_name":"SAP/ui5-webcomponents-ngx","owner":"SAP","description":"UI5 Web Components for Angular provides directives for each UI5 Web Component. The directives allow to easily build your Angular application following the SAP Design System.","archived":false,"fork":false,"pushed_at":"2025-03-26T13:25:51.000Z","size":13304,"stargazers_count":29,"open_issues_count":15,"forks_count":6,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-30T15:09:32.087Z","etag":null,"topics":["angular","open-source","typescript","ui-components","web-components"],"latest_commit_sha":null,"homepage":"https://ui5-webcomponents-ngx.netlify.app/","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.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-12-13T16:32:50.000Z","updated_at":"2025-03-25T14:40:07.000Z","dependencies_parsed_at":null,"dependency_job_id":"669499f4-835a-45fa-9792-294c5c1bc6d7","html_url":"https://github.com/SAP/ui5-webcomponents-ngx","commit_stats":{"total_commits":156,"total_committers":11,"mean_commits":"14.181818181818182","dds":0.5512820512820513,"last_synced_commit":"179b66889a3d349f83670e6b9d17f7e31eabcc06"},"previous_names":[],"tags_count":102,"template":false,"template_full_name":"SAP/repository-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SAP%2Fui5-webcomponents-ngx","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SAP%2Fui5-webcomponents-ngx/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SAP%2Fui5-webcomponents-ngx/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SAP%2Fui5-webcomponents-ngx/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SAP","download_url":"https://codeload.github.com/SAP/ui5-webcomponents-ngx/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247509221,"owners_count":20950232,"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":["angular","open-source","typescript","ui-components","web-components"],"created_at":"2024-09-24T19:59:38.506Z","updated_at":"2026-02-17T03:39:43.324Z","avatar_url":"https://github.com/SAP.png","language":"TypeScript","readme":"\u003ca href=\"https://api.reuse.software/info/github.com/SAP/ui5-webcomponents-ngx\" target=\"_blank\"\u003e\n  \u003cimg src=\"https://api.reuse.software/badge/github.com/SAP/ui5-webcomponents-ngx\" alt=\"REUSE status\"\u003e\n\u003c/a\u003e\n\n# UI5 Web Components for Angular\n\n## About this project\n\nThis is a wrapper around [@ui5/webcomponents](https://sap.github.io/ui5-webcomponents) project to make it work with\nAngular without\nneeding to use the [CUSTOM_ELEMENTS_SCHEMA](https://angular.io/api/core/CUSTOM_ELEMENTS_SCHEMA)\nor [NO_ERRORS_SCHEMA](https://angular.io/api/core/NO_ERRORS_SCHEMA) schemas,\nwhile providing full type safety and access to underlying web components in a type safe environment.\nEverything that works and is available on the [@ui5/webcomponents](https://sap.github.io/ui5-webcomponents) side.\n\n## Requirements and Setup\n\n* Angular 16 or higher. Other versions will not work because of the new Angular `required` inputs feature.\n\n### Installation\n\nVia npm:\n\n```bash\nnpm install @ui5/webcomponents-ngx\n```\n\nVia yarn:\n\n```bash\nyarn add @ui5/webcomponents-ngx\n```\n\n### Usage\n\nImport the module in your `app.module.ts` file:\n\n```typescript\nimport { BrowserModule } from '@angular/platform-browser';\nimport { NgModule } from '@angular/core';\nimport { AppComponent } from './app.component';\nimport { Ui5WebcomponentsModule } from '@ui5/webcomponents-ngx'; // here it is\n\n@NgModule({\n  declarations: [\n    AppComponent\n  ],\n  imports: [\n    BrowserModule,\n    Ui5WebcomponentsModule\n  ],\n  providers: [],\n  bootstrap: [AppComponent]\n})\nexport class AppModule {\n}\n```\n\nAnd that is it, you can now use any component described in\nthe [@ui5/webcomponents](https://sap.github.io/ui5-webcomponents)\ndocumentation.\n\n### Using Angular Components Inside UI5 Components\n\nAngular components often use selectors with hyphens (e.g. `\u003capp-item\u003e`, `\u003capp-value\u003e`).\nUI5 interprets such tags as custom elements and may wait **up to 1 second** for their registration, causing delayed rendering inside components like `\u003cui5-table-cell\u003e`.\n\nTo avoid this, configure UI5 to ignore Angular component prefixes:\n\n```ts\n// ui5-init.ts\nimport { ignoreCustomElements } from '@ui5/webcomponents-base/dist/IgnoreCustomElements.js';\n\nignoreCustomElements('app-');\n```\n\nImport it before Angular bootstraps:\n```ts\n// main.ts\nimport './ui5-init';\n```\n\nThis prevents unnecessary waiting, ensures smooth rendering, and improves performance when mixing Angular components with UI5 Web Components.\n\n### Angular Forms\n\nEvery form-capable component can be used with Angular's native form approaches. Meaning all the\n`formControlName` and `ngModel`s will work as expected.\n\n## Versions\n\nAngular Versions Support: Our versions offer Angular support. More information can be found [here](https://github.com/SAP/ui5-webcomponents-ngx/wiki/Angular-Versions-Support).\n\n## Support, Feedback, Contributing\n\nFor an overview on how this library works, see the [SAP Contribution Guidelines](https://github.com/SAP/.github/blob/main/CONTRIBUTING.md), the [Maintainers](https://github.com/SAP/ui5-webcomponents-ngx/blob/main/MAINTAINERS.md) documentation.\n\nThis project is open to feature requests/suggestions, bug reports etc.\nvia [GitHub issues](https://github.com/SAP/ui5-webcomponents-ngx/issues). Contribution and feedback are encouraged and\nalways welcome. For more information about how to contribute, the project structure, as well as additional contribution\ninformation, see our [Contribution Guidelines](https://github.com/SAP/ui5-webcomponents-ngx/blob/main/CONTRIBUTING.md).\n\n## Code of Conduct\n\nWe as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for\neveryone. By participating in this project, you agree to abide by\nits [Code of Conduct](https://github.com/SAP/ui5-webcomponents-ngx/blob/main/CODE_OF_CONDUCT.md) at all times.\n\n## Licensing\n\nCopyright 2022 SAP SE or an SAP affiliate company and ui5-webcomponents-ngx contributors. Please see\nour [LICENSE](https://github.com/SAP/ui5-webcomponents-ngx/blob/main/LICENSES/Apache-2.0.txt) for copyright and license\ninformation. Detailed information including third-party components and their licensing/copyright information is\navailable [via the REUSE tool](https://api.reuse.software/info/github.com/SAP/ui5-webcomponents-ngx).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsap%2Fui5-webcomponents-ngx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsap%2Fui5-webcomponents-ngx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsap%2Fui5-webcomponents-ngx/lists"}