add none trigger and improved docs

MrFrankel · Sep 5, 2017 · 92964a6 · 92964a6
1 parent 1a2cc44
commit 92964a6
Show file tree

Hide file tree

Showing 3 changed files with 56 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -92,6 +92,44 @@ constructor(private elem: ElementRef) {
     PopperController.baseOptions.disableAnimation = true;
   }
 ```
+
+    | Options                  | Type              | Default  |
+    |:-------------------      |:----------------  |:-------- |
+    | disableAnimation         | boolean           | false    |
+    | disableDefaultStyling    | boolean           | false    |        
+    | placement                | Placement(string) | auto     |
+    | boundariesElement        | string(selector)  | undefined|  
+    | trigger                  | Trigger(string)   | hover    |    
+    | popperModifiers          | popperModifier    | undefined|
+
+
+7. popperPlacement:
+
+  | 'top'
+  | 'bottom'
+  | 'left'
+  | 'right'
+  | 'top-start'
+  | 'bottom-start'
+  | 'left-start'
+  | 'right-start'
+  | 'top-end'
+  | 'bottom-end'
+  | 'left-end'
+  | 'right-end'
+  | 'auto'
+  | 'auto-top'
+  | 'auto-bottom'
+  | 'auto-left'
+  | 'auto-right'
+  | Function
+
+8. popperTrigger:
+  | 'click'
+  | 'mousedown'
+  | 'hover';
+  | 'none';
+
 
 ### Demo
 <a href="https://mrfrankel.github.io/ngx-popper/">Demo</a>

diff --git a/src/popper.model.ts b/src/popper.model.ts
@@ -1,12 +1,14 @@
 export type Trigger =
   | 'click'
   | 'mousedown'
-  | 'hover';
+  | 'hover'
+  | 'none' ;
 
 export class Triggers {
-  static Click: Trigger = 'click';
-  static Hover: Trigger = 'hover';
-  static MouseDown: Trigger = 'mousedown';
+  static CLICK: Trigger = 'click';
+  static HOVER: Trigger = 'hover';
+  static MOUSEDOWN: Trigger = 'mousedown';
+  static NONE: Trigger = 'none';
 }
 
 export type Placement =

diff --git a/src/popper.ts b/src/popper.ts
@@ -24,6 +24,7 @@ export class PopperController implements OnInit, OnChanges {
   private scheduledShowTimeout: any;
   private scheduledHideTimeout: any;
   private ignoreDocClick: boolean = false;
+  private subscriptions: any[] = [];
 
   constructor(private viewContainerRef: ViewContainerRef,
               private resolver: ComponentFactoryResolver) {
@@ -72,7 +73,7 @@ export class PopperController implements OnInit, OnChanges {
 
   @HostListener('click', ['$event'])
   showOrHideOnClick($event: MouseEvent): void {
-    if (this.disabled || this.showTrigger !== Triggers.Click) {
+    if (this.disabled || this.showTrigger !== Triggers.CLICK) {
       return;
     }
     this.ignoreDocClick = true;
@@ -81,7 +82,7 @@ export class PopperController implements OnInit, OnChanges {
 
   @HostListener('mousedown', ['$event'])
   showOrHideOnMouseOver($event: MouseEvent): void {
-    if (this.disabled || this.showTrigger !== Triggers.MouseDown) {
+    if (this.disabled || this.showTrigger !== Triggers.MOUSEDOWN) {
       return;
     }
     this.ignoreDocClick = true;
@@ -90,7 +91,7 @@ export class PopperController implements OnInit, OnChanges {
 
   @HostListener('mouseenter')
   showOnHover(): void {
-    if (this.disabled || this.showTrigger !== Triggers.Hover) {
+    if (this.disabled || this.showTrigger !== Triggers.HOVER) {
       return;
     }
     this.scheduledShow();
@@ -102,15 +103,15 @@ export class PopperController implements OnInit, OnChanges {
       this.ignoreDocClick = false;
       return;
     }
-    if (this.disabled || this.showTrigger !== Triggers.Click) {
+    if (this.disabled || this.showTrigger !== Triggers.CLICK) {
       return;
     }
     this.scheduledHide($event, 0);
   }
 
   @HostListener('mouseleave', ['$event'])
   hideOnLeave($event: MouseEvent): void {
-    if (this.disabled || this.showTrigger !== Triggers.Hover) {
+    if (this.disabled || this.showTrigger !== Triggers.HOVER) {
       return;
     }
     this.scheduledHide($event, 0);
@@ -151,6 +152,11 @@ export class PopperController implements OnInit, OnChanges {
     }
   }
 
+  ngOnDestroy(){
+    this.subscriptions.forEach(sub => sub.unsubscribe && sub.unsubscribe());
+    this.subscriptions.length = 0;
+  }
+
   toggle() {
     this.shown ? this.hide() : this.scheduledShow();
   }
@@ -235,7 +241,7 @@ export class PopperController implements OnInit, OnChanges {
       trigger: this.showTrigger,
       popperModifiers: this.popperModifiers,
     });
-    popperRef.onHidden.subscribe(this.hide.bind(this));
+    this.subscriptions.push(popperRef.onHidden.subscribe(this.hide.bind(this)));
     if (this.hideTimeout > 0)
       setTimeout(this.hide.bind(this), this.hideTimeout);
   }