onedevatlasBeta
Browse the atlas
AllUI5CAPABAPBTP
IDE extensionIDE extensiontypeInstalls into a development environment (VS Code, Eclipse with ABAP Development Tools, SAP Business Application Studio) and works inside it, rather than as a library you call or a command you run.See every one →What this type is →independently maintainedindependently maintainedoriginPublished by one person or a small company outside SAP. Says nothing about quality; the readings say that.See every one →

vscode-ui5-api-reference

VS Code extension that shows the SAPUI5 and OpenUI5 API reference in a side bar view, with inherited members, member filters and a favourites list, for one framework version at a time.

Puts the UI5 API documentation in a VS Code side bar, so an object's members can be read next to the code that uses them. The view shows the full API including inherited members, can show or hide descriptions, filters to members such as properties or aggregations, and keeps a favourites list for quick access; the API of a control can also be opened from an XML view, and a search command lists matching objects up to the hitlistSize setting. It reads one framework version at a time: the apiURL setting holds the address, defaults in the extension's package.json to the 1.136.7 API of openui5.hana.ondemand.com (the README still names 1.120.15), and VS Code has to be reloaded after changing it.

GitHub5 ★
npm9/wk
Homepage

Facts

Latestv1.6.4ReleasedLast pushLicenceMIT

Where it sits

Lives in
UI5
Provides
DocumentationUI5DocumentationcapabilityFinding the answer in what has already been written, and writing it where it has not — first-party documentation made searchable by something other than a person scrolling it, including by an agent, and a document of custom code produced from the code itself.

Who is behind it

Jacek WozniczakJacek WozniczakPersonMaintains this
In the atlas: maintains 3, contributes to 4@wozjacmaintainerJakob Marius KjaerPersonContributes to this
In the atlas: maintains 2, contributes to 24, wrote 1@uxkjaer1 contributor

What it declares

Every artifact

Type
IDE extension
Origin
Independently maintained

As an IDE extension

Installs into
VS Code
Distributed through
Visual Studio Marketplace

Connections1

Install

npm add vscode-ui5-api-reference

Derived from the package name. No recipe recorded; the README has the configuration.

README

quoted from wozjac/vscode-ui5-api-reference under MIT, read
wozjac/vscode-ui5-api-reference/README.mdOn GitHub

Build Status Coverage Status GitHub license

VSCode UI5: API reference

VS Code extension - SAP/Open UI5 reference view in a side bar view.

Video about features:

Features video

Important

Since version 1.2.1 there is a new config field for the API URL version - please migrate your setting from the old, deprecated one.

Features

  • show/hide desciptions
  • filtering options (show only members like properties, aggregations)
  • full API (with inherited members)
  • favorites list for quick access

Installation

Search & install the extension via VSCode Extensions.

Usage

After installation a new icon is available:
Search icon
API side bar can be also opened using command: show-command

Basic search

  • if an UI5 object can be matched with the search input, it will be displayed immadiately, otherwise the hitlist is showed Basic search

  • search can be done with or without namespace

  • search can be also triggered using command: Search command

  • clicking on the object name or method, property etc. will open the original UI5 API page in your default browser

Filtering

  • API can be filtered, for example typing "hbox add" will show only members matching "add". Filtering works also if the hitlist if firstly displayed.

  • displaying specific members: ?p will display only properties, ?c - constructor, ?e - events, ?m - methods, ?a - aggregations; for example hbox ?m will immediately display Hbox with methods only. m.butt ?p will show hitlist first and after selecting an object members filter will be applied, showing only properties

    Filtering

  • members can be also filtered by a search term, for example to display only methods with "add", type "hbox ?madd"

    Filtering

  • when an object's API is already displayed, putting only ?c, ?m etc. in the search input will apply fitlering on this object. It might be also narrowed to searched string, for example "get..." methods - ?mget etc.

Favorites

They can be used to have frequently used objects always available. Favorites are stored in the configuration (per workspace) and they can be maintained there or using the icons available on the list and in the object API. Favorites

XML views

API can be also opened for controls in XML views; use the context menu option on a selected control: Context menu

Extension Settings

This extension contributes the following settings:

  • apiURL: the path to SAPUI5/OpenUI5 version; default is https://openui5.hana.ondemand.com/1.120.15
    Please remember to reload VS Code after changing this setting!
  • favorites: the list of favorites UI5 objects; they can be added via configuration or using the icons in the panel
  • hitlistSize: maximum number of objects shown in the hitlist if multiple objects matches the search query; if more objects is found, then the hitlist is not displayed and you are asked to narrow your search

Release Notes

See CHANGELOG.md

License

This plugin is licensed under the MIT license.

Author

Feel free to contact me:

MIT, read

History

Latest

v1.6.4

  1. v1.6.3

  2. v1.6.2

  3. v1.6.1

  4. v1.6.0

    Features 2

    Notes
    Features
    • default apiURL setting points to version 1.120.15 (ce35ca6)
    • show API version in the search input (45240df)

  5. v1.5.0

    Features 1

    Notes
    Features
    • change the default UI5 version to 1.114.3 (af90b63)

  6. v1.4.6

  7. v1.4.5

  8. v1.4.4

  9. v1.4.3

    Fixes 1

    Notes
    Bug Fixes
    • opening API object reference page twice (df13627)

  10. v1.4.2

  11. v1.4.1

    Fixes 2

    Notes
    Bug Fixes
    • aggregation type recognition (063a5a0)
    • correct description for deprecated properties (17eba2f)

  12. v1.4.0

    Features 2

    Notes
    Features
    • filtering by members on the currently opened object (cd7f7f7)
    • make hitlist size configurable (5196bf4)

  13. v1.3.0

    Features 1

    Notes
    Features
    • add favorites section and config (2e475b3)

  14. v1.2.1

    Fixes 1

    Notes
    Bug Fixes
    • correct extension settings, now prefixed (8340468)

  15. v1.2.0

    Features 1

    Notes
    Features
    • set default OpenUI5 API version to 1.96.10 (b426b67)

  16. v1.1.0

    Features 1

    Notes
    Features
    • add context menu item in XML views to open the reference panel for a control under selection (68fb62e)

  17. v1.0.4

  18. v1.0.3

  19. v1.0.2

  20. v1.0.1

  21. v1.0.0

On GitHub
5downloads per week, npm
Weekly downloads for vscode-ui5-api-reference26 complete calendar weeks from 2026-04-27 to 2026-10-25; the latest total is 5.27 Apr – 3 May: 14 May – 10 May: 1011 May – 17 May: 2518 May – 24 May: 1025 May – 31 May: 91 Jun – 7 Jun: 128 Jun – 14 Jun: 815 Jun – 21 Jun: 1522 Jun – 28 Jun: 729 Jun – 5 Jul: 126 Jul – 12 Jul: 1613 Jul – 19 Jul: 020 Jul – 26 Jul: 1227 Jul – 2 Aug: 13 Aug – 9 Aug: 810 Aug – 16 Aug: 617 Aug – 23 Aug: 624 Aug – 30 Aug: 1231 Aug – 6 Sept: 47 Sept – 13 Sept: 914 Sept – 20 Sept: 1521 Sept – 27 Sept: 1728 Sept – 4 Oct: 345 Oct – 11 Oct: 612 Oct – 18 Oct: 419 Oct – 25 Oct: 5

Others providing3

Compare all 4 on the Documentation page →
Documentation
  1. mcp-sap-docsMCP server searching seventeen SAP documentation repositories
  2. ui5-lib-diffHosted app listing changes between SAPUI5 or OpenUI5 versions
  3. @ui5/webcomponents-mcp-serverMCP server answering questions on UI5 Web Components

Details

Sources4
Added by handdiscovered herechecked
npm registry, vscode-ui5-api-referenceversion, releases, installschecked
github.com/git+https://github.com/wozjac/vscode-ui5-api-reference.gittree, pushes, contributors, CIchecked
README.mdquoted, and what the entry declareschecked

Sources are graph entities: the same page may back several entries, and an unreachable source flags every row that rests on it.

Compatibility and provenance
latestv1.6.4
first release
releases and cadence5, ~147d median
discovered viaAdded by hand
first seen in the atlas
ecosystem and domainui5, learning-and-reference
Contributors1
Jakob Marius Kjaer

From the repository’s contributor list, .

History in the atlas1
  1. First seen.
For your agent
Ref
artifact:wozjac-vscode-ui5-api-reference
JSON
/artifacts/wozjac-vscode-ui5-api-reference.json
MCP
Connecting an agent