/ui5-api

name: ui5-api
description: Quick API reference lookup for UI5 controls, methods, events, and properties
allowed-tools:
  - Read
  - Grep
  - Glob
  - Bash
  - mcp__plugin_sapui5_ui5-tooling__get_ui5_api
argument-hint: "<control> [member]"
arguments:
  - name: control
    description: Control name (e.g., sap.m.Table, Button, List)
    required: true
  - name: member
    description: Optional method, event, or property name
    required: false

Shell Snippet Notes

• Shell snippets assume Bash on Linux/macOS, WSL2, or Git Bash.
• Install the command-specific tooling shown near each snippet before running it.
• Confirm before running commands that delete files, change ownership, deploy, or modify remote systems.

Output Contract

Return UI5 API details, version compatibility, examples, related controls, and fallback lookup links. Default to read-only lookup and do not modify project files.

UI5 API Reference: {{control}}{{#if member}}.{{member}}{{/if}}

Looking up API documentation for `{{control}}`{{#if member}} member `{{member}}`{{/if}}...

Quick Reference Lookup

Use the ui5-api-explorer agent or MCP tooling to gather:

1. **Check MCP availability**: Try @ui5/mcp-server first 2. **Determine version**: Use your project's UI5 version or latest 3. **Fetch documentation**: Get complete API reference 4. **Generate examples**: Show working code examples 5. **Suggest related**: Recommend related APIs

This provides faster access than visiting ui5.sap.com manually.

---

**Route to ui5-api-explorer when available.**

Expected output:

• Full control documentation (if no member specified)
• Specific method/event/property documentation (if member specified)
• Code examples
• Version compatibility
• Common patterns
• Related APIs

---

Fallback (If Agent Unavailable)

If the agent is unavailable, use this manual lookup information:

Online Documentation

**API Reference**:

https://ui5.sap.com/1.120.0/#/api/{{control}}

**Samples**:

https://ui5.sap.com/1.120.0/#/entity/{{control}}

Local Search

Search your project for existing usage:

grep -r "{{control}}" webapp/ --include="*.xml" --include="*.js"

Common Controls Quick Reference

**sap.m Library** (Mobile/Responsive):

• `sap.m.Table` - Responsive table for mobile/desktop
• `sap.m.List` - Simple vertical list
• `sap.m.Button` - Standard button
• `sap.m.Input` - Text input field
• `sap.m.Page` - Page container with header/footer
• `sap.m.Dialog` - Modal dialog
• `sap.m.MessageBox` - Alert/confirm dialogs

**sap.ui.table Library** (Desktop Tables):

• `sap.ui.table.Table` - Virtualized table for large datasets
• `sap.ui.table.TreeTable` - Hierarchical tree table

**sap.ui.layout Library**:

• `sap.ui.layout.Grid` - Responsive grid layout
• `sap.ui.layout.Splitter` - Resizable split panes
• `sap.ui.layout.VerticalLayout` - Vertical container

**sap.ui.core Library**:

• `sap.ui.core.mvc.Controller` - MVC controller base
• `sap.ui.core.mvc.View` - MVC view base
• `sap.ui.core.UIComponent` - Component base class

For detailed API documentation, the ui5-api-explorer agent provides comprehensive information with examples.