ngx-popperjs

[![npm][badge-npm-version]][url-npm] [![npm][badge-npm-downloads]][url-npm] [![MIT licensed][badge-licence]][url-licence] [![Build state][badge-ci-state]][url-ci-state] [![Size][badge-bundle]][url-bundle] [![Rate this package][badge-openbase]][url-openbase]

ngx-popperjs is an angular wrapper for the FloatingUI library (v ^1.5.3).

VERY IMPORTANT READ THIS

With v17 ngx-popperjs won't get any updates. That's because from v17 it's not actually using popper.js anymore.

I developed ngx-float-ui and released v17 at the same time of this.
My suggestion is to migrate to that one. In 6 months from the release, this version will be marked as deprecated.
Since the new library isn't affected by the "Chrome 110 bug" I would suggest to migrate earlier versions as well.
If you open an issue on ngx-float-ui asking for a certain version (or search for an open issue for that version and leave a thumb), I will publish earlier versions as well.

NOW USING FLOATING UI - UPGRADING TO v17

If you used previous versions of ngx-popperjs, you'll now that it wrapped popper.js initially.
Since Floating UI is the future version of Popper.js and since latest happenings with recent Chrome updates breaking ngx-popperjs, I decided to move to the newer technology.

What impacts does it have for the library?

Well on a graphic perspective, none. You will be able to use the v17 without changing any stylings.

The only deprecation is in the NgxPopperjsOptions which now doesn't provide the modifiers.
The reason is that you can't now pass modifiers like you did in Popper.js.
It didn't seem like a huge change, since in this library modifiers should be mostly (but let me know with an issue) for preventing the popper flipping.
Maybe if we see that it can be useful we can pass an override for the middleware.

I simply added a new attribute, popperFlip, that you can set to false, in order to prevent the flipping (default true).

Check NgxPopperjs official page to stay up to date!

$3

The goal of this library is to take Mr Frankel's ngx-popper and update the compatibility for more recent versions of Angular.
Since the old library is compatible with Angular 7 and earlier, I started with Angular 8.
If you need to work with an older version of Angular (5 to 7), please refer to Mr Frankel's ngx-popper.

$3

Since many complained about using the NgxPopperjsPlacements enum, I added a version of the popper directive which accepts a plain string as placement!
Now you can use it with all the options of the classic popper, but you'll have to use:

popperLoose instead of popper

and

popperLoosePlacement instead of popperPlacement

$3

node and npm are required to run this package.

1. Use npm/yarn to install the package:

``terminal
$ npm install @floating-ui/dom ngx-popperjs --save
`

Or

`terminal
$ yarn add @floating-ui/dom --save
$ yarn add ngx-popperjs --save
`

2. You simply add into your module NgxPopperjsModule:

`typescript
import {NgxPopperjsModule} from 'ngx-popperjs';

@NgModule({
// ...
imports: [
// ...
NgxPopperjsModule
]
})
`

Optionally you can include in your styles.css / styles.css one of the prebuilt themes:
* @import node_modules/ngx-popperjs/css/theme-dark.css
* @import node_modules/css/theme-white.css

* @use ngx-popperjs/scss/theme as popperBaseTheme
* @use ngx-popperjs/scss/theme-dark as popperDarkTheme
* @use ngx-popperjs/scss/theme-white popperWhiteTheme

or easily create your own theme using the @mixin:

`
@use "ngx-popperjs/scss/theme" as popperBaseTheme;

body {
@include popperjs.ngx-popperjs-theme($background-color, $text-color, $max-width, $z-index);
}
`

3. Add to view:

`HTML

Popper on bottom

[popperShowOnStart]="true"
[popperTrigger]="'click'"
popperHideOnClickOutside
[popperHideOnScroll]="true"
[popperPlacement]="'bottom'">

Hey!

Choose where to put your popper!

`

4. As text:
`HTML

[popperTrigger]="'hover'"
[popperPlacement]="'bottom'"
(popperOnShown)="onShown($event)">

Pop

on the bottom

`

`HTML

[popperTrigger]="'hover'"
[popperPlacement]="'bottom'"
[popperStyles]="{'background-color: 'blue''}"
(popperOnShown)="onShown($event)">

Pop

on the bottom

`

5. Position fixed, breaking overflow:
`HTML

[popperTrigger]="'hover'"
[popperPlacement]="'bottom'"
[popperPositionFixed]="true"
(popperOnShown)="onShown($event)">

`

6. Specific target:
`HTML