Code Monkey home page Code Monkey logo

heyoffline.js's Introduction

Heyoffline.js (actually Heyoffline.coffee)

Warn your users when their network goes down. Make sure they don't lose anything.

Demo

See demo.

Setup

You can install Heyoffline via Bower with bower install Heyoffline or download heyoffline.js and include it the old-fashined way.

CoffeeScript

new Heyoffline
  monitorFields: true
  elements: ['.monitoredFields']

JavaScript

new Heyoffline({
  monitorFields: true,
  elements: ['.monitoredFields']
});

Options

Name Type Default Description
monitorFields boolean false If this option is enabled, message on network error will be shown only if a input/textarea/select/etc on the page was modified
prefix string heyoffline Class prefix for generated elements
noStyles boolean false Don't use the default CSS (generated by JS)
disableDimiss boolean false By default the user can dimiss the warning. With this option you can hide the dismiss button.
elements array ['input', 'select', 'textarea', '*[contenteditable]'] Field elements that will be monitored for changes - see monitorFields option.
text.title string You're currently offline Heading of the modal window
text.content string Seems like you've became offline, you might want to wait until your network comes back before continuing.

This message will self-destruct once you're online again.
Body message of the modal window
text.button string Relax, I know what I'm doing Dimissal button of the modal window

Events

Name Provides Description
onOnline Fires then the network becomes available
onOffline Fires when the network disappears

Requirements

Heyoffline.js is framework-agnostic. No need for jQuery. It's written in CoffeeScript, and compiled into JavaScript.

Source code

All efforts have been made to keep the source as clean and readable as possible.

Requirements

Heyoffline.js is released under an MIT License, so do with it what you will.

heyoffline.js's People

Contributors

akatz avatar imkingdavid avatar oskarkrawczyk avatar shashankmehta avatar

Watchers

Ray Lugo, Jr. 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.