@instantjs/core
v0.0.1
Published
**instantjs** is a websocket library.
Downloads
2
Readme
instantjs
instantjs is a Javascript library for non-blocking notifications and without jQuery. The goal is to create a simple core library that can be customized and extended.
Demo
- Demo can be found at https://instantjs.hau.xyz
Install
npm
npm install --save instantjs
yarn
yarn add instantjs
Wiki and Change Log
Breaking Changes
Animation Changes
The following animations options have been deprecated and should be replaced:
Quick Start
3 Easy Steps
For other API calls, see the demo.
Link to instantjs.css
<link href="instantjs.css" rel="stylesheet"/>
Link to instantjs.js
<script src="instantjs.js"></script>
use instantjs to display a toast for info, success, warning or error
// Display an info toast with no title instantjs.info('Are you the 6 fingered man?')
Other Options
Building instantjs
To build the minified and css versions of instantjs you will need node installed. (Use Homebrew or Chocolatey.)
npm install -g gulp karma-cli
npm install
At this point the dependencies have been installed and you can build instantjs
- Run the analytics
gulp analyze
- Run the test
gulp test
- Run the build
gulp
Contributing
For a pull request to be considered it must resolve a bug, or add a feature which is beneficial to a large audience.
Pull requests must pass existing unit tests, CI processes, and add additional tests to indicate successful operation of a new feature, or the resolution of an identified bug.
Requests must be made against the develop
branch. Pull requests submitted against the master
branch will not be considered.
All pull requests are subject to approval by the repository owners, who have sole discretion over acceptance or denial.
License
instantjs is under MIT license