Skip to content

Commit c6c41d0

Browse files
committed
update docs
1 parent e8fe561 commit c6c41d0

File tree

1 file changed

+18
-28
lines changed

1 file changed

+18
-28
lines changed

README.md

Lines changed: 18 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ cd ios && pod install && cd ..
4444

4545
### Basic Example
4646

47-
```javascript
47+
```javascript{% raw %}
4848
import React, { useState, useEffect } from 'react'
4949
import { Image } from 'react-native'
5050
import DocumentScanner from 'react-native-document-scanner-plugin'
@@ -76,37 +76,37 @@ export default () => {
7676
/>
7777
)
7878
}
79-
```
79+
{% endraw %}```
8080
8181
Here's what this example looks like with several items
8282
83-
https://user-images.githubusercontent.com/26162804/160264220-0a77a55c-33b1-492a-9617-6d2c083b0583.mp4
83+
<video src="https://user-images.githubusercontent.com/26162804/160264220-0a77a55c-33b1-492a-9617-6d2c083b0583.mp4" data-canonical-src="https://user-images.githubusercontent.com/26162804/160264220-0a77a55c-33b1-492a-9617-6d2c083b0583.mp4" controls="controls" muted="muted" class="d-block rounded-bottom-2 border-top width-fit" style="max-height:640px;"></video>
8484
85-
https://user-images.githubusercontent.com/26162804/160264222-bef1ba3d-d6c1-43c8-ba2e-77ff5baef836.mp4
85+
<video src="https://user-images.githubusercontent.com/26162804/160264222-bef1ba3d-d6c1-43c8-ba2e-77ff5baef836.mp4" data-canonical-src="https://user-images.githubusercontent.com/26162804/160264222-bef1ba3d-d6c1-43c8-ba2e-77ff5baef836.mp4" controls="controls" muted="muted" class="d-block rounded-bottom-2 border-top width-fit" style="max-height:640px;"></video>
8686
87-
https://user-images.githubusercontent.com/26162804/161643046-57536193-0c6c-4edf-8f29-6f3ef9854dc5.mp4
87+
<video src="https://user-images.githubusercontent.com/26162804/161643046-57536193-0c6c-4edf-8f29-6f3ef9854dc5.mp4" data-canonical-src="https://user-images.githubusercontent.com/26162804/161643046-57536193-0c6c-4edf-8f29-6f3ef9854dc5.mp4" controls="controls" muted="muted" class="d-block rounded-bottom-2 border-top width-fit" style="max-height:640px;"></video>
8888
89-
https://user-images.githubusercontent.com/26162804/161643075-365b5008-4bc8-4507-969d-b2c188f372ec.mp4
89+
<video src="https://user-images.githubusercontent.com/26162804/161643075-365b5008-4bc8-4507-969d-b2c188f372ec.mp4" data-canonical-src="https://user-images.githubusercontent.com/26162804/161643075-365b5008-4bc8-4507-969d-b2c188f372ec.mp4" controls="controls" muted="muted" class="d-block rounded-bottom-2 border-top width-fit" style="max-height:640px;"></video>
9090
91-
https://user-images.githubusercontent.com/26162804/161643102-35283536-73a3-4b05-bd76-c06514ca3928.mp4
91+
<video src="https://user-images.githubusercontent.com/26162804/161643102-35283536-73a3-4b05-bd76-c06514ca3928.mp4" data-canonical-src="https://user-images.githubusercontent.com/26162804/161643102-35283536-73a3-4b05-bd76-c06514ca3928.mp4" controls="controls" muted="muted" class="d-block rounded-bottom-2 border-top width-fit" style="max-height:640px;"></video>
9292
93-
https://user-images.githubusercontent.com/26162804/161643126-f5c2461d-768d-481c-8dee-4d74a0cae778.mp4
93+
<video src="https://user-images.githubusercontent.com/26162804/161643126-f5c2461d-768d-481c-8dee-4d74a0cae778.mp4" data-canonical-src="https://user-images.githubusercontent.com/26162804/161643126-f5c2461d-768d-481c-8dee-4d74a0cae778.mp4" controls="controls" muted="muted" class="d-block rounded-bottom-2 border-top width-fit" style="max-height:640px;"></video>
9494
95-
https://user-images.githubusercontent.com/26162804/161643156-4ce1abac-d78b-4211-a99a-f0bebd40e2a6.mp4
95+
<video src="https://user-images.githubusercontent.com/26162804/161643156-4ce1abac-d78b-4211-a99a-f0bebd40e2a6.mp4" data-canonical-src="https://user-images.githubusercontent.com/26162804/161643156-4ce1abac-d78b-4211-a99a-f0bebd40e2a6.mp4" controls="controls" muted="muted" class="d-block rounded-bottom-2 border-top width-fit" style="max-height:640px;"></video>
9696
97-
https://user-images.githubusercontent.com/26162804/161643167-fc751455-1a1a-4b1c-b06f-a3a2cef0d0b0.mp4
97+
<video src="https://user-images.githubusercontent.com/26162804/161643167-fc751455-1a1a-4b1c-b06f-a3a2cef0d0b0.mp4" data-canonical-src="https://user-images.githubusercontent.com/26162804/161643167-fc751455-1a1a-4b1c-b06f-a3a2cef0d0b0.mp4" controls="controls" muted="muted" class="d-block rounded-bottom-2 border-top width-fit" style="max-height:640px;"></video>
9898
99-
https://user-images.githubusercontent.com/26162804/161643192-71db71af-392d-4b6a-b94d-851a3369dbf3.mp4
99+
<video src="https://user-images.githubusercontent.com/26162804/161643192-71db71af-392d-4b6a-b94d-851a3369dbf3.mp4" data-canonical-src="https://user-images.githubusercontent.com/26162804/161643192-71db71af-392d-4b6a-b94d-851a3369dbf3.mp4" controls="controls" muted="muted" class="d-block rounded-bottom-2 border-top width-fit" style="max-height:640px;"></video>
100100
101-
https://user-images.githubusercontent.com/26162804/161643203-2a265cc1-5cf1-4474-b43c-7b1b2dcba704.mp4
101+
<video src="https://user-images.githubusercontent.com/26162804/161643203-2a265cc1-5cf1-4474-b43c-7b1b2dcba704.mp4" data-canonical-src="https://user-images.githubusercontent.com/26162804/161643203-2a265cc1-5cf1-4474-b43c-7b1b2dcba704.mp4" controls="controls" muted="muted" class="d-block rounded-bottom-2 border-top width-fit" style="max-height:640px;"></video>
102102
103103
### Limit Number of Scans
104104
105105
You can limit the number of scans. For example if your app lets a user scan a business
106106
card you might want them to only capture the front and back. In this case you can set
107107
maxNumDocuments to 2. This only works on Android.
108108
109-
```javascript
109+
```javascript{% raw %}
110110
import React, { useState, useEffect } from 'react'
111111
import { Image } from 'react-native'
112112
import DocumentScanner from 'react-native-document-scanner-plugin'
@@ -140,17 +140,17 @@ export default () => {
140140
/>
141141
)
142142
}
143-
```
143+
{% endraw %}```
144144
145-
https://user-images.githubusercontent.com/26162804/161643345-6fe15f33-9414-46f5-b5d5-24d88948e801.mp4
145+
<video src="https://user-images.githubusercontent.com/26162804/161643345-6fe15f33-9414-46f5-b5d5-24d88948e801.mp4" data-canonical-src="https://user-images.githubusercontent.com/26162804/161643345-6fe15f33-9414-46f5-b5d5-24d88948e801.mp4" controls="controls" muted="muted" class="d-block rounded-bottom-2 border-top width-fit" style="max-height:640px;"></video>
146146
147147
### Remove Cropper
148148
149149
You can automatically accept the detected document corners, and prevent the user from
150150
making adjustments. Set letUserAdjustCrop to false to skip the crop screen. This limits
151151
the max number of scans to 1. This only works on Android.
152152
153-
```javascript
153+
```javascript{% raw %}
154154
import React, { useState, useEffect } from 'react'
155155
import { Image } from 'react-native'
156156
import DocumentScanner from 'react-native-document-scanner-plugin'
@@ -184,23 +184,16 @@ export default () => {
184184
/>
185185
)
186186
}
187-
```
187+
{% endraw %}```
188188
189-
https://user-images.githubusercontent.com/26162804/161643377-cabd7f51-a16f-4f5e-938a-afb6f3b1c8cb.mp4
189+
<video src="https://user-images.githubusercontent.com/26162804/161643377-cabd7f51-a16f-4f5e-938a-afb6f3b1c8cb.mp4" data-canonical-src="https://user-images.githubusercontent.com/26162804/161643377-cabd7f51-a16f-4f5e-938a-afb6f3b1c8cb.mp4" controls="controls" muted="muted" class="d-block rounded-bottom-2 border-top width-fit" style="max-height:640px;"></video>
190190
191191
## Documentation
192192
193-
<docgen-index>
194-
195193
* [`scanDocument(...)`](#scandocument)
196194
* [Interfaces](#interfaces)
197195
* [Enums](#enums)
198196
199-
</docgen-index>
200-
201-
<docgen-api>
202-
<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
203-
204197
### scanDocument(...)
205198
206199
```typescript
@@ -256,8 +249,6 @@ Opens the camera, and starts the document scan
256249
| **`Base64`** | <code>'base64'</code> | Use this response type if you want document scan returned as base64 images. |
257250
| **`ImageFilePath`** | <code>'imageFilePath'</code> | Use this response type if you want document scan returned as inmage file paths. |
258251

259-
</docgen-api>
260-
261252
## Expo
262253

263254
This plugin doesn't run in Expo Go. It works with Expo, and you can avoid manually changing iOS and Android files by following these steps.
@@ -345,7 +336,6 @@ export default () => {
345336
}
346337
```
347338

348-
349339
## License
350340

351341
Copyright 2022 David Marcus

0 commit comments

Comments
 (0)