Globals

Type Definitions

AppNavigatorOptions

Properties

Name	Type	Description
`initialScreen`	string	The initial screen for the miniapp. If falsy, the first screen defined in the screens will be used.

Details

NavigationBar

Properties

Name	Type	Attributes	Description
`title`	string		The title for the navigation bar.
`overlay`	boolean	<nullable>	(optional) Show this page as an overlay (navigate only).
`hide`	boolean	<nullable>	(optional) Hide this page's navigation bar.
`buttons`	Array.<Button>		The Buttons to display on the right side of the navigation bar.
`leftButton`	LeftButton	<nullable>	The LeftButton to display on the left side of the navigation bar.

Details

RouteOptions

Properties

Name	Type	Attributes	Description
`overlay`	boolean	<nullable>	(optional) Show this page as an overlay (navigate only).
`replace`	boolean	<nullable>	(optional) Replace the current page with this page in the stack.

Details

Button

Properties

Name	Type	Attributes	Description
`icon`	string	<nullable>	The location of the icon (use `Image.resolveAssetSource(iconFile).uri`) or the name of a built-in icon.
`title`	string	<nullable>	The title for the button; will be used in case of missing or invalid icon.
`id`	string		The ID of the button; will be used in header button events. Cannot contain '.'.
`adaLabel`	string	<nullable>	The text to read out with screen-reader technology.

Details

LeftButton

Properties

Name	Type	Attributes	Description
`icon`	string	<nullable>	The location of the icon (use `Image.resolveAssetSource(iconFile).uri`) or the name of a built-in icon.
`title`	string	<nullable>	The title for the button (iOS only).
`id`	string	<nullable>	The ID of the button; will be used in header button events. If set, the press event must be handled on the JavaScript side, as native will no longer handle the back press. Cannot contain '.'.
`adaLabel`	string	<nullable>	The text to read out with screen-reader technology.

Details

NavigationEvent

Properties

Name	Type	Attributes	Description
`eventType`	'BUTTON_CLICK' \| 'DID_FOCUS' \| 'DID_BLUR' \| 'APP_DATA'		The type of the event.
`viewId`	string		The UUID for the view on which the event was fired.
`jsonPayload`	string	<nullable>	The payload for the event as stringified JSON.

Details