JavaScript Notifier

Lightweight notification module for websites

Instalation

$3

Install package

``shell
npm install codex-notifier --save
`

`shell
yarn add codex-notifier
`

#### Require module

`javascript
const notifier = require('codex-notifier');
`

`javascript
import notifier from 'codex-notifier';
import {ConfirmNotifierOptions, NotifierOptions, PromptNotifierOptions} from 'codex-notifier';
`

Usage

Module has only one public method — show.
You should pass there object with notification properties

#### General properties

- message — notification message (can contains HTML)
- type — type of notification: alert, confirm or prompt. Alert by default
- style — just add 'cdx-notify--' + style class. We have some default styles: success and error
- time — notification expire time in ms. Only for alert notifies expires (8s by default)

#### Confirm notifications properties

- okText — text for confirmation button (Confirm by default)
- cancelText — text for cancel button (Cancel by default)
- okHandler — fires when Confirm button was pressed
- cancelHandler — fires when Cancel button was pressed or notification was closed

#### Prompt notifications properties

- okText — text for submit button (Ok by default)
- okHandler — fires when submit button was pressed. Gets input's value as a parameter
- cancelHandler — fires when notification was closed
- placeholder — input placeholder
- default — input default value
- inputType — type of input (text by default)

Examples

`javascript
notifier.show({
message: 'Refresh the page'
})
`

!Notify

`javascript
notifier.show({
message: 'Message was sent',
style: 'success',
time: 5000
})
`

!Success

`javascript
notifier.show({
message: 'Sorry, server is busy now',
style: 'error'
})
`

!Error

`javascript
notifier.show({
message: 'Delete account?',
type: 'confirm',
okText: 'Yes',
cancelText: 'Oh, wait',
okHandler: account.delete
})
`

!Confirm

`javascript
notifier.show({
message: 'Enter your email',
type: 'prompt',
okText: 'Enter',
okHandler: checkEmail,
inputType: 'email',
placeholder: 'team@ifmo.su'
})
``

!Prompt

Custom styles

You can easily customize notifications appearance. Read more about it here