35 lines
1.3 KiB
Markdown
35 lines
1.3 KiB
Markdown
# expo-keep-awake
|
|
|
|
Provides a React component that prevents the screen sleeping when rendered. It also exposes static methods to control the behavior imperatively.
|
|
|
|
# API documentation
|
|
|
|
- [Documentation for the master branch](https://github.com/expo/expo/blob/master/docs/pages/versions/unversioned/sdk/keep-awake.md)
|
|
- [Documentation for the latest stable release](https://docs.expo.io/versions/latest/sdk/keep-awake/)
|
|
|
|
# Installation in managed Expo projects
|
|
|
|
For managed [managed](https://docs.expo.io/versions/latest/introduction/managed-vs-bare/) Expo projects, please follow the installation instructions in the [API documentation for the latest stable release](https://docs.expo.io/versions/latest/sdk/keep-awake/).
|
|
|
|
# Installation in bare React Native projects
|
|
|
|
For bare React Native projects, you must ensure that you have [installed and configured the `react-native-unimodules` package](https://github.com/expo/expo/tree/master/packages/react-native-unimodules) before continuing.
|
|
|
|
### Add the package to your npm dependencies
|
|
|
|
```
|
|
expo install expo-keep-awake
|
|
```
|
|
|
|
### Configure for iOS
|
|
|
|
Run `npx pod-install` after installing the npm package.
|
|
|
|
### Configure for Android
|
|
|
|
No additional set up necessary.
|
|
|
|
# Contributing
|
|
|
|
Contributions are very welcome! Please refer to guidelines described in the [contributing guide](https://github.com/expo/expo#contributing).
|