nag-window

Nag

Display automatic callouts to a user, unless they've been previously dismissed. Suitable for subscription popups, greetings, notifications of new features, etc.

new Nag(element, options, lazy);
 
 
new Nag(document.getElementById("popup"), {cookieName: "shown-popup"});
 
new Nag("#pop-up", {
    showAfter: 2000,
    cookieName: "seen-popup"
    cookieExpires: 14 /** 2 weeks */
});

Table of contents

1. Parameters
   1. element
   2. options
   3. lazy
2. Option Reference
   1. cookieDomain
   2. cookieExpires
   3. cookieName
   4. cookiePath
   5. cookieSecure
   6. eventName
   7. eventTarget
   8. kickWhen
   9. kickSoftlyWhen
   10. onHide
   11. onShow
   12. showAfter
   13. showClass
   14. verbose
3. Methods
   1. kick
   2. kickWhen
   3. reset
   4. setKick

Parameters

1. element (HTMLElement | String)
   First argument is a reference to an HTML element, or a selector string matching one:

   var element = document.querySelector("#subscribe-now");
   var nag     = new Nag(element);
    
   /** Which is equivalent to: */
   var nag     = new Nag("#subscribe-now");

2. options (Object)
   Second argument is an optional hash of properties to fine-tune the Nag's behaviour:

   /** Possible options and their default values are depicted below: */
   var nag = new Nag(element, {
       cookieDomain:   undefined,
       cookieExpires:  365,
       cookieName:     element.id ? "shown-"+element.id : "nag-dismissed",
       cookiePath:     "/",
       cookieSecure:   undefined,
       eventName:      "scroll",
       eventTarget:    window,
       kickWhen:       undefined,
       kickSoftlyWhen: undefined,
       onHide:         function(){},
       onShow:         function(){},
       showAfter:      4000,
       showClass:      "show",
       verbose:        undefined
   });

   If a string is passed instead of a hash, it's interpreted as the name of the Nag's controller cookie. For example, both of the following declarations are identical:

   var nag = new Nag(element, {cookieName: "seen-popup"});
   var nag = new Nag(element, "seen-popup");

3. lazy
   A third argument permits absurdly lazy use by automatically calling setKick on anything that looks like it should close the containing popup:

   var nag = new Nag(element, "seen-popup", true);
    
   /** Does the same as this: */
   var nag = new Nag(element, "seen-popup")
       .setKick({click: ".close, .cancel, .close-btn"})
       .setKick({submit: "form"}, true);

   NOTE: This flag is automatically turned on if the only thing passed to the Nag constructor was an element:

   var nag = new Nag("#annoying-popup");
   var nag = new Nag(document.getElementById("#annoying-popup"));
    
   /** Which're both equivalent to: */
   var nag = new Nag("#annoying-popup", null, true);

   This is deliberate: if a developer can't be stuffed specifying even the cookie's name, it's assumed they're trying to get things off the ground as quickly as possible. If this bothers you (and you really, really feel the need to pass zero configuration) this behaviour can be suppressed simply by passing null as the second argument:

   var nag = new Nag("#annoying-popup", null);

Option Reference

cookieDomain

Type: String
Default: undefined

Cookie's "domain" attribute. Defaults to the current host, as per RFC 6265.

cookieExpires

Type: Date | Number
Default: 365

Cookie's expiration as a Date, or the number of days to store it in memory. Defaults to 365.

cookieName

Type: String
Default: "nag-dismissed" (See below)

Name of the cookie that indicates if the user's closed this nag before.

If omitted, the element's ID will be used, prepended with "shown‑". If the element lacks an ID attribute, a last resort value of "nag‑dismissed" will be used instead.

Note that Nag instances should always be supplied a unique, explicit cookie name for predictable behaviour.

cookiePath

Type: String
Default: "/" (Site root)

Cookie's "path" attribute, as per RFC 6265.

cookieSecure

Type: Boolean
Default: undefined

Cookie's "secure" attribute, as per RFC 6265.

eventName

Type: String
Default: "scroll"

DOM event that triggers the nag.

eventTarget

Type: EventTarget
Default: window

DOM object listening for the nag-triggering event.

kickWhen

Type: Object
Default: undefined

Configures which events will hide the Nag and prevent it showing again, expressed as a hash of element selectors keyed by event type. For example:

kickWhen: {
    click: "#close-btn, .cancel",
 
    /* Arrays may be used too: */
    click: ["#close-btn", ".cancel"]
}

Remember, a Nag can still be dismissed by manually calling its kick method. Using the kickWhen option simply obviates the need to register very simple event listeners to hide the nag in response to predicted user activity.

In other words, the code block above is functionally equivalent to this:

var nag         = new Nag(element);
var closeBtn    = document.querySelector("#close-btn");
closeBtn.addEventListener("click", function(e){
    nag.kick();
});

A convenience method is also available for setting these handlers on a Nag after instantiation.

kickSoftlyWhen

Type: Object
Default: undefined

Analoguous to kickWhen, with the exception that the triggered events don't hide the Nag immediately after they fire.

Consider a subscription form that presents a "thank you!" message to users who sign up. Were a user to navigate to another page without closing the dialogue, the Nag would still reappear on their next visit. Conversely, kicking the Nag upon a form submission would prevent the thanks message from even appearing in the first place.

This is where this option comes into play: a "soft kick" means disabling a Nag from showing again, but keeping it visible to the reader until another event (usually clicking a close button) invokes a "hard kick". For instance, the hypothetical example above would be resolved with this:

kickSoftlyWhen: {
    submit: "form"
}

onHide

Type: Function
Default: function(){} (No-op)

Run when Nag's dismissed.

onShow

Type: Function
Default: function(){} (No-op)

Run when Nag's displayed.

showAfter

Type: Number
Default: 4000

Milliseconds to wait before nagging user automatically. Defaults to 4000 if undefined; any other falsy values will disable this behaviour.

showClass

Type: String
Default: "show"

CSS class for displaying the target element. It's assumed that the element is hidden by default, and will be rendered visible to the user if this class is added to it.

verbose

Type: Boolean
Default: undefined

(Unminified code only)
Sends debugging messages to the console during the Nag's lifespan.

Methods

Each of the methods described below return a reference to the Nag instance to permit chaining.

kick

Dismiss a Nag whilst setting a cookie not to show it again.

Typically called from a close button, but may also be called from a form's submission handler.

Parameters

• soft (Boolean)
  If set, will prevent the Nag from showing again, but won't hide it immediately.

kickWhen

Aliased form of setKick (see below).

reset

Reset the Nag's cookie, ready to irritate the user once more.

Parameters

• show (Boolean)
  If TRUE, will display the Nag to the user as well.

setKick

Assign event listeners to disable the Nag in response to user activity.

Parameters

• args (Object)
  Object whose keys represent types of events, and whose values are CSS selectors matching the elements listening for them.

• softly (Boolean)
  Whether to kick the Nag "softly" (disable it in future, but not hide it straight away).

Example

nag.setKick({click: "#close-btn"});
nag.setKick({submit: "form"}, true);