Skip to content

Commit 20f00d2

Browse files
authored
Merge pull request #98 from abap2UI5/claude/dazzling-galileo-KKoZS
Add Cookbook overview page and update navigation links
2 parents 5be438a + 01d6aed commit 20f00d2

2 files changed

Lines changed: 44 additions & 2 deletions

File tree

docs/.vitepress/config.mjs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ export default defineConfig({
6060
text: "Guide",
6161
items: [
6262
{ text: "Introduction", link: "/get_started/about" },
63-
{ text: "Cookbook", link: "/cookbook/event_navigation/life_cycle" },
63+
{ text: "Cookbook", link: "/cookbook/overview" },
6464
{ text: "Configuration", link: "/configuration/setup" },
6565
{ text: "Advanced Topic", link: "/advanced/downporting" },
6666
{ text: "Technical Insight", link: "/technical/concept" },
@@ -119,9 +119,10 @@ export default defineConfig({
119119
},
120120
{
121121
text: "Cookbook",
122-
link: "/cookbook/event_navigation/life_cycle",
122+
link: "/cookbook/overview",
123123
collapsed: true,
124124
items: [
125+
{ text: "Overview", link: "/cookbook/overview" },
125126
{
126127
text: "View",
127128
link: "/cookbook/view/definition",

docs/cookbook/overview.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
outline: [2, 4]
3+
---
4+
# Overview
5+
6+
The Cookbook collects task-oriented recipes for everyday abap2UI5 development. Each section focuses on one area of the framework and shows the patterns you reach for most often. Use this page as a map — pick the topic that matches the problem in front of you and jump straight in.
7+
8+
### Sections
9+
10+
#### [View](/cookbook/view/definition)
11+
Build the XML view your app sends to the browser. Covers the basic view definition, nesting views inside other views, and XML templating for repeating structures.
12+
13+
#### [Model](/cookbook/model/binding)
14+
Share data between ABAP and the frontend. Explains one-way and two-way binding, expressions and formatters, tables and trees, the device model, and how to deal with the model size limit.
15+
16+
#### [Event, Navigation](/cookbook/event_navigation/life_cycle)
17+
Understand how a request flows through your app. Covers the lifecycle, backend and frontend events, actions, navigation between apps, and exception handling.
18+
19+
#### [Popup, Popover](/cookbook/popup_popover/popup)
20+
Overlay parts of the view with dialogs and popovers — custom popups, popovers anchored to a control, and the built-in dialogs the framework ships out of the box.
21+
22+
#### [Translation, Messages](/cookbook/translation_messages/message)
23+
Communicate with the user. Show message toasts and message boxes, write to the application log, and translate text with `i18n`.
24+
25+
#### [Browser Interaction](/cookbook/browser_interaction/title)
26+
Reach into the browser from ABAP — set the tab title, control focus and scrolling, run timers, access the clipboard, work with the URL, and handle the soft keyboard on mobile.
27+
28+
#### [Device Capabilities](/cookbook/device_capabilities/info)
29+
Read device info and use native hardware: camera, geolocation, barcode scanning, audio, and file upload/download including PDF and spreadsheet generation.
30+
31+
#### [Beyond Basics](/cookbook/expert_more/lock)
32+
Advanced topics for production apps — sessions and communication (locking, statefulness, WebSocket, OData, app state), EML/CDS/SQL integration with RAP, recurring patterns and helpers, troubleshooting, and a list of obsolete features kept for reference.
33+
34+
### How to Use This Cookbook
35+
36+
- Each recipe stands on its own — read only the section you need.
37+
- Code snippets are copy-paste ready. Drop them into a class that implements `z2ui5_if_app`.
38+
- For full sample apps, browse the 250+ examples in the [samples repository](https://github.com/abap2UI5/samples).
39+
- For the API surface (`z2ui5_if_client`, `z2ui5_cl_xml_view`, …), read the source in the [main repository](https://github.com/abap2UI5/abap2UI5).
40+
41+
→ New to abap2UI5? Start with the [Getting Started Guide](/get_started/quickstart).

0 commit comments

Comments
 (0)