# environment-notifier > Display on-screen notifications alerting users when viewing matching web application environments. Latest version **2.7.0** (published 2018-11-02) · MIT license · 0 weekly downloads ## Install ```sh npm install environment-notifier pnpm add environment-notifier yarn add environment-notifier bun add environment-notifier ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 2.7.0 | | Published | 2018-11-02 | | First published | 2017-02-28 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 3 | | Unpacked size | 341.2 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 0 | | Author | Ritter Insurance Marketing | | Maintainers | ritterim | | Keywords | environment, notifier | ## Links - npm: https://www.npmjs.com/package/environment-notifier - Repository: https://github.com/ritterim/environment-notifier - Homepage: https://github.com/ritterim/environment-notifier#readme - Issues: https://github.com/ritterim/environment-notifier/issues - npm.io page: https://npm.io/package/environment-notifier ## Dependencies (3) - [assign-deep](https://npm.io/package/assign-deep.md) ^0.4.5 - [sweetalert2](https://npm.io/package/sweetalert2.md) ^6.6.0 - [font-color-contrast](https://npm.io/package/font-color-contrast.md) ^1.0.3 ## Alternatives - [replicas-cli](https://npm.io/package/replicas-cli.md) — 3.0K weekly downloads - [env-contract](https://npm.io/package/env-contract.md) — 133 weekly downloads - [@openveo/api](https://npm.io/package/@openveo/api.md) — 61 weekly downloads - [@ryniaubenpm2/cumque-error-reiciendis](https://npm.io/package/@ryniaubenpm2/cumque-error-reiciendis.md) — 54 weekly downloads - [ts-global-type-extra](https://npm.io/package/ts-global-type-extra.md) — 11 weekly downloads ## Recent versions - 2.7.0 (latest) — 2018-11-02 - 2.6.0 — 2017-12-20 - 2.5.0 — 2017-12-20 - 2.4.0 — 2017-12-19 - 2.3.0 — 2017-12-18 - 2.2.0 — 2017-08-10 - 2.1.0 — 2017-05-19 - 2.0.0 — 2017-05-19 - 1.1.0 — 2017-03-21 - 1.0.0 — 2017-02-28 - 1.0.0-alpha.0 — 2017-02-28 ## README # Environment Notifier [![Build status](https://ci.appveyor.com/api/projects/status/6sktj0hnf1xo9ok1?svg=true)](https://ci.appveyor.com/project/RimDev/environment-notifier) [![npm version](https://img.shields.io/npm/v/environment-notifier.svg)](https://www.npmjs.com/package/environment-notifier) Display on-screen notifications alerting users when viewing matching web application environments. ![Environment ribbon on top](/docs/images/ribbon_top.png) _An example with the ribbon fixed at the top_ ![Environment ribbon at bottom](/docs/images/ribbon_bottom.png) _An example with the ribbon fixed at the bottom_ ## Installation ``` npm install environment-notifier ``` Or, load this script manually: [https://unpkg.com/environment-notifier@latest/lib/environment-notifier.min.js](https://unpkg.com/environment-notifier@latest/lib/environment-notifier.min.js) -- This targets the latest version, which may include breaking changes for major version updates. A specific version can be targeted to avoid potential breaking changes. See [https://unpkg.com](https://unpkg.com) for more information. ## Quickstart ```javascript new EnvironmentNotifier().start(); ``` ## Usage - Run `new EnvironmentNotifier().start();`, optionally specifying the scope in the parameter _(defaults to `document.body`)_. Configuration options can be specified in the `EnvironmentNotifier` constructor. Example: ```javascript new EnvironmentNotifier({ environmentDefaults: { ribbonLocation: 'top' } }).start(); ``` ## Configuration options | Option | Description | Default Value | | --------------------- | -------------------------------------------------------------- | --------------------------- | | `defaultDomScope` | The default DOM scope to use. | `document.body` | | `environmentDefaults` | The defaults to apply when specific settings are not provided. | See below | | `environments` | The configured environments. | Local, QA, UAT environments | ### environmentDefaults | Option | Description | Default Value | | -------------------- | ------------------------------------------------------------------------ | ---------------------------------------------------------------------------------- | | `color` | Environment color. (Accepted value types: `#ccc`, `rgb()`, `rgba()`) | `'rgba(255, 0, 0, .75)'` | | `detection` | The environment detection function (returns `true` for match). | `() => false` | | `modalMessageHtml` | The HTML message to display on the modal. | `'✨ You are viewing the {{ environment.name }} environment. ✨'` | | `showModalEveryView` | Show modal for every page view. | `false` | | `showModalFirstView` | Show modal for first page view. | `false` | | `ribbonLocation` | The location of the on-screen ribbon. (Accepted values: `top`, `bottom`) | `'bottom'` | | `ribbonPosition` | The CSS `position` of the ribbon. | `'fixed'` | | `ribbonTarget` | The DOM element to inject the ribbon into. | `document.body` | | `showRibbon` | Whether the on-screen ribbon should be shown or not. | `true` | | `customClass` | Custom class to be added to the body of the ribbon and modal. | `null` | ## Methods ### `addEnvironment(environment)` Add a new environment. `environment` should be `{ name: String, detection: Function, ... }`. ### `getCurrentEnvironment()` Get the current environment object. ### `removeEnvironment(environmentName)` Remove an environment where `name` matches provided `environmentName`. ### `start(domScope = this.configuration.defaultDomScope)` Start environment notifier working with `domScope`. ## Events ### `environmentNotifier.modalDismissed` Raised when the modal has been dismissed by the user. ## Development - `npm install` - `npm start` to run demo. - `npm run build` or `npm run watch` - `npm test` or `npm run test:watch` to run tests. - `npm run lint` to run linter. - `npm run validate` to run linter than tests. ## License MIT --- _Source: https://npm.io/package/environment-notifier · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._