Skip to content

Commit b56f291

Browse files
committed
📝 Updated README: Documentation WIP
1 parent 74433a5 commit b56f291

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,8 @@ import { ContextMenuButton } from "react-native-ios-context-menu";
185185

186186
## 3. Documentation
187187
### 3.1 Modules/Components
188-
#### 3.1.1 `ContextMenuView` Component Props
188+
#### 3.1.1 `ContextMenuView` Component
189+
##### `ContextMenuView` Props
189190

190191
| Prop | Type | Description |
191192
|--------------------------|--------------------------------------------------------------|--------------------------------------------------------------|
@@ -205,7 +206,16 @@ import { ContextMenuButton } from "react-native-ios-context-menu";
205206

206207
<br>
207208

208-
#### 3.1.2 `ContextMenuButton` Component Props
209+
##### `ContextMenuView` Functions
210+
211+
| Name | Description |
212+
|-----------------|--------------------------------------------------------------|
213+
| `dismissMenu()` | Allows you to programmatically dismiss the context menu. Only available on iOS 14 and above. |
214+
215+
<br>
216+
217+
#### 3.1.2 `ContextMenuButton` Component
218+
##### `ContextMenuButton` Props
209219

210220
| Prop | Type | Description |
211221
|--------------------------|------------------------------------------------------|--------------------------------------------------------------|
@@ -221,6 +231,15 @@ import { ContextMenuButton } from "react-native-ios-context-menu";
221231
| `onMenuWillCancel` | **Event**: Function | Same as `ContextMenuView` |
222232
| `onMenuDidCancel` | **Event**: Function | Same as `ContextMenuView` |
223233
| `onPressMenuItem` | **Event**: Function `onPressMenuItem({nativeEvent})` | Same as `ContextMenuView` |
234+
235+
<br>
236+
237+
##### `ContextMenuButton` Functions
238+
239+
| Name | Description |
240+
|-----------------|--------------------------------------------------------------|
241+
| `dismissMenu()` | Allows you to programmatically dismiss the context menu. Only available on iOS 14 and above. |
242+
224243
<br>
225244

226245
#### 3.1.2 `ActionSheetFallback` Module

0 commit comments

Comments
 (0)