Skip to content
This repository has been archived by the owner on Oct 20, 2023. It is now read-only.

apvarun/poppyjs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

logo

Poppy

NPM GitHub package.json version npm

Simple, Multipurpose Open Source Pop-in Messages https://github.com/apvarun/poppyjs

Demo page

Features

  • Customaziable options
  • No dependency

Browser Support

  • Chrome
  • Safari
  • Firefox
  • IE 10+
  • Edge
  • Opera

Getting Started

npm

$ npm install poppyjs

or

$ yarn add poppyjs

Usage

ES6

import poppy from 'poppyjs'
    
let poppy = new Poppy({
    title: {
        text: "Hello Poppy",
        color: "#556BA4"
    },
    content: "Time to switch to Poppy for a better user experience.",
    cta: {
        text: "Click me",
        url: "https://github.com/apvarun/poppyjs",
        color: "#556BA4",
        newtab: true
    },
    position: "bottomLeft"
});
poppy.show();

Options

new Poppy({
    title: {
        text: String, // Title text (Default : "")
        avatar: String, // Avatar image URL (Default : "")
        color: String,  // Color Code (Default : "")
    },
    content: String, // Content text (Default : "")
    cta: {
        text: String, // CTA text (Default : "")
        url: String, // CTA Link URL (Default : "")
        color: String, // Color Code (Default : "")
        newtab: Boolean, // To open the CTA link in a new tab (Default : false)
        onclick: Function, // Callback function when CTA button is clicked (Default : () => {})
    },
    coverImage: String, // Cover image URL (Default : "")
    position: String, // Potision (topLeft, topRight, bottomLeft, bottomRight) (Default : "bottomRight")
    delay: Number, // Delay in ms before displaying poppy (Default : 0),
    closeAfter: Number, // Time in ms after which the poppy should auto-close (Default : null)
})

Built With

Changelog

Refer CHANGELOG.md file for library changes

License

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