KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #developer-tools #ai-agent #claude-code #codex #typescript #ai-agents #deepseek-harness #mcp #cli #rust

ngx-popperjs

★ 66 Open GitHub ↗

An Angular 8+ wrapper for @popperjs/core

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 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](https://floating-ui.com/) 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](https://tonysamperi.github.io/ngx-popperjs) to stay up to date!

### Premise

The goal of this library is to take Mr Frankel's [ngx-popper](https://github.com/MrFrankel/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](https://github.com/MrFrankel/ngx-popper/).

### From v15.2.0:

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`

### Installation

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-content #popper1Content>
       <p class="bold">Popper on bottom</p>
   </popper-content>
   <div [popper]="popper1Content"
        [popperShowOnStart]="true"
        [popperTrigger]="'click'"
		popperHideOnClickOutside
        [popperHideOnScroll]="true"
        [popperPlacement]="'bottom'">
       <p class="bold">Hey!</p>
       <p class="thin">Choose where to put your popper!</p>         
   </div>
  ```

4. As text:
 ```HTML
      <div popper="As text"
           [popperTrigger]="'hover'"
           [popperPlacement]="'bottom'"
           (popperOnShown)="onShown($event)">
        <p class="bold">Pop</p>
        <p class="thin">on the bottom</p>
      </div>
 ```

```HTML
       <div popper="{{someTextProperty}}"
            [popperTrigger]="'hover'"
            [popperPlacement]="'bottom'"
            [popperStyles]="{'background-color: 'blue''}"
            (popperOnShown)="onShown($event)">
         <p class="bold">Pop</p>
         <p class="thin">on the bottom</p>
       </div>
  ```
 
  5. Position fixed, breaking overflow:
   ```HTML
        <div popper="As text"
             [popperTrigger]="'hover'"
             [popperPlacement]="'bottom'"
             [popperPositionFixed]="true"
             (popperOnShown)="onShown($event)">
        </div>
   ```
 
 6. Specific target:
  ```HTML
 <div class="example">
       <div #popperTargetElement></div>
       <div popper="As text"
            popperTrigger="hover"
            popperPlacement="bottom"
            [popperTarget]="popperTargetElement.nativeElement"
            (popperOnShown)="onShown($event)">
       </div>
  ```
  
7. hide/show programmatically:
  ```HTML
   <div [popper]="tooltipcontent"
        popperTrigger="hover"
        popperPlacement="bottom"
        [popperApplyClass]="'popperSpecialStyle'">
        <p class="bold">Pop</p>
        <p class="thin">on the bottom</p>
      </div>
      <popper-content #tooltipcontent>
        <div>
          <p>This is a tooltip with text</p>
          <span (click)="tooltipcontent.hide()">Close</span>
        </div>
      </popper-content>
  ```
 
8. Attributes map:  
  
    | Option                   | Type              | Default   | Description                                                                            |
    |:-------------------------|:------------------|:----------|:---------------------------------------------------------------------------------------|
    | popperDisableAnimation   | boolean           | false     | Disable the default animation on show/hide                                             |
    | popperDisableStyle       | boolean           | false     | Disable the default styling                                                            |
    | popperDisabled           | boolean           | false     | Disable the popper, ignore all events                                                  |
    | popperDelay              | number            | 0         | Delay time until popper it shown                                                       |
    | popperTimeout            | number            | 0         | Set delay before the popper is hidden                                                  |
    | popperTimeoutAfterShow   | number            | 0         | Set a time on which the popper will be hidden after it is shown                        |
    | popperPlacement          | Placement(string) | auto      | The placement to show the popper relative to the reference element                     |
    | popperTarget             | HtmlElement       | auto      | Specify a different reference element other the the one hosting the directive          |
    | popperBoundaries         | string(selector)  | undefined | Specify a selector to serve as the boundaries of the element                           |
    | popperShowOnStart        | boolean           | false     | Popper default to show                                                                 |
    | popperTrigger            | Trigger(string)   | click     | Trigger/Event on which to show/hide the popper                                         |
    | popperPositionFixed      | boolean           | false     | Set the popper element to use position: fixed                                          |
    | popperAppendTo           | string            | undefined | append The popper-content element to a given selector, if multiple will apply to first |
    | popperPreventOverflow    | boolean           | undefined | Prevent the popper from being positioned outside the boundary                          |
    | popperHideOnClickOutside | boolean           | true      | Popper will hide on a click outside                                                    |
    | popperHideOnScroll       | boolean           | false     | Popper will hide on scroll                                                             |
    | popperHideOnMouseLeave   | boolean           | false     | Popper will hide on mouse leave                                                        |
    | popperApplyClass         | string            | undefined | list of comma separated class to apply on ngpx__container                              |
    | popperStyles             | Object            | undefined | Apply the styles object, aligned with ngStyles                                         |
    | popperApplyArrowClass    | string            | undefined | list of comma separated class to apply on ngpx__arrow                                  |
    | popperOnShown            | EventEmitter<>    | $event    | Event handler when popper is shown                                                     |
    | popperOnHidden           | EventEmitter<>    | $event    | Event handler when popper is hidden                                                    |
    | popperOnUpdate           | EventEmitter<>    | $event    | Event handler when popper is updated                                                   |
    | popperAriaDescribeBy     | string            | undefined | Define value for aria-describeby attribute                                             |
    | popperAriaRole           | string            | popper    | Define value for aria-role attribute                                                   |
    | popperFlip               | boolean           | true      | Enable or disable the flipping                                                         |

9. Override defaults:

ngx-popperjs comes with a few default properties you can override in default to effect all instances
    These are overridden by any child attributes.
```JavaScript
NgModule({
  imports: [
    BrowserModule,
    FormsModule,
    NgxPopperjsModule.forRoot({placement: NgxPopperjsPlacements.TOP})],
  declarations: [AppComponent],
  providers: [],
  bootstrap: [AppComponent]

});
```
  
   | Options                  | Type              | Default   |
   |:-------------------      |:----------------  |:--------- |
   | showDelay                | number            | 0         |
   | disableAnimation         | boolean           | false     |
   | disableDefaultStyling    | boolean           | false     |
   | placement                | Placement(string) | auto      |
   | boundariesElement        | string(selector)  | undefined |
   | trigger                  | Trigger(string)   | hover     |
   | positionFixed            | boolean           | false     |
   | hideOnClickOutside       | boolean           | true      |
   | hideOnMouseLeave         | boolean           | false     |
   | hideOnScroll             | boolean           | false     |
   | applyClass               | string            | undefined |
   | styles                   | Object            | undefined |
   | applyArrowClass          | string            | undefined |
   | ariaDescribeBy           | string            | undefined |
   | ariaRole                 | string            | undefined |
   | appendTo                 | string            | undefined |
   | preventOverflow          | boolean           | undefined |

10. popperPlacement:

| 'click'
  | 'mousedown'
  | 'hover'
  | 'none'
  
    
### Demo site with sample codes
<a href="https://tonysamperi.github.io/ngx-popperjs/">Demo of ngx-popperjs</a>

### Contribute
  You can only **report bugs**. Every other issue will be deleted right away.
  
```terminal
  $ npm install
  $ npm run start  //run example
```

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details

### Thanks to

MrFrankel for setting up ngx-popper and maintaining till v 7.0.0.

[badge-bundle]: https://img.shields.io/bundlephobia/minzip/ngx-popperjs
[badge-ci-state]: https://github.com/tonysamperi/ngx-popperjs/actions/workflows/main.yml/badge.svg
[badge-licence]: https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square
[badge-npm-downloads]: https://img.shields.io/npm/dm/ngx-popperjs.svg?style=flat-square
[badge-npm-version]: https://img.shields.io/npm/v/ngx-popperjs.svg?style=flat-square
[badge-openbase]: https://badges.openbase.com/js/rating/ngx-popperjs.svg
[url-bundle]: https://img.shields.io/bundlephobia/minzip/ngx-popperjs
[url-ci-state]: https://github.com/tonysamperi/ngx-popperjs/actions
[url-licence]: https://github.com/tonysamperi/ngx-popperjs/blob/master/LICENSE
[url-npm]: https://www.npmjs.com/package/ngx-popperjs
[url-openbase]: https://openbase.com/js/ngx-popperjs

ngx-popperjs

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README