Refactor device info docs and reorganize view section - #96
Merged
Conversation
- Move soft_keyboard.md from device_capabilities to browser_interaction - Add new audio.md in device_capabilities with the Play Sounds content copied from barcode_scanning.md - Update sidebar config and fix internal link
Replace the obsolete info_frontend custom control with documentation for the s_device, s_ui5, s_focus, and s_scroll fields available directly on client->get( ).
Reference the new client->get( ) sub-structures (s_device, s_ui5, s_focus, s_scroll) and link to the Info page.
Absorb the UI5 1:1 framing, the 'Where to Look for Controls' pointers, and the 'Choosing a Control' table into definition.md. Delete the separate overview page and update the sidebar.
- Expression Binding -> Expressions - Translation, i18n -> Translation - follow_up_action -> Follow-up Action H1 titles updated to match. Body references to the underlying UI5 concept and the obsolete method name are kept verbatim.
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
This PR restructures the documentation for device capabilities and view definitions, moving content to better locations and updating examples to use the modern
client->get()API instead of deprecated custom controls.Key Changes
Device Info Documentation: Completely rewrote
docs/cookbook/device_capabilities/info.mdto document the current approach usingclient->get()with sub-structures (s_device,s_ui5,s_focus,s_scroll) instead of the deprecatedinfo_frontendcustom control. Replaced the old example class with modern code snippets showing how to access device, UI5, focus, and scroll information.View Documentation Reorganization:
docs/cookbook/view/overview.md(standalone file)docs/cookbook/view/definition.mdas new sections: "Sending a View", "Helper Class", "Where to Look for Controls", and "Choosing a Control"definition.mdinstead ofoverview.mdNew Audio Documentation: Added
docs/cookbook/device_capabilities/audio.mdwith examples of playing sound files via theplay_audiofrontend event.Navigation Updates:
Minor Title Updates: Capitalized "Follow-up Action" in the obsolete section heading for consistency.
Implementation Details
The device info refactor emphasizes the modern, simpler approach where frontend state is automatically shipped with every roundtrip via
client->get(), eliminating the need for custom controls and explicit event binding. Code examples now demonstrate accessing nested structures directly rather than using two-way binding patterns.https://claude.ai/code/session_01XTxcGzupMMYBibHdcpHtRH