{"id":20484475,"url":"https://github.com/sap-samples/ui5-webcomponents-sample-vue","last_synced_at":"2025-04-07T07:08:24.450Z","repository":{"id":36929056,"uuid":"171758270","full_name":"SAP-samples/ui5-webcomponents-sample-vue","owner":"SAP-samples","description":"UI5 Web Components Sample TODO application built with Vue.","archived":false,"fork":false,"pushed_at":"2025-03-26T06:09:58.000Z","size":17735,"stargazers_count":59,"open_issues_count":4,"forks_count":22,"subscribers_count":12,"default_branch":"main","last_synced_at":"2025-03-31T05:08:00.435Z","etag":null,"topics":["sample","sample-code","ui5","ui5-webcomponents","vue"],"latest_commit_sha":null,"homepage":"https://sap-samples.github.io/ui5-webcomponents-sample-vue/ ","language":"Vue","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-20T22:20:01.000Z","updated_at":"2024-12-17T17:46:17.000Z","dependencies_parsed_at":"2023-11-21T14:04:02.630Z","dependency_job_id":"de3cd66a-93ab-48b8-8279-69e81d5d93a7","html_url":"https://github.com/SAP-samples/ui5-webcomponents-sample-vue","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-vue","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SAP-samples%2Fui5-webcomponents-sample-vue/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SAP-samples%2Fui5-webcomponents-sample-vue/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SAP-samples%2Fui5-webcomponents-sample-vue/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-vue/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247608151,"owners_count":20965952,"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":["sample","sample-code","ui5","ui5-webcomponents","vue"],"created_at":"2024-11-15T16:22:46.740Z","updated_at":"2025-04-07T07:08:24.427Z","avatar_url":"https://github.com/SAP-samples.png","language":"Vue","funding_links":[],"categories":[],"sub_categories":[],"readme":"![UI5 logo](/docs/images/UI5_logo_wide.png)\n[![CI](https://github.com/SAP-samples/ui5-webcomponents-sample-vue/actions/workflows/ci.yaml/badge.svg)](https://github.com/SAP-samples/ui5-webcomponents-sample-vue/actions/workflows/ci.yaml)\n[![REUSE status](https://api.reuse.software/badge/github.com/SAP-samples/ui5-webcomponents-sample-vue)](https://api.reuse.software/info/github.com/SAP-samples/ui5-webcomponents-sample-vue)\n\n# UI5 Web Components Vue Sample Application\n\n[Vue](https://vuejs.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 Vue build.\n \nThis project was bootstrapped with [Vue CLI](https://cli.vuejs.org/)\n \n## Prerequisites\n- [Node.js](https://nodejs.org/) (**version 8.5 or higher** ⚠️)\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-vue.git\n    cd ui5-webcomponents-sample-vue\n    ```\n1. Install all dependencies\n    ```sh\n    npm install\n    ```\n\n1. Start a local server and run the application. (The running application can be found here: http://localhost:5173)\n    ```sh\n    npm run dev\n    ```\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## Configure Vue to work with Web Components defined outside of it\n\nIt is recommended to exclude our custom elements from component resolution by specifying `compilerOptions.isCustomElement` in our `vite.config` file.\n\n```ts\n// vite.config.js\n\nimport { defineConfig } from 'vite'\nimport vue from '@vitejs/plugin-vue'\n\n// https://vitejs.dev/config/\nexport default defineConfig({\n  plugins: [\n    vue({\n      template: {\n        compilerOptions: {\n          // treat all tags with a \"ui5-\" prefix as custom elements\n          isCustomElement: tag =\u003e tag.startsWith('ui5-')\n        }\n      }\n    })\n  ]\n})\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/master/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/master/CONTRIBUTING.md).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsap-samples%2Fui5-webcomponents-sample-vue","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsap-samples%2Fui5-webcomponents-sample-vue","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsap-samples%2Fui5-webcomponents-sample-vue/lists"}