Selaa lähdekoodia

Document nativeEventListener

Guy Carmeli 6 vuotta sitten
vanhempi
commit
d7dac88c4d
1 muutettua tiedostoa jossa 18 lisäystä ja 1 poistoa
  1. 18
    1
      docs/docs/events.md

+ 18
- 1
docs/docs/events.md Näytä tiedosto

@@ -81,8 +81,25 @@ Navigation.events().registerCommandCompletedListener((commandId, completionTime,
81 81
 |       Parameter         | Description |
82 82
 |:--------------------:|:-----|
83 83
 |**commandId** | Id of the completed command|
84
-|**completionTime**|Timestamp when the comand, and consecutive animations, completed.|
84
+|**completionTime**|Timestamp when the command, and consecutive animations, completed.|
85 85
 
86
+## registerNativeEventListener
87
+
88
+The nativeEvent listener is used to track various events that originate in the native aspect of the app, primarily UI events.
89
+
90
+### `bottomTabSelected` event
91
+This event is emitted whenever a BottomTab is selected by the user
92
+|Parameter|Description|
93
+|:-:|:-|
94
+|**name**|`bottomTabSelected`|
95
+|**params**|`unselectedTabIndex`: The index of the previously selected tab<br>`selectedTabIndex`: The index of the newly selected tab|
96
+
97
+### `buttonPressed` event
98
+This event is emitted whenever a TopBat button is pressed by the user
99
+|Parameter|Description|
100
+|:-:|:-|
101
+|**name**|`buttonPressed`|
102
+|**params**|`componentId`: `componentId` of the layout element the pressed button is bound to<br>`buttonId`: `id` of the pressed button|
86 103
 
87 104
 ## onNavigationButtonPressed
88 105
 Called when a TopBar button is pressed.