GitHub
npm
expo-keep-awake provides a React hook that prevents the screen from sleeping and a pair of functions to enable this behavior imperatively.
| Android Device | Android Emulator | iOS Device | iOS Simulator | Web |
|---|---|---|---|---|
| Pending |
- npx expo install expo-keep-awakeIf you're installing this in a bare React Native app, you should also follow these additional installation instructions.
import { useKeepAwake } from 'expo-keep-awake';
import React from 'react';
import { Text, View } from 'react-native';
export default function KeepAwakeExample() {
useKeepAwake();
return (
<View style={{ flex: 1, alignItems: 'center', justifyContent: 'center' }}>
<Text>This screen will never sleep!</Text>
</View>
);
}
import { activateKeepAwake, deactivateKeepAwake } from 'expo-keep-awake';
import React from 'react';
import { Button, View } from 'react-native';
export default class KeepAwakeExample extends React.Component {
render() {
return (
<View style={{ flex: 1, alignItems: 'center', justifyContent: 'center' }}>
<Button onPress={this._activate} title="Activate" />
<Button onPress={this._deactivate} title="Deactivate" />
</View>
);
}
_activate = () => {
activateKeepAwake();
alert('Activated!');
};
_deactivate = () => {
deactivateKeepAwake();
alert('Deactivated!');
};
}
import KeepAwake from 'expo-keep-awake';
KeepAwake.ExpoKeepAwakeTagType: 'ExpoKeepAwakeDefaultTag'
useKeepAwake(tag, options)| Name | Type | Description |
|---|---|---|
| tag (optional) | string | Optional - Tag to lock screen sleep prevention. If not provided, the default tag is used. Default: ExpoKeepAwakeTag |
| options (optional) | {
suppressDeactivateWarnings: boolean
} | Optional
|
A React hook to keep the screen awake for as long as the owner component is mounted.
The optionally provided tag argument is used when activating and deactivating the keep-awake
feature. If unspecified, the default tag is used. See the documentation for activateKeepAwake
below to learn more about the tag argument.
Returns
voidKeepAwake.activateKeepAwake(tag)| Name | Type | Description |
|---|---|---|
| tag (optional) | string | Optional - Tag to lock screen sleep prevention. If not provided, the default tag is used. Default: ExpoKeepAwakeTag |
Prevents the screen from sleeping until deactivateKeepAwake is called with the same tag value.
If the tag argument is specified, the screen will not sleep until you call deactivateKeepAwake
with the same tag argument. When using multiple tags for activation you'll have to deactivate
each one in order to re-enable screen sleep. If tag is unspecified, the default tag is used.
Returns
Promise<void>KeepAwake.deactivateKeepAwake(tag)| Name | Type | Description |
|---|---|---|
| tag (optional) | string | Optional - Tag to release the lock on screen sleep prevention. If not provided, the default tag is used. Default: ExpoKeepAwakeTag |
Releases the lock on screen-sleep prevention associated with the given tag value. If tag
is unspecified, it defaults to the same default tag that activateKeepAwake uses.
Returns
Promise<void>