toppy
v2.3.4TypeScript
Overlay library for Angular 7+
0/weekUpdated 3 years agoMITUnpacked: 899.8 KB
Published by Lokesh Rajendran
npm install toppy
Tiny Angular library to create overlays for tooltips, modals, dropdowns, alerts, toastr, popovers, menus, and more
$3
step 1: Install from npm or yarn
``sh`
npm install toppy // or
yarn add toppy
step 2: Import ToppyModule in your main module
`typescript
import { ToppyModule } from 'toppy';
@NgModule({
declarations: [AppComponent],
imports: [BrowserModule, ToppyModule], // <==
bootstrap: [AppComponent]
})
export class AppModule {}
`
step 3: Import Toppy service in your component
`typescript
import { Toppy } from 'toppy'; // <==
@Component({
selector: 'app-root',
template: '
Click me
'})
export class AppComponent {
@ViewChild('el', { read: ElementRef })
el: ElementRef;
constructor(private _toppy: Toppy) {}
ngOnInit() {
const position = new RelativePosition({
placement: OutsidePlacement.BOTTOM_LEFT,
src: this.el.nativeElement
});
this.overlay = this._toppy
.position(position)
.content('hello') // content
.create();
}
open() {
this.overlay.open();
}
close() {
this.overlay.close();
}
}
`
$3
Toppy allows to use string, html, TemplateRef, Component as overlay content.
Plain text
`typescriptsome plain text content
this.overlay = this._toppy
.position(position)
.content() // simple text`
.create();
HTML content
`typescript
this.overlay = this._toppy
.position(position)
.content(
any HTML content
, { hasHTML: true }) // html
.create();
`Using TemplateRef
html
Hello world!
`typescript
@ViewChild('tpl') tpl:TemplateRef;this.overlay = this._toppy
.position(position)
.content(this.tpl) // template ref
.create();
`Component
typescript
// host component
@Component({
template: 'Hello'
})
export class HelloComponent {}
`typescript
this.overlay = this._toppy
.position(position)
.content(HelloComponent) // <==
.create();
`> Dont forget to add host component in
in module$3
Position determines the location and size of the overlay. There are four positions:
Relative position
Overlay position that is relative to specific element. These are used in
tooltips, popovers, dropdowns, menustypescript
new RelativePosition({
src: HTMLElement, // target element
placement: OutsidePlacement, // location of the content
width: string | number, // content width eg, auto, 150, 30%
height: string | number, // content height eg, , 150, 30%
autoUpdate: boolean // update position when window scroll/resize/drag
});
Relative position supports 12 placements:
typescript
OutsidePlacement.BOTTOM;
OutsidePlacement.BOTTOM_LEFT;
OutsidePlacement.BOTTOM_RIGHT;
OutsidePlacement.LEFT;
OutsidePlacement.LEFT_BOTTOM;
OutsidePlacement.LEFT_TOP;
OutsidePlacement.RIGHT;
OutsidePlacement.RIGHT_BOTTOM;
OutsidePlacement.RIGHT_TOP;
OutsidePlacement.TOP;
OutsidePlacement.TOP_LEFT;
OutsidePlacement.TOP_RIGHT;
`Global position
Overlay position that is relative to window viewport. These are used in
, alerts, toastrtypescript
new GlobalPosition({
placement: InsidePlacement, // location of the content.
width: string | number, // content width eg, auto, 150, 30%
height: string | number, //content height eg, , 150, 30%
offset: number // oustide space of the content, in px
});
Global position supports 9 placements:
typescript
InsidePlacement.BOTTOM;
InsidePlacement.BOTTOM_LEFT;
InsidePlacement.BOTTOM_RIGHT;
InsidePlacement.LEFT;
InsidePlacement.RIGHT;
InsidePlacement.TOP;
InsidePlacement.TOP_LEFT;
InsidePlacement.TOP_RIGHT;
InsidePlacement.CENTER;
`Slide position
Overlay position that is relative to window viewport. These are used in
, sidebars, bladetypescript
new SlidePosition({
placement: SlidePlacement, // rigth or left
width: string // width eg, '300px' or '30%'
});
`Slide position supports 2 placements:
typescript
SlidePlacement.LEFT;
SlidePlacement.RIGHT;
`Fullscreen position
Overlay that occupies complete size of the viewport.
typescript
new FullScreenPosition();
`$3
typescript
this.toppy
.position(position: ToppyPosition)
.config(configuration: ToppyConfig = {})
.content('hello')
.create();
`|
| for |
| ------------------------ | -------------------------------------------------------------------------------------- |
| backdrop | boolean · whether to show backdrop layer · default: false |
| closeOnEsc | boolean · clicking Escape button will close overlay · default: false |
| closeOnDocClick | boolean · dismiss on clicking outside of content · default: false |
| listenWindowEvents | boolean · auto adjust the position on scroll/resize · default: true |
| containerClass | string · overlay container class name · default: t-overlay |
| wrapperClass | string · overlay wrapper class name · default: '' |
| backdropClass | string · overlay backdrop class name · default: '' |
| bodyClass | string · body class when overlay is open · default: t-open |
| windowResizeCallback | function · triggered on window scroll |
| docClickCallback | function · triggered on document click |$3
#### Component Data
When you host a component, you can control the overlay through
ToppyOverlay service. Using this service you can access all properties that is provided in content. Also the properties comes with close.`typescript
this.overlay = this._toppy
.position(position)
.content(HelloComponent, { propName: 'toppy-test-prop' })
.create();this.overlay.listen('t_compins').subscribe(comp => {
console.log('component is ready!', comp); // returns HelloComponent
});
`typescript
// host component
@Component({
template: 'Some text'
})
export class HelloComponent {
constructor(public overlay: ToppyOverlay) {
console.log(this.overlay.props.propName); // will return 'toppy-test-prop'
} close() {
this.overlay.close();
}
}
`#### Template Data
This is very similar to above one. When you use template as a content, you can pass additional data to it.
typescript
this.overlay = this._toppy
.position(position)
.content(template, { name: 'Johny' })
.create();
`Then in your template you can refer the data like this,
html
Hello !
`Method
is automatically binded.#### Plain text
When you use Plain text as a content, optionally you can able to set a class name to that
div block.`typescript
this.overlay = this._toppy
.position(position)
.content('some content', { class: 'tooltip' })
.create();
`$3
typescript/ Toppy /
Toppy.position(position: ToppyPosition):Toppy
Toppy.config(config: ToppyConfig):Toppy
Toppy.content(data: ContentData, props: ContentProps = {}):Toppy
Toppy.create(key: string = ''):ToppyControl
Toppy.getCtrl(id: string):ToppyControl
Toppy.destroy():void
`typescript/ ToppyControl /
ToppyControl.open():void
ToppyControl.close():void
ToppyControl.toggle():void
ToppyControl.onDocumentClick():Observable
ToppyControl.onWindowResize():Observable
ToppyControl.changePosition(newPosition: ToppyPosition): void
ToppyControl.updateContent(content: ContentData, props: ContentProps = {}):void
ToppyControl.updatePosition(config:object):ToppyControl
ToppyControl.listen(eventName:string):Observable
`typescript
/ events /t_open, t_close, t_dynpos, t_detach, t_posupdate, t_compins;
``$3
Any kind of contributions ( Typo fix, documentation, code quality, performance, refactor, pipeline, etc., ) are welcome. :)
$3
▶ Icons ━ icons8
▶ Illustrations ━ undraw
▶ Font icons ━ feathers
$3
Found a bug? Have some idea? Or do you have questions? File it here
$3
MIT