Skip to content

Commit f73e0cb

Browse files
committed
📝 Updated README: Documentation WIP
1 parent a30a07d commit f73e0cb

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,7 @@ Enum string values you can use for the [`MenuConfig.imageType`](#332-menuconf
220220
* Import the enum like this: `import { ImageTypes } from "react-native-ios-context-menu";`
221221
* And use it like this: `{ imageType: ImageTypes.SYSTEM }`
222222
* Or you can directly pass a string like this: `{ imageType: 'SYSTEM' }`
223-
* Check out the [`ContextMenuView` Simple Example #2](#412-contextmenuview-simple-example-2) section for example usage.
223+
* Check out [Simple Example #2](#412-contextmenuview-simple-example-2) or [Simple Example #16](#4116-contextmenuview-simple-example-16) section for example usage.
224224

225225
<br>
226226

@@ -236,7 +236,7 @@ Enum string values you can use in a [`MenuConfig`](#332-menuconfig-o
236236
* Import the enum like this: `import { MenuOptions } from "react-native-ios-context-menu";`
237237
* And use it like this: `{ menuOptions: [MenuOptions.destructive] }`
238238
* Or you can directly pass a string like this: `{ menuOptions: ['destructive'] }`
239-
* Check out `ContextMenuView` [Simple Example #5](#415-contextmenuview-simple-example-5) and [Simple Example #6](#416-contextmenuview-simple-example-6) section for example usage.
239+
* Check out `ContextMenuView` [Simple Example #5](#415-contextmenuview-simple-example-5) and [Simple Example #6](#416-contextmenuview-simple-example-6) section for example usage.
240240

241241
<br>
242242

@@ -252,7 +252,7 @@ Enum string values you can use in a [`MenuAction`](#331-menuaction-object)
252252
* Import the enum like this: `import { MenuElementAtrributes } from "react-native-ios-context-menu";`
253253
* And use it like this: `menuAttributes: [MenuElementAtrributes.destructive]`
254254
* Or you can directly pass a string like this: `menuAttributes: ['destructive']`
255-
* Check out [Simple Example #4](#414-contextmenuview-simple-example-4) section for example usage.
255+
* Check out [Simple Example #4](#414-contextmenuview-simple-example-4) section for example usage.
256256

257257
<br>
258258

@@ -269,7 +269,7 @@ Enum string values you can use in a [`MenuAction`](#331-menuaction-object)
269269
* Import the enum like this: `import { UIMenuElementState } from "react-native-ios-context-menu";`
270270
* And use it like this: `{ menuState: UIMenuElementState.on }`
271271
* Or you can directly pass a string like this: `{ menuState: 'on' }`
272-
* Check out [`ContextMenuView`Simple Example #8](#418-contextmenuview-simple-example-8) section for example usage.
272+
* Check out [Simple Example #8](#418-contextmenuview-simple-example-8) section for example usage.
273273

274274
<br>
275275

@@ -1107,7 +1107,7 @@ function ContextMenuViewSimpleExample14(props) {
11071107

11081108
<br><br>
11091109

1110-
4.1.15 `ContextMenuView` [Simple Example #15](https://github.com/dominicstop/react-native-ios-context-menu/blob/master/example/src/components/ContextMenuView/ContextMenuViewSimpleExample14.js)
1110+
#### 4.1.15 `ContextMenuView` [Simple Example #15](https://github.com/dominicstop/react-native-ios-context-menu/blob/master/example/src/components/ContextMenuView/ContextMenuViewSimpleExample15.js)
11111111
A example context menu configured with a "target view". The "target view" is the view where the context menu preview will transition in and out from. Essentially, instead of transitioning the entire `ContextMenuView`, you can specify a specific view.
11121112
* If you have a custom preview configured, then the "target view" will be used to transition your custom preview.
11131113
* If you don't have a custom preview configured (like this example), then the "target view" will become the context menu preview.
@@ -1170,9 +1170,10 @@ class ContextMenuViewSimpleExample15 extends React.PureComponent {
11701170

11711171
<br><br>
11721172

1173-
4.1.15 `ContextMenuView` [Simple Example #15](https://github.com/dominicstop/react-native-ios-context-menu/blob/master/example/src/components/ContextMenuView/ContextMenuViewSimpleExample14.js)
1173+
#### 4.1.16 `ContextMenuView` [Simple Example #16](https://github.com/dominicstop/react-native-ios-context-menu/blob/master/example/src/components/ContextMenuView/ContextMenuViewSimpleExample16.js)
11741174
A example context menu configured to have 3 menu actions. The first action has no icon, the second uses a `SYSTEM` SF Symbols icon, and the third uses a `ASSET` icon.
11751175
* If you are using an `ASSET` icon, the the string that you pass to the `imageValue` property must correspond to an image asset in your Xcode project's `xcasset` catalog.
1176+
11761177
<br>
11771178

11781179
```jsx

0 commit comments

Comments
 (0)