OptionalactiveIf present, an animation currently targeting this view (or its subviews).
IHosannaView
OptionalaudioThis hint can be used in conjunction with the audio guide item
OptionalaudioBackground color.
URI for the button background image.
Indicates whether the element can receive focus.
These are the children that are rendered on screen in the tree structure of the view
Whether the button is collapsed.
Text color.
Whether this is a composite view.
OptionalcustomWhether the button expands on focus.
OptionalfocusedPadding for the focus rect when backgroundUri is set, as { top, right, bottom, left }.
Button height.
OptionalhorizontalHorizontal alignment from style (e.g. "left", "center").
Icon color.
Gap between icon and label when both present.
Icon size as [width, height]. Default 36x36.
Style key for the icon.
URI for the button icon.
Whether the button is active.
Whether the button is focused.
If true, this view has been presented in an AggregateViewController
Whether the button is selected.
Automatic keyboard avoidance opt-out. When a software keyboard appears, the framework translates the visible screen to keep the editing input in view; set 'none' on the screen or the input to disable. Plain field (not reactive) — checked at keyboard-show time.
PrivatemeasurementOptionalonClick event handler.
Padding for the button label/content, as { top, right, bottom, left }.
OptionalparentThese are the children that were created in getViews, in a flat strcuture - it contains EVERYTHING that we declared.
The button text.
Font key for the button title.
The IHosannaView subclass that created us in getViews
Indicates whether the navigatable entity is visible.
Button width.
Children
OptionalmountTarget: IHosannaView<ViewState>View Creation
Convenience: animate logical properties across this view's subtree.
Animation specification mapping view IDs to their target property values
Animation duration in milliseconds
OptionalonCompleted: () => voidOptional callback invoked when animation completes
Optionaloptions: Partial<AnimationOptions>Extra animation options; duration and useCurrentState here are ignored (see HosannaViewAnimator.animateViews).
Keep the resting view status in sync with isSelected for buttons that drive selection
via that prop (e.g. TabSelector tabs). Focus/blur already resolve the focused-vs-resting
look, but when isSelected changes while the button is NOT focused (a sibling becomes
selected, or the initial selected item that never received focus) no focus/blur fires, so
the resting status would be stale.
Deliberately narrow so it never clobbers callers that manage viewStatus themselves
without using selection (e.g. CheckBox passes a viewStatus and never sets isSelected):
Selected when isSelected is explicitly true this render;Normal on a real true -> false transition (was selected, now not).
A button whose isSelected was never true is left untouched. Focused buttons are skipped
so a freshly-selected item that keeps focus stays in its focused style.OptionalnextState: TBuilds the view and attaches it to the view owner.
OptionalmountTarget: IHosannaView<ViewState>The target to mount the view.
The built view or undefined.
Optionaloptions: IScreenDismissOptionsOptionalargs: Record<string, unknown>OptionalcancellationToken: HsCancellationTokenOptionaltaskId: stringAsync Support
Optionalargs: Record<string, unknown>Optionalcallback: AsyncCommandEventCallbackOptionaltaskId: stringResolves the next focusable element in the given direction.
The event containing details about the focus transition.
The next focusable element, or undefined if none exists.
Default animation provider mapping for simple properties. By default, maps 'opacity' to the base renderer's 'opacity' field. Views can override to provide richer mappings.
Audio guide support
Measurement
Rendererers
Hibernates the view and its subviews by releasing native renderers and setting the view phase to Hibernating.
The view to be added as a subview.
index of the child in the parent view, -1 means add to end
Focus
Measures and sets the calculated width and height of the button based on its content.
Called when this view becomes the visible top again after having been covered by another screen on the same NavController (same transition finish as onAppear, immediately after it).
Prefer overriding onDidReappearInAggregateView; default implementation chains from it.
Handles blur event, collapsing the button if needed.
Called after the navigatable entity has been added to an aggregate view.
The aggregate view to which the entity has been added.
Called when this view becomes the visible top of its owning NavController stack for the first time (after onDidAddToAggregateView). Default implementation delegates to onAppear and onFirstAppear.
The aggregate view (e.g. NavController) whose transition finished.
Called when this view becomes the visible top again after having been covered by another screen on the same NavController. Default implementation delegates to onAppear and onAppearAgain.
The aggregate view (e.g. NavController) whose transition finished.
Called after the navigatable entity has been removed from an aggregate view.
The aggregate view from which the entity has been removed.
Called when this view is hidden during an aggregate transition or via BaseAggregateView.hideView.
Default implementation delegates to onDisappear.
The aggregate view from which this view is disappearing.
Called when this view becomes the visible top of a NavController stack for the first time for that controller (same transition finish as onAppear, immediately after it).
Prefer overriding onDidAppearInAggregateView; default implementation chains from it.
Handles focus event, expanding the button if needed.
Handles key events, triggering the click handler on OK key.
The key event.
Handles view phase changes, such as mounting and expanding/collapsing.
The current view phase.
Called before the navigatable entity is added to an aggregate view.
The aggregate view to which the entity will be added.
This method is called before applying state changes to the view. It is used to perform any necessary preparations before the state changes are applied.
Called before the navigatable entity is removed from an aggregate view.
The aggregate view from which the entity will be removed.
Called by InstancePool.get() before a pooled instance is handed out. Restores the view to a construction-equivalent state so that stale lifecycle data (focus, viewStatus, old text, dirty flags, etc.) from the previous owner does not bleed into the new one.
Class-default
values (captured on first construction into the
InstancePool per-class-name registry) are placed into pendingState
with state left empty — matching a freshly-constructed view. This guarantees that every subsequent
setField call (in applyInitialState) detects a difference
against the empty state and pushes the value into pendingState,
so applyLayoutStateToNativeRenderer applies ALL layout props
(opacity, visible, translation, …) to the newly-acquired renderer
even when the logical value equals the class default.
Presents a new screen in the navigation stack or as a dialog.
The screen to be presented, represented by a ViewStruct<ViewState>.
Optionaloptions: IScreenPresentationOptionsOptional presentation options.
If true, the screen will be presented as a dialog.
If true, the screen transition will be animated.
Sets which direct child this composite prefers on the next focus cascade, or moves focus to that child if this view is already in the focus chain.
First / Last: first or last direct child in children order with canReceiveFocus && visible.Default: clears focusedChildId only (next cascade uses getInitialFocusId()); does not call setFocus.Specific: same behavior as setFocusedSubview for a known child id.OptionalchildId: stringPrivateresolveResolves an { top, right, bottom, left } inset object to a [left, top, right, bottom]
tuple for layout math. Any omitted edge defaults to 0.
Changes the visual z-order of a child by moving it to a new index. Higher indices render on top. Updates both the children array and the renderer. Requires removeChild before insertChild because the SG node's insertChild always adds (splices in) and does not move; calling it on an already-present child would duplicate.
Navigatable View
Wakes up the view and its subviews by reserving native renderers and setting the view phase to Mounted.
ButtonView is a composite view for displaying a customizable button with text, icon, and background.
Remarks
Example