Skip to content

Commit

Permalink
📝 Docs: Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
dominicstop committed Jan 6, 2023
1 parent eef2b3c commit dd919a1
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ Right usage:
#### 3.1.2 Props: Strings
| Name/Type | Default | Description |
|--------------------------------------------------------------|--------------------------------------------------------------|--------------------------------------------------------------|
| **modalID**: `string` | **Default**: `null` | Assign a unique ID to the modal. You can use the ID to refer to this modal when using the `RNIModalViewModule` functions and programatically control it. |
| **modalID**: `string` | **Default**: `null` | Assign a unique ID to the modal. You can use the ID to refer to this modal when using the `ModalViewModule` functions and programatically control it. |
| **modalTransitionStyle**: `UIModalTransitionStyles` value | **Default**: `coverVertical` | The transition style to use when presenting/dismissing a modal. If an invalid/unsupported value is passed, the default or the last supported value will be used. |
| **modalPresentationStyle**: `UIModalPresentationStyles` value | **Default**: `automatic` when on iOS 13+, otherwise `overFullScreen` | The presentation style to use when presenting/dismissing a modal. If an invalid/unsupported value is passed, the default or the last supported value will be used. |
| **modalBGBlurEffectStyle**: `UIBlurEffectStyles` value | **Default**: `systemThinMaterial` when on iOS 13+, otherwise `light` | The blur style to use for the `UIBlurEffect` modal background. If an invalid/unsupported value is passed, the default or the last supported value will be used. |
Expand Down Expand Up @@ -146,10 +146,10 @@ Right usage:
| **async** `setIsModalInPresentation(bool)` | When `setModalInPresentationFromProps` prop is true, it allows you to programatically set `isModalInPresentation` via function. |
<br/>

### 3.2 `RNIModalViewModule`
### 3.2 `ModalViewModule`
A `NativeModule` that's a collection of functions to programmatically control a `ModalView`
* Import the module: `import { RNIModalViewModule } from 'react-native-ios-modal'`
* Example Usage: `RNIModalViewModule.dismissAllModals(true)`
* Import the module: `import { ModalViewModule } from 'react-native-ios-modal'`
* Example Usage: `ModalViewModule.dismissAllModals(true)`

<br/>

Expand Down

0 comments on commit dd919a1

Please sign in to comment.