docs: add SAPUI5 framework integration guide#13806
Open
ilhan007 wants to merge 5 commits into
Open
Conversation
Add a new article under Frameworks describing how to use UI5 Web Components inside a SAPUI5 (and OpenUI5) application: when to use them, how to scaffold and integrate a project via ui5-tooling-modules, the API mapping to SAPUI5 concepts, and the build-once-reuse-everywhere strategy.
|
🚀 Deployed on https://pr-13806--ui5-webcomponents-preview.netlify.app |
Verified the integration guide end-to-end against a real scaffolded
app. Fixes found during verification:
- Step 1: 'npx generator-easy-ui5 project' fails ('could not determine
executable to run') because generator-easy-ui5 is a Yeoman generator
with no npx bin. Use 'npx -p yo -p generator-easy-ui5 yo easy-ui5
project' instead (no global install needed).
- Drop the 'TypeScript' wording since the default template scaffolds a
JS app; point to the UI5 CLI Getting Started guide.
- Use the canonical ui5-community/generator-easy-ui5 repo link.
- Relax the -rte note: missing yaml files are skipped, so the
multi-file form is safe even with only ui5.yaml.
Switch Step 1 to the officially documented 'npm install -g yo generator-easy-ui5 && yo easy-ui5 project' form, matching the npm readme and UI5 CLI Getting Started guide. Keep the npx one-liner as a subtle inline fallback for those who prefer no global install.
Move the framework-agnostic 'build once, reuse everywhere' idea to the common Frameworks landing page, where it applies to all frameworks. Trim the SAPUI5 article's intro to a single sentence about components being delivered as Web Components to avoid duplication.
nnaydenow
approved these changes
Jul 10, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a new article under Frameworks → SAPUI5 documenting how to use UI5 Web Components inside a SAPUI5 (and OpenUI5) application.
See the preview (available until the PR is merged) here:
https://pr-13806--ui5-webcomponents-preview.netlify.app/docs/frameworks/SAPUI5/
The page covers:
generator-easy-ui5), installui5-tooling-modules, install the@ui5/webcomponents-*packages, and use the components in XML views and controllers.Links out to the official SAPUI5 "Using Web Components" topic and the
ui5-tsapp-webcshowcase for full details.Notes
docs/3-frameworks/05-SAPUI5.md.