Giter Club home page Giter Club logo

cordova-plugin-drawoverapps's Introduction

Draw Over All Apps plugin for Cordova

Android Cordova Plugin that uses draw over all apps feature to display a HTML Web view

This plugin was successfully tested on Android 5.1 , also on Marshmallow (Android 6.0).

Install

cordova plugin add cordova-plugin-drawoverapps

It is also possible to install via repo url directly

cordova plugin add https://github.com/ahmedwahba/cordova-plugin-drawoverapps

Functions

  • window.overApps.checkPermission
  • window.overApps.startOverApp
  • window.overApps.closeOverApp

window.overApps.checkPermission

This to check draw-over-apps permession and open system permission window to be granted

  window.overApps.checkPermission(function(msg){
         console.log(msg);
  });

window.overApps.startOverApp

start service function display the over-all head or the web view according to options. If successful the success is called, otherwise the failed is called instead.

window.overApps.startOverApp(options, success, failed);

Options

  • path: file path to display as view content, this file should be located in WWW root folder.
  • hasHead: display over app head image which open the view up on click , by default true.
  • dragToSide: enable auto move of head to screen side after dragging stop , by default true.
  • enableBackBtn: enable hardware back button to close view, by default true.
                            should be disabled to be able to use keyboard.
  • enableCloseBtn: whether to show native close btn or to hide it , by default true
  • verticalPosition: set vertical alignment of view , values are top - center - bottom , by default center.
  • horizontalPosition: set horizontal alignment of view , values are right - center - left , by default center.

Example

var options = {
      path: "test.html",          // file path to display as view content.
      hasHead: true,              // display over app head image which open the view up on click.
      dragToSide: false,          // enable auto move of head to screen side after dragging stop. 
      enableBackBtn: false,       // enable hardware back button to close view.
      enableCloseBtn: true,      //  whether to show native close btn or to hide it.
      verticalPosition: "top",    // set vertical alignment of view.
      horizontalPosition: "left"  // set horizontal alignment of view. 
 };
 
 window.overApps.startOverApp(options,function (success){
   		console.log(success);
 },function (err){
   		console.log(err);
 });

window.overApps.closeOverApp

It closes over app web view , called inside app itself only .

window.overApps.closeOverApp();

Control overApp WebView

Close WebView

It closes over app webview from one of the webview UI or event

OverApps.closeWebView();

Licence

Copyright (c) 2017 Ahmed Wahba & Mohamed Sayed

Permission is here by granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

cordova-plugin-drawoverapps's People

Contributors

ahmedwahba avatar

Watchers

 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.