Skip to content

Commit 43292f6

Browse files
authored
docs: update README
1 parent c8754a5 commit 43292f6

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ methods: {
3737
}
3838
```
3939

40+
> You might notice that when you scan the same QR code multiple times in a row, `decode` is still only emitted once. When you hold a QR code in the camera, frames are actually decoded multiple times a second but you don't want to be flooded with `decode` events that often. That's why the last decoded QR code is always cached and only new results are propagated. However, you can clear this internal cache by setting the `paused` prop to true.
41+
4042
### `detect` event
4143
The `detect` event is quite similar to `decode` but it provides more details. `decode` only gives you the string encoded by QR codes. `detect` additionally
4244

@@ -167,7 +169,7 @@ Distributed content will overlay the camera stream, wrapped in a `position: abso
167169

168170
### `paused` prop
169171

170-
With the `paused` prop you can prevent further `decode` propagation and functions passed via `track` are stopped being called. Useful for example if you're only interested in the first result. This will also freeze the camera stream.
172+
With the `paused` prop you can prevent further `decode` propagation and functions passed via `track` are stopped being called. Useful for example if you want to validate results one at a time. This will also freeze the camera stream.
171173

172174
```html
173175
<qrcode-reader @decode="onDecode" :paused="paused"></qrcode-reader>

0 commit comments

Comments
 (0)