1.0.4 • Published 3 years ago
popdown v1.0.4
Popdown
Responsive, lightweight, easy-to-use alternatives for prompt(), alert(), and confirm().
NOTE: Mostly working, but not yet fully tested.
Include
<script src="%YOURPATH%/Popdown.js"></script>or, if you want the minified version,
<script src="%YOURPATH%/Popdown.min.js"></script>Usage
First, initalize the library. This should be done only after the body of your document has loaded.
Popdown.start()Popdown.alert()
Syntax:
Popdown.alert(message, callback, options);Example:
Popdown.alert('Hi!', () => {console.log('Hello!')});Popdown.confirm()
Syntax:
Popdown.confirm(message, callback, options);Example:
Popdown.confirm('Do you like green eggs and ham?', (bool) => {console.log(bool)});Popdown.prompt()
Syntax:
Popdown.prompt(message, callback, options);Example:
Popdown.prompt('What is your name?', (response) => {console.log(response)});Parameters
| Parameter | Description | Type | Default |
|---|---|---|---|
| message | Display text of the Popdown | string | "" |
| callback | Will execute when user exits the Popdown. Popdown.confirm() callback should accept a boolean as parameter. Popdown.prompt() callback should accept a string or null as parameter. | function | null |
| options | Used to pass in lesser-used parameters (see below for details). | object | {} |
Options
| Option | Description | Type | Default |
|---|---|---|---|
| head | Display text for header of the Popdown | string | "" |
| context | Context for callback execution | object/context | null |
Build Instructions
First, install:
npm install --save popdownThen, require:
const Popdown = require('popdown');The package comes with multiple methods to allow you to build the client-side js files:
Popdown.buildString(); //returns a string representation of the client-side js file
Popdown.buildStringMin(); //returns a string representation of the client-side js file (minified)
Popdown.buildToFile(location); //saves the client side js file to "Popdown.js" at the specified location
Popdown.buildToFileMin(location); //saves the client side js file (minified) to "Popdown.min.js" at the specified location
Popdown.buildFiles(location); //executes both of the above methods