codex-notifier

WebJar for codex-notifier

License

License

MIT
Categories

Categories

Dex General Purpose Libraries Utility
GroupId

GroupId

org.webjars.npm
ArtifactId

ArtifactId

codex-notifier
Last Version

Last Version

1.1.2
Release Date

Release Date

Type

Type

jar
Description

Description

codex-notifier
WebJar for codex-notifier
Project URL

Project URL

https://www.webjars.org
Source Code Management

Source Code Management

https://github.com/codex-team/js-notifier

Download codex-notifier

How to add to project

<!-- https://jarcasting.com/artifacts/org.webjars.npm/codex-notifier/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>codex-notifier</artifactId>
    <version>1.1.2</version>
</dependency>
// https://jarcasting.com/artifacts/org.webjars.npm/codex-notifier/
implementation 'org.webjars.npm:codex-notifier:1.1.2'
// https://jarcasting.com/artifacts/org.webjars.npm/codex-notifier/
implementation ("org.webjars.npm:codex-notifier:1.1.2")
'org.webjars.npm:codex-notifier:jar:1.1.2'
<dependency org="org.webjars.npm" name="codex-notifier" rev="1.1.2">
  <artifact name="codex-notifier" type="jar" />
</dependency>
@Grapes(
@Grab(group='org.webjars.npm', module='codex-notifier', version='1.1.2')
)
libraryDependencies += "org.webjars.npm" % "codex-notifier" % "1.1.2"
[org.webjars.npm/codex-notifier "1.1.2"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

JavaScript Notifier

Lightweight notification module for websites

Instalation

Install via NPM/Yarn

Install package

npm install codex-notifier --save
yarn add codex-notifier

Require module

const notifier = require('codex-notifier');
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

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

Notify

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

Success

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

Error

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

Confirm

notifier.show({
  message: 'Enter your email',
  type: 'prompt',
  okText: 'Enter',
  okHandler: checkEmail,
  inputType: 'email',
  placeholder: '[email protected]'
})

Prompt

Custom styles

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

org.webjars.npm

CodeX

Team of web-development fans

Versions

Version
1.1.2