Code Monkey home page Code Monkey logo

cordova-plugin-wallpaper's Introduction

Title Description
Set Wallpaper
Set an image within the application cordova as wallpaper.

npm version

Code Climate Issue Count

Android
Build Status

cordova-plugin-wallpaper

This simple plugin gives you the ability of setting the systems wallpaper, either by using an image you brought with the application in its www-directory or by using a Base64-encoded string of an image. This lets you choose the image after the installation of the application and even change it afterwards, you just have to pass over a new Base64 encoded image.

##Table of Contents

  1. Installation
  2. Usage
  3. License
  4. Supported Platforms

Installation

stable npm package:

cordova plugin add cordova-plugin-wallpaper

maybe unstable GitHub-repository:

cordova plugin add https://github.com/fbsanches/cordova-plugin-wallpaper.git

##Usage ###Function(s) ####setImage Sets image under given path as systems background image:

window.plugins.wallpaper.setImage(string /* image path */);

#####Notes

  • path must not start with bar
  • path has not to start with backslash

#####Example

window.plugins.wallpaper.setImage("img/mybackground.jpg");

####setImageHttp Sets image from url as background image:

window.plugins.wallpaper.setImageHttp(string /* url */);

#####Example

window.plugins.wallpaper.setImageHttp("https://example.com/image.jpg");

####setImageBase64 Sets image contained in Base64 string as systems background image:

window.plugins.wallpaper.setImageBase64(string /* Base64 string */);

#####Example

window.plugins.wallpaper.setImageBase64(base64);

##License The plugin is licensed under Apache 2.0. The Apache 2.0 license can be found in the root directory of this project as well as the projects NOTICE.

##Supported Platforms

  • Android

cordova-plugin-wallpaper's People

Contributors

fbsanches avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.