xref: /expo/packages/expo-brightness/README.md (revision 99d2cfbe)
1<p>
2  <a href="https://docs.expo.dev/versions/latest/sdk/brightness/">
3    <img
4      src="../../.github/resources/expo-brightness.svg"
5      alt="expo-brightness"
6      height="64" />
7  </a>
8</p>
9
10Provides an API to get and set screen brightness.
11
12# API documentation
13
14- [Documentation for the main branch](https://github.com/expo/expo/blob/main/docs/pages/versions/unversioned/sdk/brightness.mdx)
15- [Documentation for the latest stable release](https://docs.expo.dev/versions/latest/sdk/brightness/)
16
17# Installation in managed Expo projects
18
19For [managed](https://docs.expo.dev/archive/managed-vs-bare/) Expo projects, please follow the installation instructions in the [API documentation for the latest stable release](https://docs.expo.dev/versions/latest/sdk/brightness/).
20
21# Installation in bare React Native projects
22
23For bare React Native projects, you must ensure that you have [installed and configured the `expo` package](https://docs.expo.dev/bare/installing-expo-modules/) before continuing.
24
25### Add the package to your npm dependencies
26
27```
28npx expo install expo-brightness
29```
30
31### Configure for iOS
32
33Run `npx pod-install` after installing the npm package.
34
35### Configure for Android
36
37Add `android.permission.WRITE_SETTINGS` permission to your manifest (`android/app/src/main/AndroidManifest.xml`):
38
39```xml
40<uses-permission android:name="android.permission.WRITE_SETTINGS" />
41```
42
43# Contributing
44
45Contributions are very welcome! Please refer to guidelines described in the [contributing guide](https://github.com/expo/expo#contributing).
46