Global

Type Definitions

AppNavigatorOptions

Type:
  • Object
Properties:
Name Type Description
initialScreen string The initial screen for the miniapp. If falsy, the first screen defined in the screens will be used.
Source:

Button

Type:
  • Object
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 '.'.
accessibilityLabel string <nullable>
The text to read out with screen-reader technology.
Source:

LeftButton

Type:
  • Object
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 '.'.
accessibilityLabel string <nullable>
The text to read out with screen-reader technology.
Source:
Type:
  • Object
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).
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.
Source: