@teedeez/tdz-anchored-floating-box v2.1.3

Installation

npm i -S @teedeez/tdz-anchored-floating-box

Available APIs

These are the symbols that are available from this package

/**
 * The module class for this package
 */
class AnchoredFloatingBoxModule {
}

class AnchoredFloatingBoxService {

    /**
     * Open a new floating box with a configuration object specified by `configuration`. This service
     * supports rendering `TemplateRef` as well as any `@Component()` class.
     *
     * @param configuration The configuration object for the anchored floating box
     * @returns A ref object to the created anchored floating box {@see AnchoredFloatingBoxRef}
     */
    open(configuration: AnchoredFloatingBoxConfiguration): AnchoredFloatingBoxRef;

    /**
     * Set the default theme that will be used for all floating boxes created in the future
     *
     * @param theme The new theme to be used as the default {@see Theme}
     */
    setDefaultTheme(theme: Theme): void;
}

/**
 * The configuration object for the current anchored floating box.
 * The type parameter `C` describes the type of the optional context
 * object passed to `TemplateRef<C>`.
 */
interface AnchoredFloatingBoxConfiguration<C = Record<string, unknown>> {

    /**
     * The content to show, it accepts `TemplateRef` as well as any `@Component()` class
     */
    content: TemplateRef<C> | Type<any>;

    /**
     * The element that the floating box will be anchored to
     */
    anchor: Element;

    /**
     * Optional class name to add to the anchored floating box's container
     */
    className?: string;

    /**
     * Optional context object that is referenced by the template ref
     */
    context?: C;

    /**
     * Optional theme for the floating box. Default is 'dark' {@see Theme}
     */
    theme?: Theme;

}

const enum Theme {
    LIGHT = "light",
    DARK = "dark"
}

/**
 * A wrapper class around the AnchoredFloatingBoxComponent
 */
class AnchoredFloatingBoxRef {

    /**
     * Close this anchored floating box only
     */
    close(): void;

    /**
     * @returns An RxJS observable that emits after this anchored floating box is closed
     */
    afterClosed(): Observable<void>;

    /**
     * @returns An RxJS observable that emits after this anchored floating is opened
     */
    afterOpened(): Observable<void>;

}

Example Usage

Code example

// Import the service into your class to start using it
import { AnchoredFloatingBoxService } from '@teedeez/tdz-anchored-floating-box'

@Component({
    selector: 'test-component',
    template: `
        <button
                #button
                type='button'
                (click)='onOpen(template, button)'>
                Click me!!!
        </button>
        <ng-template
                #template
                let-name <-- The context['$implicit'] from below
                let-greeting='greeting'> <-- The context.greeting from below
            {{greeting}} {{name}}
        </ng-template>
    `
})
export class TestComponent {

    constructor(private readonly _anchoredFloatingBoxService: AnchoredFloatingBoxService) {

    }

    onOpen(templateRef: TemplateRef<any>, anchor: HTMLButtonElement) {
        this._anchoredFloatingBoxService.open({
            content: templateRef,
            anchor,
            className: 'optional-class-name',
            context: {
                greeting: 'Hello',
                '$implicit': 'Angular!!!'
            }
        });
    }

}

Result

It will also reposition itself if it overflows the top or bottom edge of the viewport like so

Real world example

Below is a screenshot of a personal app of mine at https://memecomposer.com that uses this component. Clicking on the brush icon button popped open an anchored floating box, then clicking "Text appearance" button inside of it opened another anchored floating box that is independent of the previous one and any others.