0.8.12 • Published 3 years ago

@pluginjs/notice v0.8.12

Weekly downloads
-
License
GPL-3.0
Repository
github
Last release
3 years ago

Notice

npm package

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.

NameDescriptionDefault
"theme"Add plugin theme optionnull
"template"Add templatefunction() {...}
"templates"Add templates{}
"locale"Add locale env declareen
"html"Set enable html or nottrue
"localeFallbacks"Set enable localeFallbackstrue
"content"Set content
"contentAlignment"Set where is content alignmentcenter
"withClose"Set allow close or nottrue
"closeBottonColor"Set close button color
"backgroundColor"Set background colornull
"backgroundImage"Set background imagenull
"fontColor"Set font colornull
"buttons"Set buttons{"ok":{"title":"Ok","class":"pj-btn pj-btn-success"}}
"buttonAlign"Set button aligncenter
"timeout"Set timeout30000
"fixedWidth"Set fixed width or notfalse
"layout"Set layout locationtop

Events

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

NameDescription
"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 / EdgeFirefoxChromeSafariOpera
IE11, Edgelast 2 versionslast 2 versionslast 2 versionslast 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 purchase@thecreation.co.

Copyright

Copyright (C) 2022 Creation Studio Limited.

0.8.12

3 years ago

0.8.11

3 years ago

0.8.10

4 years ago

0.8.9

4 years ago

0.8.8

4 years ago

0.8.7

4 years ago

0.8.6

4 years ago

0.8.5

5 years ago

0.8.4

5 years ago

0.8.3

5 years ago

0.8.2

5 years ago

0.7.21

5 years ago

0.7.20

6 years ago

0.7.19

6 years ago

0.7.18

6 years ago

0.7.17

6 years ago

0.7.16

6 years ago

0.7.15

6 years ago

0.7.14

6 years ago

0.7.13

6 years ago

0.7.12

6 years ago

0.7.11

6 years ago

0.7.10

6 years ago

0.7.9

6 years ago

0.7.8

6 years ago

0.7.7

6 years ago

0.7.6

6 years ago

0.7.5

6 years ago

0.7.4

7 years ago

0.7.3

7 years ago

0.7.2

7 years ago

0.7.1

7 years ago

0.7.0

7 years ago

0.6.5

7 years ago

0.6.4

7 years ago

0.6.3

7 years ago

0.6.2

7 years ago

0.6.1

7 years ago

0.2.20

7 years ago

0.2.19

7 years ago

0.2.18

7 years ago

0.2.17

7 years ago

0.2.16

7 years ago

0.2.15

7 years ago

0.2.14

7 years ago

0.2.13

7 years ago

0.2.12

7 years ago

0.2.10

7 years ago

0.2.9

7 years ago

0.2.8

7 years ago

0.2.7

7 years ago

0.2.6

7 years ago

0.2.5

7 years ago

0.2.4

7 years ago

0.2.3

7 years ago

0.2.2

8 years ago

0.2.1

8 years ago