# codex-notifier

> Simple notifications for your website

Latest version **1.1.2** (published 2019-04-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install codex-notifier
pnpm add codex-notifier
yarn add codex-notifier
bun add codex-notifier
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.2 |
| Published | 2019-04-15 |
| First published | 2017-06-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 18.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51 |
| Author | CodeX Team |
| Maintainers | codex-team |

## Links

- npm: https://www.npmjs.com/package/codex-notifier
- Repository: https://github.com/codex-team/js-notifier
- Homepage: https://github.com/codex-team/js-notifier#readme
- Issues: https://github.com/codex-team/js-notifier/issues
- npm.io page: https://npm.io/package/codex-notifier

## Recent versions

- 1.1.2 (latest) — 2019-04-15
- 1.1.1 — 2018-11-28
- 1.1.0 — 2018-11-09
- 1.0.6 — 2018-11-08
- 1.0.5 — 2018-11-08
- 1.0.4 — 2018-11-01
- 1.0.3 — 2017-06-28
- 1.0.2 — 2017-06-28
- 1.0.1 — 2017-06-28
- 1.0.0 — 2017-06-28

## README

# JavaScript Notifier

Lightweight notification module for websites

## Instalation

### Install via NPM/Yarn

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](https://github.com/codex-team/js-notifier/raw/master/docs/examples/notify.png)

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

![Success](https://github.com/codex-team/js-notifier/raw/master/docs/examples/success.png)

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

![Error](https://github.com/codex-team/js-notifier/raw/master/docs/examples/error.png)

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

![Confirm](https://github.com/codex-team/js-notifier/raw/master/docs/examples/confirm.png)

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

![Prompt](https://github.com/codex-team/js-notifier/raw/master/docs/examples/prompt.png)

## Custom styles

You can easily customize notifications appearance. Read more about it [here](https://github.com/codex-team/js-notifier/blob/master/docs/styles.md)

---
_Source: https://npm.io/package/codex-notifier · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._