before-leaving-me

Do things before the user leaves your web page.

:cloud: Installation

# Using npm
npm install --save before-leaving-me

# Using yarn
yarn add before-leaving-me

Usage

<script src="path/to/blm.js"></script>
<script>
blm("Do you really want to leave?");
blm(function () {
  if (changesAreSaved) {
    return undefined;
  }
  return "You have unsaved changes! Do you want to close the window?";
});
blm.prepare(function () {
  /* do something when the user is preparing to leave the page */
});
</script>

:question: Get Help

There are few ways to get help:

1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. :bug:
3. For direct and quick help, you can use Codementor. :rocket:

:memo: Documentation

blm(input)

Do something before leaving me.

Params

• String|Function input: A string representing the message to show before the window is closed or a function returning that value.

Return

• Object The blm object.

prepare(func, speed, delay, handlers)

...or before preparing to leave me. Catch the moment when the user moves the mouse in the top side of the page (and most probably wants to close the window).

Params

• Function func: A function to be called when the user moves the mouse to the top of the page.
• Number speed: The minimum mouse vertical speed (default: -170).
• Number delay: The number of miliseconds between two moments when we're trying to catch the mouse leave.
• Array handlers: An array of booleans in this order: [ignoreLeave, ignoreMove, ignoreBlur] (e.g. [true, true, false], [1, 1, 0]).

Return

• Object The blm object.

:yum: How to contribute

Have an idea? Found a bug? See how to contribute.

:sparkling_heart: Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

• Starring and sharing the projects you like :rocket:

• —I love books! I will remember you after years if you buy me one. :grin: :book:

• —You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:

• —Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

• Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

  

Thanks! :heart:

:scroll: License

MIT © Ionică Bizău