{"id":16614643,"url":"https://github.com/wozjac/vscode-ui5-api-reference","last_synced_at":"2025-06-20T22:35:28.656Z","repository":{"id":49531310,"uuid":"374223737","full_name":"wozjac/vscode-ui5-api-reference","owner":"wozjac","description":"VSCode extension: SAPUI5/OpenUI5 Reference documentation in a side bar view","archived":false,"fork":false,"pushed_at":"2025-02-03T18:39:16.000Z","size":2439,"stargazers_count":5,"open_issues_count":5,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-13T11:03:20.076Z","etag":null,"topics":["api","docs","openui5","sapui5","ui5","vscode","vscode-extension"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wozjac.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","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":"2021-06-05T22:29:39.000Z","updated_at":"2024-11-17T17:59:37.000Z","dependencies_parsed_at":"2024-10-28T10:30:30.798Z","dependency_job_id":"40610877-b6f4-41f2-9ee2-204523fbee97","html_url":"https://github.com/wozjac/vscode-ui5-api-reference","commit_stats":{"total_commits":179,"total_committers":3,"mean_commits":"59.666666666666664","dds":"0.11731843575418999","last_synced_commit":"64ab375501edc50b34763d041e085d56188c20c5"},"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wozjac%2Fvscode-ui5-api-reference","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wozjac%2Fvscode-ui5-api-reference/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wozjac%2Fvscode-ui5-api-reference/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wozjac%2Fvscode-ui5-api-reference/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wozjac","download_url":"https://codeload.github.com/wozjac/vscode-ui5-api-reference/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244815169,"owners_count":20514908,"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":["api","docs","openui5","sapui5","ui5","vscode","vscode-extension"],"created_at":"2024-10-12T02:07:08.673Z","updated_at":"2025-03-21T14:31:22.107Z","avatar_url":"https://github.com/wozjac.png","language":"TypeScript","readme":"[![Build Status](https://github.com/wozjac/vscode-ui5-api-reference/actions/workflows/build.yml/badge.svg)](https://github.com/wozjac/vscode-ui5-api-reference/actions/workflows/build.yml)\n[![Coverage Status](https://coveralls.io/repos/github/wozjac/vscode-ui5-api-reference/badge.svg?branch=main)](https://coveralls.io/github/wozjac/vscode-ui5-api-reference?branch=main)\n[![GitHub license](https://img.shields.io/github/license/wozjac/vscode-ui5-api-reference)](https://github.com/wozjac/vscode-ui5-api-reference/blob/main/LICENSE)\n\n# VSCode UI5: API reference\n\nVS Code extension - SAP/Open UI5 reference view in a side bar view.\n\nVideo about features:\n\n[![Features video](assets/video.png)](https://www.youtube.com/watch?v=0-rLpBbXmEI \"Features video\")\n\n## Important\n\n**Since version 1.2.1 there is a new config field for the API URL version - please\nmigrate your setting from the old, deprecated one.**\n\n## Features\n\n- show/hide desciptions\n- filtering options (show only members like properties, aggregations)\n- full API (with inherited members)\n- favorites list for quick access\n\n## Installation\n\nSearch \u0026 install the extension via VSCode Extensions.\n\n## Usage\n\nAfter installation a new icon is available:  \n![Search icon](https://publicrepo.vipserv.org/images/vscode-api/icon-sidebar.png)  \nAPI side bar can be also opened using command:\n![show-command](https://publicrepo.vipserv.org/images/vscode-api/show-command.png)\n\n### Basic search\n\n- if an UI5 object can be matched with the search input, it will be displayed immadiately,\n  otherwise the hitlist is showed\n  ![Basic search](https://publicrepo.vipserv.org/images/vscode-api/basic-search.gif)\n\n- search can be done with or without namespace\n- search can be also triggered using command:\n  ![Search command](https://publicrepo.vipserv.org/images/vscode-api/search-command.gif)\n\n- clicking on the object name or method, property etc. will open the original UI5 API page in your default browser\n\n### Filtering\n\n- API can be filtered, for example typing \"hbox add\" will show only members matching \"add\".\n  Filtering works also if the hitlist if firstly displayed.\n- displaying specific members: ?p will display only properties, ?c - constructor, ?e - events,\n  ?m - methods, ?a - aggregations; for example hbox ?m will immediately display Hbox with\n  methods only. m.butt ?p will show hitlist first and after selecting an object\n  members filter will be applied, showing only properties\n\n  ![Filtering](https://publicrepo.vipserv.org/images/vscode-api/search-members1.gif)\n\n- members can be also filtered by a search term, for example to display only methods with \"add\", type \"hbox ?madd\"\n\n  ![Filtering](https://publicrepo.vipserv.org/images/vscode-api/search-members2.gif)\n\n- when an object's API is already displayed, putting only ?c, ?m etc. in the search input\n  will apply fitlering on this object. It might be also narrowed to searched string, for\n  example \"get...\" methods - ?mget etc.\n\n### Favorites\n\nThey can be used to have frequently used objects always available. Favorites are stored in the\nconfiguration (per workspace) and they can be maintained there or using the icons available\non the list and in the object API.\n![Favorites](https://publicrepo.vipserv.org/images/vscode-api/favorites.png)\n\n### XML views\n\nAPI can be also opened for controls in XML views; use the context menu option on a selected control:\n![Context menu](https://publicrepo.vipserv.org/images/vscode-api/context.gif)\n\n## Extension Settings\n\nThis extension contributes the following settings:\n\n- `apiURL`: the path to SAPUI5/OpenUI5 version; default is \u003chttps://openui5.hana.ondemand.com/1.120.15\u003e  \n  **Please remember to reload VS Code after changing this setting!**\n- `favorites`: the list of favorites UI5 objects; they can be added via configuration or using the icons in the panel\n- `hitlistSize`: maximum number of objects shown in the hitlist if multiple objects\n  matches the search query; if more objects is found, then the\n  hitlist is not displayed and you are asked to narrow your search\n\n## Release Notes\n\nSee CHANGELOG.md\n\n## License\n\nThis plugin is licensed under the [MIT license](http://opensource.org/licenses/MIT).\n\n## Author\n\nFeel free to contact me:\n\n- \u003cwozjac@zoho.com\u003e\n- [jacekw.dev](https://jacekw.dev)\n- Bluesky (\u003chttps://jacekwoz.bsky.social\u003e)\n- LinkedIn (\u003chttps://www.linkedin.com/in/jacek-wznk\u003e)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwozjac%2Fvscode-ui5-api-reference","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwozjac%2Fvscode-ui5-api-reference","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwozjac%2Fvscode-ui5-api-reference/lists"}