gliojs

    0.0.7 • Public • Published

    glio.js

    Detects if the mouse of a user leaves the viewport / document borders of your website and when this happens, trigger your callback.
    Portuguese documentation.

    Reasons for use:

    • Increase your conversion rates!
    • Give visitors reasons to stay!
    • Grab your users’ attention!

    How it works: Demo

    Usage:

    Import the library glio.min.js in 'dist' folder in your site. <script src='glio.min.js'></script>

    The arguments are a Arrays, where the first index is the direction and the second is a callback.
    glio( [ direction, callback ] ).

    Directions:

    • top
    • top-left
    • top-right
    • bottom-left
    • bottom-right

    Example:

    • top-left and top-right
        glio.init(
          [ 'top-left', function () {
              alert('this is top-left');
            }
          ],
          [ 'top-right', function () {
              alert('this is top-right');
            }
          ]
        );
    
    • all directions
      glio.init(
        [ 'top', function () {
            alert('this is top.');
          }
        ],
        [ 'top-left', function () {
            alert('this is top-left');
          }
        ],
        [ 'top-right', function () {
            alert('this is top-right');
          }
        ],
        [ 'bottom-left', function () {
            alert('this is bottom-left');
          }
        ],
        [ 'bottom-right', function () {
            alert('this is bottom-right'); 
          }
        ] 
      );
    

    Configurations:

    glio.config.key = value; Set the configuration before the init.

    • screenWidthFragment: the quantity of parts the height and width screen will be divided. Default: 12.
    • centerTopHeight: height of 'top' direction. When the mouse is equal or major this value, the callback is triggered. Default: 10.
    • heightTopLeft: height of 'top-left' direction. When the mouse is equal or major this value, the callback is triggered. Default: 30.
    • heightTopRight: height of 'top-right' direction. When the mouse is equal or major this value, the callback is triggered. Default: 30.

    See the demostration here.

    This software is licensed under the MIT License.

    Install

    npm i gliojs

    DownloadsWeekly Downloads

    24

    Version

    0.0.7

    License

    MIT

    Last publish

    Collaborators

    • luisvinicius167