Skip to content

README.md

Latest commit

 

History

History
61 lines (46 loc) · 1.23 KB

README.md

File metadata and controls

61 lines (46 loc) · 1.23 KB
Raw

title-notify

Simple plugin to notify with page title. The title resets automatically when page is active.

#Installation Bower support

bower install title-notify

#Usage There are two types supported now: flash, scroll.

  • Flash effect

This is the default effect, so the effect option is needless. The message will show and hide periodically based on interval configuration.

titleNotify.init({
    message: 'You have unread message'
    effect: 'flash'
});
  • Scroll effect

The message will scroll from right to the left periodically based on interval configuration.

titleNotify.init({
    message: 'You have unread message'
    effect: 'flash'
});
  • Count

You can add a count number before title. counterWrapper is used to specify the wrapper for counter, default wrapper is '(%count%)', count is used as the placeholder for replacing the count number.

titleNotify.init();

Add count number

titleNotify.counterAdd();

Minus count number

titleNotify.counterSub();

Set count number directly, the number should be number or string containing number.

titleNotify.counterSet(10);

TODO

  • Test Browser compatibility