# info-overlay

> An info popup that greys out the screen.

Latest version **0.0.2** (published 2015-06-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install info-overlay
pnpm add info-overlay
yarn add info-overlay
bun add info-overlay
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2015-06-09 |
| First published | 2015-06-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Andrew Morris |
| Maintainers | voltrevo |
| Keywords | info, overlay, popup, info-icon |

## Links

- npm: https://www.npmjs.com/package/info-overlay
- Repository: https://github.com/voltrevo/info-overlay
- Homepage: https://github.com/voltrevo/info-overlay#readme
- Issues: https://github.com/voltrevo/info-overlay/issues
- npm.io page: https://npm.io/package/info-overlay

## Dependencies (3)

- [cssify](https://npm.io/package/cssify.md) ^0.7.0
- [info-icon](https://npm.io/package/info-icon.md) 0.0.1
- [html2jsify](https://npm.io/package/html2jsify.md) 0.0.2

## Alternatives

- [react-native-root-siblings](https://npm.io/package/react-native-root-siblings.md) — 102.9K weekly downloads
- [@praxisui/dialog](https://npm.io/package/@praxisui/dialog.md) — 2.0K weekly downloads
- [easy-toggle-state](https://npm.io/package/easy-toggle-state.md) — 350 weekly downloads
- [ngx-lightbox-evp](https://npm.io/package/ngx-lightbox-evp.md) — 19 weekly downloads
- [react-native-modal-translucent-axton](https://npm.io/package/react-native-modal-translucent-axton.md) — 4 weekly downloads

## Recent versions

- 0.0.2 (latest) — 2015-06-09
- 0.0.1 — 2015-06-07

## README

# info-overlay
Display information for your app via a subtle icon which activates an overlay.

# Quick Demo

```
git clone git@github.com:voltrevo/info-overlay.git
cd info-overlay
npm install
npm run demo
```

Visit [http://localhost:8080/](http://localhost:8080/)

# Usage

`npm install --save info-overlay`

```
'use strict'

var InfoOverlay = require('info-overlay')

window.addEventListener('load', function() {
  var infoOverlay = InfoOverlay()

  infoOverlay.overlay.innerHTML = (
    'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum nec augue ' +
    'ante. Nulla ultrices orci vehicula molestie facilisis. Aenean auctor a magna ' +
    'elementum auctor. Ut ligula nunc, molestie a viverra id, commodo at nisi. ' +
    'Vivamus fermentum non nibh nec ullamcorper.'
  )

  document.body.style.backgroundColor = '#0ff'
  document.body.appendChild(infoOverlay.icon)
})
```

---
_Source: https://npm.io/package/info-overlay · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._