OptionalactiveIf present, an animation currently targeting this view (or its subviews).
Whether to add item spacing after the last child in each row.
IHosannaView
OptionalaudioThis hint can be used in conjunction with the audio guide item
OptionalaudioIndicates whether the element can receive focus.
These are the children that are rendered on screen in the tree structure of the view
Number of columns per row. Can be a single number or an array describing each row.
Indicdates whether the view is a focus group which means it can have a focused child Otherwise it will be focused itself
OptionalcustomOptionalfocusedHow this group chooses a child when focus enters from outside the group.
PrivategridTotal height of the grid.
PrivategridTotal width of the grid.
Horizontal alignment of the grid content.
Indicates whether the element is currently focused.
If true, this view has been presented in an AggregateViewController
Spacing between items, as a number or [horizontal, vertical] tuple.
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.
PrivatelayoutList of child views to be laid out in the grid.
PrivatenumCached number of rows in the current layout.
OptionalparentPrivaterowHeights of each row in the grid.
PrivaterowWidths of each row in the grid.
PrivatespacingCached spacing constants [horizontal, vertical].
These are the children that were created in getViews, in a flat strcuture - it contains EVERYTHING that we declared.
Vertical alignment of the grid content.
The IHosannaView subclass that created us in getViews
Indicates whether the navigatable entity is visible.
PrivatexHorizontal offset for grid alignment.
PrivateyVertical offset for grid alignment.
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).
OptionalnextState: GridGroupStateBuilds 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: stringFinds the next focusable child in the specified direction.
The focus resolution event.
The next focusable view or undefined.
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
PrivategetReturns the number of columns for the given row. If columns is a number, returns that value.
If it is an array, returns the value at the given row index, falling back to the last entry
for rows beyond the array length.
PrivategetCompute flat index for a given row and column using the columns spec.
PrivategetReturns the grid height, using the configured height if set.
The measured grid height.
The height to use for the grid.
PrivategetCalculates the widths and heights of each row, and the total grid dimensions.
An object containing rowWidths, rowHeights, gridHeight, and gridWidth.
PrivategetReturns the grid width, using the configured width if set.
The measured grid width.
The width to use for the grid.
PrivategetComputes row/column indices for a flat child index given the columns-by-row rules.
PrivategetReturns the spacing constants as a [horizontal, vertical] tuple.
The spacing constants.
Rendererers
PrivategetCalculates the horizontal offset for grid alignment.
The total width of the grid.
The x offset.
PrivategetCalculates the horizontal offset for a specific row based on its width.
The index of the row.
The x offset for that row.
PrivategetCalculates the vertical offset for grid alignment.
The total height of the grid.
The y offset.
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
Lays out the grid group view at the specified position.
The x-coordinate.
The y-coordinate.
The width of the parent container.
The height of the parent container.
Lays out the child views in the grid according to the current configuration.
Measures the grid group and its children, updating layout properties.
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.
DO NOT CALL THIS METHOD DIRECTLY DO NOT OVERRIDE IT
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 events for the grid group view.
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.
Renders the grid group view with the given state changes.
Partial state changes to apply.
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: stringChanges 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.
GridGroupView is a composite view for displaying children in a grid layout.
Remarks