natanfeitosa / rn-wallpapers

A lightweight library for setting wallpapers with React Native

rn-wallpapers

A lightweight library for setting wallpapers with React Native

Installation

npm install rn-wallpapers

// or with yarn
yarn add rn-wallpapers

Usage

import { setWallpaper, TYPE_SCREEN } from 'rn-wallpapers';

// ...


await setWallpaper(
  {
    uri: 'https://i0.wp.com/techwek.com/wp-content/uploads/2021/01/wallpaper-gotas-de-chuva.jpg',
    headers: {
      // your custom headers ...
    }
  },
  TYPE_SCREEN.LOCK // Sets the wallpaper on Lock Screen only
);

await setWallpaper(
  {
    uri: 'https://i0.wp.com/techwek.com/wp-content/uploads/2021/01/wallpaper-gotas-de-chuva.jpg'
  },
  TYPE_SCREEN.HOME // (default) Sets the wallpaper on Home Screen only
);

await setWallpaper(
  {
    uri: 'https://i0.wp.com/techwek.com/wp-content/uploads/2021/01/wallpaper-gotas-de-chuva.jpg'
  },
  TYPE_SCREEN.BOTH // Sets the wallpaper on both screen
);

If you are using Expo Go, you may need to add the SET_WALLPAPER permission to your permissions array

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

License

MIT

---

Made with create-react-native-library