Timer: document the third START_TIMER argument that keeps the busy indicator down - #342
Merged
Merged
Conversation
abap2UI5#2799 (e5c3fb3 on main) lets follow_up_action( cs_event-start_timer ) take an optional third t_arg, `X` - the tick's check_no_busy. A poll or a carousel whose backend call takes longer than a second no longer flashes the full-screen busy overlay. - cookbook/browser_interaction/timer.md: a section on the flag - when to use it (a background poll, a carousel or ticker nobody is waiting on), that it belongs to the tick each call arms, why it is written `X` and not abap_true (abaplint's check_syntax rejects a c value as a string_table row - checked against main with the check:examples setup), and that only the overlay goes: a click that lands during the tick is still dropped by the busy guard and raises the overlay at once. The page's opening points to it. - resources/deprecations.md: under Invisible custom controls, a pointer from the Timer control's check_no_busy wire to the flag, marked *next release* - 1.145.0 reads two arguments and ignores a third. - resources/api.md, public/api/client-api.json: regenerated with `npm run generate:api` (A2UI5_HOME at a clone of abap2UI5 main), as AGENTS.md prescribes when check:api-reference fails - it did, on the new cs_event-start_timer paragraph of the follow_up_action ABAP Doc. That paragraph is the whole diff. The release notes get no entry: resources/changelog.md is written per release and has no unreleased section. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014bLQZPXbB8xmewCNmnBJaG
The obsolete Timer must not be used, so the note no longer describes how to use it - it tells the reader that a Timer with check_no_busy migrates to the same flag on cs_event-start_timer. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014bLQZPXbB8xmewCNmnBJaG
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.
abap2UI5/abap2UI5#2799 gave
cs_event-start_timeran optional third argument:Xkeeps the busy indicator down for the tick. This PR documents it.Changes
cookbook/browser_interaction/timer.md: a one-line pointer in the intro and a new section, "Without the Busy Indicator".TICKhandler that re-arms with(TICK) (5000) (X).`X`, notabap_true:t_argis a string table, and abaplint rejects( abap_true )as a row.check_no_busyon an_event( )wire.resources/deprecations.md: under "Invisible custom controls", a migration note. ATimerwhosefinishedwire useds_ctrl-check_no_busymigrates to the same flag oncs_event-start_timer. It is marked next release, because 1.145.0 reads only two arguments.resources/api.mdandpublic/api/client-api.json: regenerated withnpm run generate:apifrom core main (e5c3fb3). The only change is the newcs_event-start_timerparagraph.Checks
npm run check: all 15 gates pass.test271/271;build35,802 internal links, none dead.check:examples70 examples compile against main;check:api-referencematches main.check:versioncould only compare the three local places (the GitHub release API answered 403); the tags confirm 1.145.0.deprecations.md,check:line-length,check:vocabulary,check:conventions,check:api-namesandbuildwere re-run; all pass.On the next framework release: replace the next release marker in
deprecations.mdwith the version number.🤖 Generated with Claude Code
https://claude.ai/code/session_014bLQZPXbB8xmewCNmnBJaG
Generated by Claude Code