angular-wormhole's Introduction

Angular Wormhole

This component allows rendering all of its content to be rendered elsewhere on the page.

Why?

Sometimes a dialog or tooltip has to be rendered outside of an element, as CSS stacking contexts may interfere with positioning.

Installation

$ yarn add angular-wormhole

Import AngularWormholeModule in your app:

import { NgModule } from '@angular/core';
import { AngularWormholeModule } from 'angular-wormhole';

@NgModule({
  imports: [
    AngularWormholeModule
  ]
})
export class AppModule {}

Example usage

index.html

<body>
  <my-angular-app></my-angular-app>
  <div id="wormhole-target"></div>
</body>

In a component template:

<ng-wormhole to="#wormhole-target">
  <my-popover>...</my-popover>
</ng-wormhole>

The <my-popover> component will then be rendered in the #wormhole-target element, it will also automatically cleaned up once your component will be destroyed.

Attributes

to: selector Which element to append to.

<ng-wormhole to="#wormhole-target">
  <my-popover>...</my-popover>
</ng-wormhole>

Inputs

to: selector Which element to append to.

<ng-wormhole [to]="'#wormhole-target'">
  <my-popover>...</my-popover>
</ng-wormhole>

renderInPlace: boolean = false Should the component render its children in place?

<ng-wormhole to="#wormhole-target" [renderInPlace]="true">
  <my-popover>...</my-popover>
</ng-wormhole>

Credits

This component is heavily inspired by ember-wormhole. Contributions from @stefanpenner, @krisselden, @chrislopresto, @lukemelia, @raycohen and others.

Recommend Projects