ng-hub-ui-portal/lib/portal-config.d.ts

A flexible Angular portal library for dynamic content rendering with advanced positioning and interaction control

import { Injector } from '@angular/core';
import * as i0 from "@angular/core";
/**
 * Options available when opening new portal windows with `HubPortal.open()` method.
 */
export interface HubPortalOptions {
    /**
     * If `true`, portal opening and closing will be animated.
     *
     * @since 8.0.0
     */
    animation?: boolean;
    /**
     * `aria-labelledby` attribute value to set on the portal window.
     *
     * @since 2.2.0
     */
    ariaLabelledBy?: string;
    /**
     * `aria-describedby` attribute value to set on the portal window.
     *
     * @since 6.1.0
     */
    ariaDescribedBy?: string;
    /**
     * Callback right before the portal will be dismissed.
     *
     * If this function returns:
     * * `false`
     * * a promise resolved with `false`
     * * a promise that is rejected
     *
     * then the portal won't be dismissed.
     */
    beforeDismiss?: () => boolean | Promise<boolean>;
    /**
     * A selector specifying the element all new portal windows should be appended to.
     * Since v5.3.0 it is also possible to pass the reference to an `HTMLElement`.
     *
     * If not specified, will be `body`.
     */
    container?: string | HTMLElement;
    /**
     * The `Injector` to use for portal content.
     */
    injector?: Injector;
    /**
     * If `true`, the portal will be closed when `Escape` key is pressed
     *
     * Default value is `true`.
     */
    keyboard?: boolean;
    /**
     * Scrollable portal content (false by default).
     *
     * @since 5.0.0
     */
    scrollable?: boolean;
    /**
     * A custom class to append to the portal window.
     */
    windowClass?: string;
    /**
     * A custom class to append to the portal dialog.
     *
     * @since 9.1.0
     */
    portalDialogClass?: string;
    /**
     * A custom class to append to the portal content.
     *
     * @since 9.1.0
     */
    portalContentClass?: string;
    /**
     * Allows to specify a custom selector for the header element of the portal window. This can be useful if you want to target
     * a specific element within the portal to act as the header, for example, to apply custom styling or functionality to it. By
     * providing a CSS selector string, you can target the desired	header element within the portal content.
     */
    headerSelector?: string;
    /**
     * Allows to specify a custom selector for the footer element of the portal window. This can be useful if you want to target
     * a specific element within the portal to act as the footer, for example, to apply custom styling or functionality to it. By
     * providing a CSS selector string, you can target the desired footer element within the portal content.
     */
    footerSelector?: string;
    /** Used to specify a custom selector for elements that can trigger the dismissal of the portal window. By providing a CSS selector
     * string for `dismissSelector`, you can target specific elements within the portal content that, when interacted with (e.g., clicked),
     * will close or dismiss the portal window.
     */
    dismissSelector?: string;
    /**
     * Used to specify a custom selector for elements that can trigger the closing of the portal window. By providing a CSS selector
     * string for `closeSelector`, you can target specific elements within the portal content that, when interacted with (e.g., clicked),
     * will close the portal window. This allows for customization of the elements that can act as close buttons for the portal.
     */
    closeSelector?: string;
}
/**
 * Options that can be changed on an opened portal with `HubPortalRef.update()` and `HubActivePortal.update()` methods.
 *
 * @since 14.2.0
 */
export type HubPortalUpdatableOptions = Pick<HubPortalOptions, 'ariaLabelledBy' | 'ariaDescribedBy' | 'windowClass' | 'portalDialogClass' | 'portalContentClass'>;
/**
 * A configuration service for the [`HubPortal`](#/components/portal/api#HubPortal) service.
 *
 * You can inject this service, typically in your root component, and customize the values of its properties in
 * order to provide default values for all portals used in the application.
 *
 * @since 3.1.0
 */
export declare class HubPortalConfig implements Required<HubPortalOptions> {
    private _animation;
    ariaLabelledBy: string;
    ariaDescribedBy: string;
    beforeDismiss: () => boolean | Promise<boolean>;
    container: string | HTMLElement;
    injector: Injector;
    keyboard: boolean;
    scrollable: boolean;
    windowClass: string;
    portalDialogClass: string;
    portalContentClass: string;
    headerSelector: string;
    footerSelector: string;
    dismissSelector: string;
    closeSelector: string;
    get animation(): boolean;
    set animation(animation: boolean);
    static ɵfac: i0.ɵɵFactoryDeclaration<HubPortalConfig, never>;
    static ɵprov: i0.ɵɵInjectableDeclaration<HubPortalConfig>;
}