Skip to content

PopupKit is an NPM package that you can call from one line of JavaScript code to display a nice-looking popup modal.

License

Notifications You must be signed in to change notification settings

BraydenTW/popupkit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

43 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PopupKit 1.3.5

PopupKit is an NPM package that you can call from one line of JavaScript code to display a nice-looking popup modal.

What's new in 1.3.5?

  • Fixed CSS import error

Install

NPM

npm i popupkit

Yarn

yarn add popupkit

After installation, paste this into your html file's <head> tag:

<script src="./node_modules/popupkit/index.min.js"></script>

or

CDN

Or if you'd rather use a CDN, paste this inside the <head> tag instead:

<script src='https://unpkg.com/popupkit@1.3.5/index.min.js'></script>

Usage

All you need is one line of JavaScript code. Yep! You heard me right. One line is all you need.

popupkit.simpleLight("This is the title", "This is the message.", () => {
    console.log("Popup is closed")
});
  1. Call the popupkit object
  2. Call in the theme function
  3. Type title in the first parameter
  4. Type title in the second parameter
  5. (OPTIONAL) Write a callback function for when he user closes the popup

Themes

Theme function Description
simpleLight() A simple light-themed popup
simpleDark() A simple dark-themed popup
blackAndWhite() A black and white popup
blueAndWhite() A blue and white popup
redAndWhite() A red and white popup
yellowAndWhite() A yellow and white popup
greenAndWhite() A green and white popup

More to come! 😉

License

This project is licensed under the MIT License - see the MIT License file for details.

About

PopupKit is an NPM package that you can call from one line of JavaScript code to display a nice-looking popup modal.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published