js-overlay

1.1.0 • Public • Published

Welcome to js-overlay 👋

Version License: MIT Twitter: bastakotiujwol

JS library that lets user to view image gallery, content, iframe content and ajax content in modal box

🏠 Homepage

Demo

Install

npm i js-overlay

Script Tag

Download and include file
<script type:"text/javascript" src="js-overlay.js"></script>

or 

<script type:"text/javascript" src="js-overlay.min.js"></script>

Initialization

const overlay =  new jsOverlay();

For Content viewer 
overlay.createOverlay({ 
  elContent:'String', (String, content to be loaded in modal)
  containerHt: Number, (Number, Modal height.Default 500)
  containerWd: Number, (Number, Modal Width.Default 650)
  })

For Image viewer 
overlay.createOverlay({ 
  imgGallery:'Selector/s', (String, parent container selector/s of Image/s)
  containerHt: Number, (Number, Modal height.Default 500)
  containerWd: Number, (Number, Modal Width.Default 650)
  })

For Iframe viewer 
overlay.createOverlay({ 
  iframeUrl:'String', (String,  URL of page to be loaded)
  containerHt: Number, (Number, Modal height.Default 500)
  containerWd: Number, (Number, Modal Width.Default 650)
  })

For AJAX viewer 
overlay.createOverlay({ 
  ajaxUrl: 'String',(String, Url Where data to be sent and get reponse from ) 
  ajaxData: 'String',(String, Data to be sent to server) 
  ajaxMethod: 'String': (String,  GET or POSt method, default GET )
  containerHt: Number, (Number, Modal height.Default 500)
  containerWd: Number, (Number, Modal Width.Default 650)
  })  


Author

👤 UjW0L

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!


Package Sidebar

Install

npm i js-overlay

Weekly Downloads

0

Version

1.1.0

License

MIT

Unpacked Size

38.9 kB

Total Files

4

Last publish

Collaborators

  • ujw0l