Summary

The plugin is designed as a notification manager. You create a new instance and use it to show as many notifications as you need. There always be at least one notification created in order to be as quick as possible when you want to show a notification.

You configure the manager when you create the instance of Notimoo and yo can override some of this configuration when calling the show function to handle specific notifications.

Notimoo - initialize

This method is invoked when you create a new instance. Once finisehd you will have a Notimoo manager. The only parameter you can pass to this function is an options object populated with any of these properties (note that all of them are optional).

• parent -> parent element where notifications are to be inserted (defaults to 'body' tag)
• height -> height of the notification DOM element (in pixels -defaults to 50-)
• width -> width of the notification DOM element (in pixels -defaults to 300-)
• visibleTime -> time the notification is displayed (in miliseconds -defaults to 5000-)
• locationVType -> whether you want the notifications to be shown on the top or the bottom of the parent element (defaults to 'top')
• locationHType -> whether you want the notification to be shown at the left or right of the parent element (defaults to 'right')
• locationVBase -> vertical base position for the notifications (in pixels -defaults to 10-)
• locationHBase -> horizontal base position for the notifications (in pixels -defaults to 10-)
• notificationsMargin -> margin between notifications (in pixels -defaults to 5-)
• opacityTransitionTime -> duration for notification opacity transition (in miliseconds -defaults to 750-)
• closeRelocationTransitionTime -> duration for notification relocation transition when one of them is close (in miliseconds -defaults to 750-)
• scrollRelocationTransitionTime -> duration for notification relocation transition when parent scroll is moved (in miliseconds -defaults to 250-)
• notificationOpacity -> opacity used when the notification is displayed (defaults to 0.95)
• onShow -> callback to be executed when the notification is displayed. The notification element is passed as a parameter.
• onClose -> callback to be executed when the notification id closed. The notification element is passed as a parameter.

Notimoo - show

This is the method you actually use to display a notification. It only accepts a Hash options object as a paramter with these properties:

• title (optional) -> Title for the notification
• message (required) -> Message for the notification
• sticky (optional) -> Whether the notification won't be removed until user interaction (defaults to false)
• visibleTime (optional) -> Time for the notification to be displayed (in milliseconds). If this isn't provided, the global one will be used.
• width (optional) -> Width fot the notification (in pixels). If this isn't provided, the global one will be used.
• customClass (optional) -> Class we want this notification to have. You can add several classes separated by commas.