use directories for structure
This commit is contained in:
109
node_modules/pnotify/README.md
generated
vendored
109
node_modules/pnotify/README.md
generated
vendored
@@ -1,51 +1,60 @@
|
||||
[](https://www.npmjs.com/package/pnotify) [](https://waffle.io/sciactive/pnotify) [](https://www.jsdelivr.com/package/npm/pnotify)
|
||||
[](https://www.npmjs.com/package/pnotify) [](https://www.jsdelivr.com/package/npm/pnotify)
|
||||
|
||||
PNotify is a vanilla JavaScript notification and [confirmation/prompt](http://sciactive.com/pnotify/#confirm-module) library. PNotify can provide [desktop notifications](http://sciactive.com/pnotify/#web-notifications) based on the [Web Notifications spec](http://www.w3.org/TR/notifications/) with fall back to an in-browser notice.
|
||||
|
||||
<h1>v5 is in Alpha</h1>
|
||||
|
||||
[PNotify v5](https://github.com/sciactive/pnotify/tree/develop) has some [really awesome changes](https://github.com/sciactive/pnotify/blob/develop/MIGRATING.md), and is currently in alpha release. Feel free to try it out and [submit feedback](https://github.com/sciactive/pnotify/issues).
|
||||
|
||||
<h1>Demos</h1>
|
||||
|
||||
* http://sciactive.com/pnotify/ for the latest release
|
||||
* https://sciactive.github.io/pnotify/ for what's in development
|
||||
<h2>V4 (Stable Version)</h2>
|
||||
|
||||
http://sciactive.com/pnotify/
|
||||
|
||||
<h2>V5 (Development Version)</h2>
|
||||
|
||||
https://sciactive.github.io/pnotify/
|
||||
|
||||
<h1>Table of Contents</h1>
|
||||
|
||||
<!-- TOC START min:1 max:3 link:true asterisk:false update:true -->
|
||||
- [Getting Started](#getting-started)
|
||||
- [Migrating from PNotify 3](#migrating-from-pnotify-3)
|
||||
- [Installation](#installation)
|
||||
- [Svelte](#svelte)
|
||||
- [React](#react)
|
||||
- [Angular](#angular)
|
||||
- [Angular (Injectable)](#angular-injectable)
|
||||
- [AngularJS](#angularjs)
|
||||
- [Vanilla JS (ES5)](#vanilla-js-es5)
|
||||
- [Vanilla JS (ES6)](#vanilla-js-es6)
|
||||
- [Styles](#styles)
|
||||
- [Bright Theme](#bright-theme)
|
||||
- [Material](#material)
|
||||
- [Material Icons](#material-icons)
|
||||
- [Bootstrap](#bootstrap)
|
||||
- [Font Awesome (Icons)](#font-awesome-icons)
|
||||
- [Creating Notices](#creating-notices)
|
||||
- [Options](#options)
|
||||
- [Changing Defaults](#changing-defaults)
|
||||
- [Module Options](#module-options)
|
||||
- [Desktop Module](#desktop-module)
|
||||
- [Buttons Module](#buttons-module)
|
||||
- [NonBlock Module](#nonblock-module)
|
||||
- [Mobile Module](#mobile-module)
|
||||
- [Animate Module](#animate-module)
|
||||
- [Confirm Module](#confirm-module)
|
||||
- [History Module](#history-module)
|
||||
- [Callbacks Module](#callbacks-module)
|
||||
- [Static Methods and Properties](#static-methods-and-properties)
|
||||
- [Instance Methods and Properties](#instance-methods-and-properties)
|
||||
- [From the Svelte Component API](#from-the-svelte-component-api)
|
||||
- [Events](#events)
|
||||
- [Stacks](#stacks)
|
||||
- [Example Stack](#example-stack)
|
||||
- [Features](#features)
|
||||
- [Licensing and Additional Info](#licensing-and-additional-info)
|
||||
- [Getting Started](#Getting-Started)
|
||||
- [Migrating from PNotify 3](#Migrating-from-PNotify-3)
|
||||
- [Installation](#Installation)
|
||||
- [Svelte](#Svelte)
|
||||
- [React](#React)
|
||||
- [Angular](#Angular)
|
||||
- [Angular (Injectable)](#Angular-Injectable)
|
||||
- [AngularJS](#AngularJS)
|
||||
- [Vanilla JS (ES5)](#Vanilla-JS-ES5)
|
||||
- [Vanilla JS (ES6)](#Vanilla-JS-ES6)
|
||||
- [Styles](#Styles)
|
||||
- [Bright Theme](#Bright-Theme)
|
||||
- [Material](#Material)
|
||||
- [Material Icons](#Material-Icons)
|
||||
- [Bootstrap](#Bootstrap)
|
||||
- [Font Awesome (Icons)](#Font-Awesome-Icons)
|
||||
- [Creating Notices](#Creating-Notices)
|
||||
- [Options](#Options)
|
||||
- [Changing Defaults](#Changing-Defaults)
|
||||
- [Module Options](#Module-Options)
|
||||
- [Desktop Module](#Desktop-Module)
|
||||
- [Buttons Module](#Buttons-Module)
|
||||
- [NonBlock Module](#NonBlock-Module)
|
||||
- [Mobile Module](#Mobile-Module)
|
||||
- [Animate Module](#Animate-Module)
|
||||
- [Confirm Module](#Confirm-Module)
|
||||
- [History Module](#History-Module)
|
||||
- [Callbacks Module](#Callbacks-Module)
|
||||
- [Static Methods and Properties](#Static-Methods-and-Properties)
|
||||
- [Instance Methods and Properties](#Instance-Methods-and-Properties)
|
||||
- [From the Svelte Component API](#From-the-Svelte-Component-API)
|
||||
- [Events](#Events)
|
||||
- [Stacks](#Stacks)
|
||||
- [Example Stack](#Example-Stack)
|
||||
- [Features](#Features)
|
||||
- [Licensing and Additional Info](#Licensing-and-Additional-Info)
|
||||
<!-- TOC END -->
|
||||
|
||||
# Getting Started
|
||||
@@ -73,7 +82,7 @@ Inside the pnotify module directory:
|
||||
* `lib/iife` uncompressed IIFE scripts.
|
||||
* `dist` compressed Bright Theme CSS.
|
||||
* `dist/es` compressed ECMAScript modules.
|
||||
* `dist/umd` compressed UMD modules.liz
|
||||
* `dist/umd` compressed UMD modules.
|
||||
* `dist/iife` compressed IIFE scripts.
|
||||
|
||||
## [Migrating from PNotify 3](MIGRATING.md)
|
||||
@@ -273,7 +282,7 @@ PNotify.defaults.icons = 'fontawesome5'; // Font Awesome 5
|
||||
|
||||
# Creating Notices
|
||||
|
||||
To make a notice, use the helper functions:
|
||||
To make a notice, use the factory functions:
|
||||
|
||||
```js
|
||||
// Manually set the type.
|
||||
@@ -297,18 +306,6 @@ PNotify.error({
|
||||
});
|
||||
```
|
||||
|
||||
Or you can manually create a new notice with Svelte's component API (if you know what you're doing):
|
||||
|
||||
```js
|
||||
new PNotify({
|
||||
target: document.body,
|
||||
data: {
|
||||
text: "I'm an alert.",
|
||||
type: 'notice'
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
# Options
|
||||
|
||||
PNotify options and default values.
|
||||
@@ -568,7 +565,7 @@ The History module also has two methods:
|
||||
|
||||
## Callbacks Module
|
||||
|
||||
The callback options all expect the value to be a callback function. If the function returns false on the `beforeOpen` or `beforeClose` callback, that event will be canceled. `beforeInit` and `afterInit` will only work for notices created with the helper functions.
|
||||
The callback options all expect the value to be a callback function. If the function returns false on the `beforeOpen` or `beforeClose` callback, that event will be canceled.
|
||||
|
||||
`Callbacks: {`
|
||||
* `beforeInit`<br>
|
||||
@@ -648,7 +645,7 @@ The callback options all expect the value to be a callback function. If the func
|
||||
* `notice.refs.iconContainer`<br>
|
||||
The icon container DOM element.
|
||||
|
||||
## From the [Svelte Component API](https://svelte.technology/guide#component-api)
|
||||
## From the [Svelte Component API](https://v2.svelte.dev/guide#component-api)
|
||||
|
||||
* `notice.get(option)`<br>
|
||||
Get the value of an option.
|
||||
@@ -768,7 +765,7 @@ PNotify.alert({
|
||||
|
||||
# Licensing and Additional Info
|
||||
|
||||
Copyright 2009-2019 Hunter Perrin
|
||||
Copyright 2009-2020 Hunter Perrin
|
||||
Copyright 2015 Google, Inc.
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
|
||||
Reference in New Issue
Block a user