An open API service indexing awesome lists of open source software.

https://github.com/viivue/easy-popup

Super light-weight JavaScript library to create a simple popup with mobile layout.
https://github.com/viivue/easy-popup

css easy-collection javascript popup

Last synced: about 1 month ago
JSON representation

Super light-weight JavaScript library to create a simple popup with mobile layout.

Awesome Lists containing this project

README

        

# Easy Popup

Visit https://easy-popup.netlify.app/ for documentation.

[![release](https://badgen.net/github/release/viivue/easy-popup/)](https://github.com/viivue/easy-popup/releases/latest)
[![npm](https://badgen.net/npm/v/@viivue/easy-popup)](https://www.npmjs.com/package/@viivue/easy-popup)
[![minified](https://badgen.net/badge/CSS+JS/21KB/cyan)](https://www.jsdelivr.com/package/gh/viivue/easy-popup)
[![jsdelivr](https://data.jsdelivr.com/v1/package/gh/viivue/easy-popup/badge?style=rounded)](https://www.jsdelivr.com/package/gh/viivue/easy-popup)
[![Netlify Status](https://api.netlify.com/api/v1/badges/099e6ca7-c6f5-4f93-9f49-15986c7fc8d8/deploy-status)](https://app.netlify.com/sites/easy-popup/deploys)
[![Staging deploy](https://github.com/viivue/easy-popup/actions/workflows/staging-deploy.yml/badge.svg)](https://github.com/viivue/easy-popup/actions/workflows/staging-deploy.yml)

## Getting started

### CDN

```html

```

### NPM Package

Install NPM package

```shell
npm i @viivue/easy-popup
```

Import

```js
import "@viivue/easy-popup";
```

## Development

[//]: # (Note: this part should be identical with the end.md)

Clone this repo, then:

```shell
# install
npm i

# run dev server
npm run dev
```

### Publish

```shell
# build
npm run prod

# test package before publish
npm pack

# publish package (search & replace old version number)
npm publish
```

### Contribute

Feel free to submit new issue or create a pull request.

Branches:

- `main`: for publishing (handled by Netlify at https://easy-popup.netlify.app/)
- `staging`: for development deploy (handled by GitHub Pages at https://viivue.github.io/easy-popup/)
- `gh-pages-staging`: for deploying staging branch

## Licence

MIT (c) 2023 ViiVue.

---

[![docs](https://badgen.net/badge/icon/EasyPopup?icon=github&label=GitHub&color=6495ED&scale=1.2)](https://github.com/viivue/easy-popup)
[![viivue](https://badgen.net/badge/Made with ♥ by/ViiVue/f0ca05?scale=1.2)](https://github.com/viivue)
[![powered by](https://badgen.net/badge/Powered by/Wellii/blue?scale=1.2)](https://github.com/phucbm/wellii)