Skip to content

Commit cd67d01

Browse files
committed
Document the reacquireOnPageVisible prop
Added documentation and updated the usage example
1 parent 84cebb1 commit cd67d01

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ function Component() {
6060
onRequest: () => alert('Screen Wake Lock: requested!'),
6161
onError: () => alert('An error happened 💥'),
6262
onRelease: () => alert('Screen Wake Lock: released!'),
63+
reacquireOnPageVisible: true,
6364
});
6465

6566
return (
@@ -69,10 +70,7 @@ function Component() {
6970
<br />
7071
Released: <b>{`${released}`}</b>
7172
</p>
72-
<button
73-
type="button"
74-
onClick={() => (released === false ? release() : request())}
75-
>
73+
<button type="button" onClick={() => (released === false ? release() : request())}>
7674
{released === false ? 'Release' : 'Request'}
7775
</button>
7876
</div>
@@ -84,11 +82,12 @@ export default Component;
8482

8583
## Props
8684

87-
| Prop | description | default | required |
88-
| :---------: | :-----------------------------------------------------------: | :---------: | :------: |
89-
| `onRequest` | called on successfully `navigator.wakeLock.request` | `undefined` | false |
90-
| `onError` | called when caught an error from `navigator.wakeLock.request` | `undefined` | false |
91-
| `onRelease` | called when wake lock is released | `undefined` | false |
85+
| Prop | description | default | required |
86+
| :----------------------: | :-----------------------------------------------------------: | :---------: | :------: |
87+
| `onRequest` | called on successfully `navigator.wakeLock.request` | `undefined` | false |
88+
| `onError` | called when caught an error from `navigator.wakeLock.request` | `undefined` | false |
89+
| `onRelease` | called when wake lock is released | `undefined` | false |
90+
| `reacquireOnPageVisible` | Reacquires the wake lock when the page becomes visible again | `false` | false |
9291

9392
### Returns
9493

0 commit comments

Comments
 (0)