@pluginjs/notice

Notice

A flexible modern notice js plugin.

Samples

Introduction

Installation

Yarn

yarn add @pluginjs/notice

NPM

npm i @pluginjs/notice

Getting Started

CDN:

Development:

<script src="https://unpkg.com/@pluginjs/notice/dist/notice.js"></script>
<link rel="stylesheet" href="https://unpkg.com/@pluginjs/notice/dist/notice.css">

Production:

<script src="https://unpkg.com/@pluginjs/notice/dist/notice.min.js"></script>
<link rel="stylesheet" href="https://unpkg.com/@pluginjs/notice/dist/notice.min.css">

Initialize

HTML:

<div class="element"></div>

ECMAScript Module:

import Notice from "@pluginjs/notice"
import "@pluginjs/notice/dist/notice.css"

Notice.of(document.querySelector('.element'), options)

CommonJS:

require("@pluginjs/notice/dist/notice.css")
const Notice = require("@pluginjs/notice")

Notice.of(document.querySelector('.element'), options)

Browser:

<link rel="stylesheet" href="https://unpkg.com/@pluginjs/notice/dist/notice.css">
<script src="https://unpkg.com/@pluginjs/notice/dist/notice.js"></script>
<script>
  Pj.notice('.element', options)
</script>

API

Options

Options are called on notice instances through the notice options itself. You can also save the instances to variable for further use.

Name	Description	Default
"theme"	Add plugin theme option	null
"template"	Add template	function() {...}
"templates"	Add templates	{}
"locale"	Add locale env declare	en
"html"	Set enable html or not	true
"localeFallbacks"	Set enable localeFallbacks	true
"content"	Set content	``
"contentAlignment"	Set where is content alignment	center
"withClose"	Set allow close or not	true
"closeBottonColor"	Set close button color	``
"backgroundColor"	Set background color	null
"backgroundImage"	Set background image	null
"fontColor"	Set font color	null
"buttons"	Set buttons	{"ok":{"title":"Ok","class":"pj-btn pj-btn-success"}}
"buttonAlign"	Set button align	center
"timeout"	Set timeout	30000
"fixedWidth"	Set fixed width or not	false
"layout"	Set layout location	top

Events

Events are called on notice instances through the notice events itself. You can also save the instances to variable for further use.

Name	Description
"show"	Gets fired when plugin is show
"hide"	Gets fired when plugin is hidden
"destroy"	Gets fired when plugin is destroy
"ready"	Gets fired when plugin is ready

Classes

Name | Description | Default --|| "NAMESPACE" | Declare plugin namespace | pj-notice "THEME" | Declare plugin theme | {namespace}--{theme} "CONTENT" | Declare plugin content | {namespace}-content "ACTIVE" | Announce plugin is actived | {namespace}-active "DISABLED" | Announce plugin is disabled | {namespace}-disabled "CLOSE" | Declare plugin is close | {namespace}-close "CONTAINER" | Declare plugin range | {namespace}-container "BUTTON" | Declare plugin button | {namespace}-btn "BUTTONS" | Declare plugin buttons | {namespace}-buttons "POSITION" | Declare plugin position | {namespace}-position "BACKGROUND" | Declare plugin background | {namespace}-with-bg

Browser support

Tested on all major browsers.

IE / Edge	Firefox	Chrome	Safari	Opera
IE11, Edge	last 2 versions	last 2 versions	last 2 versions	last 2 versions

License

@pluginjs/notice is Licensed under the GPL-v3 license.

If you want to use @pluginjs/notice project to develop commercial sites, themes, projects, and applications, the Commercial license is the appropriate license. With this option, your source code is kept proprietary.

For purchase an Commercial License, contact us [e-mail].

Copyright

Copyright (C) 2022 Creation Studio Limited.