# angular-popper

> Popover component for Angular 2+ based on Popper.js library.

Latest version **2.0.1** (published 2019-03-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install angular-popper
pnpm add angular-popper
yarn add angular-popper
bun add angular-popper
```

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.1 |
| Published | 2019-03-18 |
| First published | 2017-04-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 119.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 10 |
| Author | Vitaliy Bobrov |
| Maintainers | bobrov1989 |
| Keywords | angular, angular 2, angular 4, popper, popperjs, popover, ngx, tooltip, schematics, ng-add |

## Links

- npm: https://www.npmjs.com/package/angular-popper
- Repository: https://github.com/vitaliy-bobrov/angular-popper
- Homepage: https://github.com/vitaliy-bobrov/angular-popper#readme
- Issues: https://github.com/vitaliy-bobrov/angular-popper/issues
- npm.io page: https://npm.io/package/angular-popper

## Dependencies (1)

- [tslib](https://npm.io/package/tslib.md) ^1.9.0

## Alternatives

- [vest](https://npm.io/package/vest.md) — 50.1K weekly downloads
- [@regle/core](https://npm.io/package/@regle/core.md) — 47.0K weekly downloads
- [typeof-arguments](https://npm.io/package/typeof-arguments.md) — 12.5K weekly downloads
- [@lokalise/projects-engine-contracts](https://npm.io/package/@lokalise/projects-engine-contracts.md) — 978 weekly downloads
- [@osjwnpm/nam-laboriosam-quibusdam](https://npm.io/package/@osjwnpm/nam-laboriosam-quibusdam.md) — 70 weekly downloads

## Recent versions

- 2.0.1 (latest) — 2019-03-18
- 1.0.0-alpha.1 (alpha) — 2017-04-11
- 2.0.0 — 2018-05-25
- 1.0.0 — 2018-03-15
- 1.0.0-beta-1 — 2017-08-02
- 1.0.0-alpha.2 — 2017-06-05

## README

# angular-popper

[![Build Status](https://travis-ci.org/vitaliy-bobrov/angular-popper.svg?branch=master)](https://travis-ci.org/vitaliy-bobrov/angular-popper)
[![npm version](https://badge.fury.io/js/angular-popper.svg)](https://badge.fury.io/js/angular-popper)
[![npm](https://img.shields.io/npm/dt/angular-popper.svg)](https://github.com/vitaliy-bobrov/angular-popper)

Popover component for Angular 2+ based on [Popper.js](https://popper.js.org/) library.

[Demo](https://vitaliy-bobrov.github.io/angular-popper/)

## Instalation

* Angular CLI > v6.0.0: `ng add angular-popper`

* yarn: `yarn add popper.js angular-popper`

* npm: `npm install --save popper.js angular-popper`

## Usage

### Import NgxPopper module
```ts
...
import { NgxPopper } from 'angular-popper';

@NgModule({
  ...
  imports: [
    NgxPopper
  ]
  ..
})
export class AppModule {}
```

### Use in template

```html
<angular-popper>
  <div class="target-block border border-primary">
    Target
  </div>

  <div content>Popper content</div>
</angular-popper>
```

## Input properties

### show: boolean

**Default**: `true`

Specify if popper visible.

### target?: string | Element

Specify popper element target, accepts HTMLElement reference or CSS selector.

### closeButton: boolean

**Default**: `false`

Specify if popper should contain close button.

### placement: Popper.Placement

**Default**: `'bottom'`

Specify popper placement.

### positionFixed: boolean

**Default**: `false`

Specify if popper should has `fixed` position.

### eventsEnabled: boolean

**Default**: `true`

Specify if popper should listen for scroll & resize events.

### modifiers?: Popper.Modifiers

Popper.js modifiers object, [details](https://popper.js.org/popper-documentation.html#modifiers).

## Events

### close

Fires on popper close button click.

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