Browse Source

Add Modal Dismissed Event Listener to doc (#4641)

Add Modal Dismissed Event Listener to doc
Shankar Prakash G 6 years ago
parent
commit
5be735078b
1 changed files with 18 additions and 0 deletions
  1. 18
    0
      docs/docs/events.md

+ 18
- 0
docs/docs/events.md View File

@@ -131,6 +131,24 @@ commandCompletedListener.remove();
131 131
 |**commandId** | Id of the completed command|
132 132
 |**completionTime**|Timestamp when the command, and consecutive animations, completed.|
133 133
 
134
+## registerModalDismissedListener
135
+Invoked when modal dismissed.
136
+
137
+```js
138
+// Subscribe
139
+const modalDismissedListener = Navigation.events().registerModalDismissedListener(({ componentId, modalsDismissed }) => {
140
+
141
+});
142
+...
143
+// Unsubscribe
144
+modalDismissedListener.remove();
145
+```
146
+
147
+|       Parameter         | Description |
148
+|:--------------------:|:-----|
149
+|**componentId** | Id of the modal|
150
+|**modalsDismissed**| Number of modal which were dismissed|
151
+
134 152
 ## registerBottomTabSelectedListener
135 153
 Invoked when a BottomTab is selected by the user.
136 154