modal.js

modal.js

A modern and simple modal

NPM

npm install --save modal.js

Download

What does it do?

• Build a modal customizable.
• By default create text, image modal.
• You can customize it with parameters
• Its possible to create different styles of the same modal and then choose one

Browser support (Only tested on)

• Chrome (last two)
• Firefox (last two)

Modal on!

Default mode

Not recommended! My use of styles is disgusting, You are warned!

$().modal({"content": {"type":"text","data": "Hola mundo!" }});
$().modal({"content": {"type":"image", "data": "http://lorempixel.com/400/200/"}})

Newbie mode

The parameter is json with this structure:

'content' : {                    //<-- Content!
    'type' : String,             //<-- Type of data entry. Default: text. It must exist on plugin.json
    'data' : Object,             //<-- Any data to show. Here.
    'className' : String,        //<-- Name of class on css who define style of content.
},
'shape' : {                      //<-- Shape!
    'className' : String,        //<-- Name of class on css who define style of the shape literally*
    'style' : String             //<-- Name of class on css who define style of the canvas of content*
}
'layout' : String,               //<-- Define layout of modal*
'header' : {					 //<-- Header!
    'icon' : String,             //<-- If you wanna set a icon or a something on header but not content.
    'title' : {                  //<-- Title!
        'className' : String,    //<-- Name of class on css who define style of title header.
        'content' : String       //<-- Text of title
	}
},
'close' : {                      //<-- Close modal!
    'button' : Boolean,          //<-- True or empty or null create a close button. False dont.
    'escape' : Boolean           //<-- True or empty or null set key 'Esc' to close modal.
},
'acc' : {                        //<-- Accessibility time!
    'text' : String              //<-- Text to read for accessibility readers.
},
'btns' : [{                      //<-- Buttons everywhere! Is an array of buttons.
    'value' : String,            //<-- Text display on button.
    'shape' : String,            //<-- Name of class on css who define a style of button.
    'type' : String,             //<-- Define event of button. Function, link or close modal.
    'action' : String,           //<-- Define funcion or link of type button.
    'close' : Boolean,           //<-- True or empty or null button close modal. False dont.
    'key' : CharCode             //<-- Charcode of key trigger of btn.
}],
'overlay' : {                    //<-- Overlay!
    'className' : String,        //<-- Overwrite style of overlay.
    'click' : Boolean            //<-- True, empty or null close modal on click overlay. False dont.
},
'width' : String                 //<-- Set with of modal. Auto for default.

Pro mode

You can modify defaults plugins.json and create diferents templates of modal. Plugins.json have this structure:

"text" : {                                   //<-- Name for plugin.
    "element" : "",						     //<-- Parent element of content.
	"objAttrs": {							 //<-- Set attr to element. elm.attr = value  
	    "innerHTML" : "",
		"id" : ""
	},
    'attrs' : {                              //<-- Set attr to element. elm.setAttribute(attr, value)
    },
	"dfts" : {							     //<-- Overwrite defaults
		"shape" : "",
		"shapeStyle" : "",
		"layout" : "",
		"icon" : "",
		"mb_clase" : ""
	}
}

Changelog

1.0.1 (June 02, 2016)

• Change eval from dftls reads for windows['variable'].
• Reorganized proyect.
• Publish on npm.