@tylertech/forge 3.0.0-next.23 → 3.0.0-next.24

package/esm/busy-indicator/busy-indicator-adapter.d.ts

@@ -1,155 +0,0 @@
-/**
- * @license
- * Copyright 2023 Tyler Technologies, Inc. 
- * License: Apache-2.0
- */
-import { BaseAdapter, IBaseAdapter } from '../core/base/base-adapter';
-import { IBusyIndicatorComponent } from './busy-indicator';
-export interface IBusyIndicatorAdapter extends IBaseAdapter {
-    setContainerInvisible(): void;
-    setSurfaceOpacity: (opacity: number) => void;
-    setFixed(value: boolean): void;
-    setTitle: (title: string) => void;
-    setMessage: (message: string) => void;
-    setTitleVisibility: (visible: boolean) => void;
-    setMessageVisibility: (visible: boolean) => void;
-    setCancelButtonVisibility: (visible: boolean) => void;
-    setSpinnerVisibility: (visible: boolean) => void;
-    setProgressBarVisibility: (visible: boolean) => void;
-    setProgressBarDeterminate: (determinate: boolean) => void;
-    setProgressBarProgress: (value: number) => void;
-    setProgressBarBuffer: (value: number) => void;
-    addCancelButtonEventListener: (type: string, listener: () => void) => void;
-    removeCancelButtonEventListener: (type: string, listener: () => void) => void;
-    setCancelButtonAttribute: (name: string, value: string) => void;
-    setCancelButtonText: (text: string) => void;
-    setSurfaceWidth: (value: string) => void;
-    captureFocus: () => void;
-    remove: () => void;
-    hideBackdrop: () => void;
-    showBackdrop: () => void;
-    setParentAttribute(name: string, value: string): void;
-    removeParentAttribute(name: string): void;
-    getFocusedElement(): HTMLElement;
-    hasFocus(): boolean;
-}
-/**
- * Provides facilities for interacting with the internal DOM of `BusyIndicatorComponent`.
- */
-export declare class BusyIndicatorAdapter extends BaseAdapter<IBusyIndicatorComponent> implements IBusyIndicatorAdapter {
-    private _surfaceElement;
-    private _titleElement;
-    private _titlePlaceholderElement;
-    private _messageElement;
-    private _messagePlaceholderElement;
-    private _cancelButtonElement;
-    private _cancelButtonPlaceholderElement;
-    private _spinnerElement;
-    private _spinnerPlaceholderElement;
-    private _progressBarContainerElement;
-    private _progressBarContainerPlaceholderElement;
-    private _progressBarElement;
-    private _backdropElement;
-    private _parentElement;
-    constructor(component: IBusyIndicatorComponent);
-    /**
-     * Sets the opacity of the content element.
-     * @param opacity The opacity value.
-     */
-    setSurfaceOpacity(opacity: number): void;
-    setFixed(value: boolean): void;
-    /**
-     * Sets the content of the title element.
-     * @param title The title text.
-     */
-    setTitle(title: string): void;
-    /**
-     * Sets the content of the message element.
-     * @param message The message text.
-     */
-    setMessage(message: string): void;
-    /**
-     * Sets the visibility of the title element by adding or removing it from the DOM.
-     * @param visible Whether the title is visible or not.
-     */
-    setTitleVisibility(visible: boolean): void;
-    /**
-     * Adds or removes the cancel button from the DOM.
-     * @param visible The visibility value.
-     */
-    setCancelButtonVisibility(visible: boolean): void;
-    /**
-     * Adds or removes the message element from the DOM.
-     * @param visible The visibility value.
-     */
-    setMessageVisibility(visible: boolean): void;
-    /**
-     * Adds or removes the spinner element from the DOM.
-     * @param visible The visibility value.
-     */
-    setSpinnerVisibility(visible: boolean): void;
-    /**
-     * Adds or removes the progress bar element from the DOM.
-     * @param visible The visibility value.
-     */
-    setProgressBarVisibility(visible: boolean): void;
-    /**
-     * Sets the determinate state of the progress bar component.
-     * @param {boolean} determinate The determinate value.
-     */
-    setProgressBarDeterminate(determinate: boolean): void;
-    /**
-     * Sets the progress percent for the progress bar component.
-     * @param value The progress percent.
-     */
-    setProgressBarProgress(value: number): void;
-    /**
-     * Sets the progress bar component buffer percent.
-     * @param value The buffer percent.
-     */
-    setProgressBarBuffer(value: number): void;
-    /**
-     * Adds an event listener to the cancel button.
-     * @param type The event type.
-     * @param listener The event listener.
-     */
-    addCancelButtonEventListener(type: string, listener: () => void): void;
-    /**
-     * Removes an event listener from the cancel button.
-     * @param type The event type.
-     * @param listener The event listener.
-     */
-    removeCancelButtonEventListener(type: string, listener: () => void): void;
-    /**
-     * Sets an attribute on the cancel button.
-     * @param name The attribute name.
-     * @param value The attribute value.
-     */
-    setCancelButtonAttribute(name: string, value: string): void;
-    /**
-     * Sets the text displayed in the cancel button element.
-     * @param text The text value.
-     */
-    setCancelButtonText(text: string): void;
-    /**
-     * Sets the width of the surface element.
-     * @param value The CSS width.
-     */
-    setSurfaceWidth(value: string): void;
-    /**
-     * Sets focus to the busy indicator component element.
-     */
-    captureFocus(): void;
-    /**
-     * Removes the busy indicator component from its parent.
-     */
-    remove(): void;
-    hideBackdrop(): void;
-    showBackdrop(): void;
-    private _toggleElement;
-    setContainerInvisible(): void;
-    setParentAttribute(name: string, value: string): void;
-    removeParentAttribute(name: string): void;
-    getFocusedElement(): HTMLElement;
-    hasFocus(): boolean;
-}

package/esm/busy-indicator/busy-indicator-adapter.js

@@ -1,203 +0,0 @@
-/**
- * @license
- * Copyright 2023 Tyler Technologies, Inc. 
- * License: Apache-2.0
- */
-import { addClass, getShadowElement, removeElement, replaceElement, getActiveElement, toggleAttribute, toggleClass } from '@tylertech/forge-core';
-import { BACKDROP_CONSTANTS } from '../backdrop';
-import { BaseAdapter } from '../core/base/base-adapter';
-import { BUSY_INDICATOR_CONSTANTS } from './busy-indicator-constants';
-/**
- * Provides facilities for interacting with the internal DOM of `BusyIndicatorComponent`.
- */
-export class BusyIndicatorAdapter extends BaseAdapter {
-    constructor(component) {
-        super(component);
-        this._parentElement = null;
-        this._surfaceElement = getShadowElement(component, BUSY_INDICATOR_CONSTANTS.selectors.SURFACE);
-        this._titleElement = getShadowElement(component, BUSY_INDICATOR_CONSTANTS.selectors.TITLE);
-        this._messageElement = getShadowElement(component, BUSY_INDICATOR_CONSTANTS.selectors.MESSAGE);
-        this._cancelButtonElement = getShadowElement(component, BUSY_INDICATOR_CONSTANTS.selectors.CANCEL);
-        this._spinnerElement = getShadowElement(component, BUSY_INDICATOR_CONSTANTS.selectors.SPINNER);
-        this._progressBarContainerElement = getShadowElement(component, BUSY_INDICATOR_CONSTANTS.selectors.PROGRESS_BAR_CONTAINER);
-        this._progressBarElement = getShadowElement(component, BUSY_INDICATOR_CONSTANTS.selectors.PROGRESS_BAR);
-        this._backdropElement = getShadowElement(component, BUSY_INDICATOR_CONSTANTS.selectors.BACKDROP);
-    }
-    /**
-     * Sets the opacity of the content element.
-     * @param opacity The opacity value.
-     */
-    setSurfaceOpacity(opacity) {
-        this._surfaceElement.style.opacity = opacity.toString();
-    }
-    setFixed(value) {
-        toggleAttribute(this._backdropElement, value, BACKDROP_CONSTANTS.attributes.FIXED);
-        toggleClass(this._surfaceElement, value, BUSY_INDICATOR_CONSTANTS.classes.SURFACE_FIXED);
-    }
-    /**
-     * Sets the content of the title element.
-     * @param title The title text.
-     */
-    setTitle(title) {
-        this._titleElement.innerText = title;
-    }
-    /**
-     * Sets the content of the message element.
-     * @param message The message text.
-     */
-    setMessage(message) {
-        this._messageElement.innerText = message;
-    }
-    /**
-     * Sets the visibility of the title element by adding or removing it from the DOM.
-     * @param visible Whether the title is visible or not.
-     */
-    setTitleVisibility(visible) {
-        this._titlePlaceholderElement = this._toggleElement(visible, BUSY_INDICATOR_CONSTANTS.selectors.TITLE, this._titleElement, this._titlePlaceholderElement);
-    }
-    /**
-     * Adds or removes the cancel button from the DOM.
-     * @param visible The visibility value.
-     */
-    setCancelButtonVisibility(visible) {
-        this._cancelButtonPlaceholderElement = this._toggleElement(visible, BUSY_INDICATOR_CONSTANTS.selectors.CANCEL, this._cancelButtonElement, this._cancelButtonPlaceholderElement);
-    }
-    /**
-     * Adds or removes the message element from the DOM.
-     * @param visible The visibility value.
-     */
-    setMessageVisibility(visible) {
-        this._messagePlaceholderElement = this._toggleElement(visible, BUSY_INDICATOR_CONSTANTS.selectors.MESSAGE, this._messageElement, this._messagePlaceholderElement);
-    }
-    /**
-     * Adds or removes the spinner element from the DOM.
-     * @param visible The visibility value.
-     */
-    setSpinnerVisibility(visible) {
-        this._spinnerPlaceholderElement = this._toggleElement(visible, BUSY_INDICATOR_CONSTANTS.selectors.SPINNER, this._spinnerElement, this._spinnerPlaceholderElement);
-    }
-    /**
-     * Adds or removes the progress bar element from the DOM.
-     * @param visible The visibility value.
-     */
-    setProgressBarVisibility(visible) {
-        this._progressBarContainerPlaceholderElement = this._toggleElement(visible, BUSY_INDICATOR_CONSTANTS.selectors.PROGRESS_BAR_CONTAINER, this._progressBarContainerElement, this._progressBarContainerPlaceholderElement);
-    }
-    /**
-     * Sets the determinate state of the progress bar component.
-     * @param {boolean} determinate The determinate value.
-     */
-    setProgressBarDeterminate(determinate) {
-        this._progressBarElement.determinate = determinate;
-    }
-    /**
-     * Sets the progress percent for the progress bar component.
-     * @param value The progress percent.
-     */
-    setProgressBarProgress(value) {
-        this._progressBarElement.progress = value;
-    }
-    /**
-     * Sets the progress bar component buffer percent.
-     * @param value The buffer percent.
-     */
-    setProgressBarBuffer(value) {
-        this._progressBarElement.buffer = value;
-    }
-    /**
-     * Adds an event listener to the cancel button.
-     * @param type The event type.
-     * @param listener The event listener.
-     */
-    addCancelButtonEventListener(type, listener) {
-        this._cancelButtonElement.addEventListener(type, listener);
-    }
-    /**
-     * Removes an event listener from the cancel button.
-     * @param type The event type.
-     * @param listener The event listener.
-     */
-    removeCancelButtonEventListener(type, listener) {
-        this._cancelButtonElement.removeEventListener(type, listener);
-    }
-    /**
-     * Sets an attribute on the cancel button.
-     * @param name The attribute name.
-     * @param value The attribute value.
-     */
-    setCancelButtonAttribute(name, value) {
-        this._cancelButtonElement.setAttribute(name, value);
-    }
-    /**
-     * Sets the text displayed in the cancel button element.
-     * @param text The text value.
-     */
-    setCancelButtonText(text) {
-        this._cancelButtonElement.innerText = text;
-    }
-    /**
-     * Sets the width of the surface element.
-     * @param value The CSS width.
-     */
-    setSurfaceWidth(value) {
-        this._surfaceElement.style.width = value.toString();
-    }
-    /**
-     * Sets focus to the busy indicator component element.
-     */
-    captureFocus() {
-        this._surfaceElement.focus();
-    }
-    /**
-     * Removes the busy indicator component from its parent.
-     */
-    remove() {
-        removeElement(this._component);
-    }
-    hideBackdrop() {
-        this._backdropElement.fadeOut();
-    }
-    showBackdrop() {
-        window.requestAnimationFrame(() => {
-            var _a;
-            if (this._component.isConnected) {
-                (_a = this._backdropElement) === null || _a === void 0 ? void 0 : _a.fadeIn();
-            }
-        });
-    }
-    _toggleElement(isVisible, selector, element, placeholder) {
-        const exists = !!getShadowElement(this._component, selector);
-        if (!placeholder) {
-            placeholder = document.createComment(`(${BUSY_INDICATOR_CONSTANTS.elementName}) ${selector}`);
-        }
-        if (isVisible && !exists) {
-            replaceElement(element, placeholder);
-        }
-        else if (!isVisible && exists) {
-            replaceElement(placeholder, element);
-        }
-        return placeholder;
-    }
-    setContainerInvisible() {
-        addClass(BUSY_INDICATOR_CONSTANTS.classes.SURFACE_INVISIBLE, this._surfaceElement);
-    }
-    setParentAttribute(name, value) {
-        this._parentElement = this._component.parentElement;
-        if (this._parentElement) {
-            this._parentElement.setAttribute(name, value);
-        }
-    }
-    removeParentAttribute(name) {
-        if (this._parentElement) {
-            this._parentElement.removeAttribute(name);
-            this._parentElement = null;
-        }
-    }
-    getFocusedElement() {
-        return getActiveElement(this._component.ownerDocument);
-    }
-    hasFocus() {
-        const activeElement = this.getFocusedElement();
-        return this._component === activeElement || this._surfaceElement === activeElement || this._surfaceElement.contains(activeElement);
-    }
-}

package/esm/busy-indicator/busy-indicator-constants.d.ts

@@ -1,49 +0,0 @@
-/**
- * @license
- * Copyright 2023 Tyler Technologies, Inc. 
- * License: Apache-2.0
- */
-export declare const BUSY_INDICATOR_CONSTANTS: {
-    elementName: "forge-busy-indicator";
-    selectors: {
-        SURFACE: string;
-        SURFACE_INVISIBLE: string;
-        TITLE: string;
-        MESSAGE: string;
-        CANCEL: string;
-        SPINNER: string;
-        PROGRESS_BAR_CONTAINER: string;
-        PROGRESS_BAR: string;
-        BACKDROP: "forge-backdrop";
-    };
-    events: {
-        CANCEL: string;
-    };
-    strings: {
-        CANCELLING: string;
-    };
-    attributes: {
-        TITLE_TEXT: string;
-        MESSAGE: string;
-        CANCEL: string;
-        SPINNER: string;
-        PROGRESS_BAR: string;
-        PROGRESS_BAR_DETERMINATE: string;
-        PROGRESS: string;
-        BUFFER: string;
-        WIDTH: string;
-        DIRECTION: string;
-        MINIMUM_VISIBLE_LIFETIME: string;
-        MANAGE_FOCUS: string;
-        PARENT_OPEN: string;
-        FIXED: string;
-    };
-    numbers: {
-        TRANSITION_LENGTH: number;
-    };
-    classes: {
-        SURFACE_INVISIBLE: string;
-        SURFACE_FIXED: string;
-    };
-};
-export type BusyIndicatorLayoutDirection = 'row' | 'column' | undefined;

package/esm/busy-indicator/busy-indicator-constants.js

@@ -1,58 +0,0 @@
-/**
- * @license
- * Copyright 2023 Tyler Technologies, Inc. 
- * License: Apache-2.0
- */
-import { BACKDROP_CONSTANTS } from '../backdrop';
-import { COMPONENT_NAME_PREFIX } from '../constants';
-import { LINEAR_PROGRESS_CONSTANTS } from '../linear-progress';
-const elementName = `${COMPONENT_NAME_PREFIX}busy-indicator`;
-const classes = {
-    SURFACE_INVISIBLE: 'forge-busy-indicator__surface--invisible',
-    SURFACE_FIXED: 'forge-busy-indicator__surface--fixed'
-};
-const selectors = {
-    SURFACE: '.forge-busy-indicator__surface',
-    SURFACE_INVISIBLE: `.${classes.SURFACE_INVISIBLE}`,
-    TITLE: '.forge-busy-indicator__title',
-    MESSAGE: '.forge-busy-indicator__message',
-    CANCEL: '.forge-busy-indicator__cancel-button',
-    SPINNER: '.forge-busy-indicator__spinner',
-    PROGRESS_BAR_CONTAINER: '.forge-busy-indicator__progress-container',
-    PROGRESS_BAR: `.forge-busy-indicator__progress-container ${LINEAR_PROGRESS_CONSTANTS.elementName}`,
-    BACKDROP: BACKDROP_CONSTANTS.elementName
-};
-const events = {
-    CANCEL: `${elementName}-cancel`
-};
-const strings = {
-    CANCELLING: 'Cancelling...'
-};
-const attributes = {
-    TITLE_TEXT: 'title-text',
-    MESSAGE: 'message',
-    CANCEL: 'cancel',
-    SPINNER: 'spinner',
-    PROGRESS_BAR: 'progress-bar',
-    PROGRESS_BAR_DETERMINATE: 'progress-bar-determinate',
-    PROGRESS: 'progress',
-    BUFFER: 'buffer',
-    WIDTH: 'width',
-    DIRECTION: 'direction',
-    MINIMUM_VISIBLE_LIFETIME: 'minimum-visible-lifetime',
-    MANAGE_FOCUS: 'manage-focus',
-    PARENT_OPEN: 'forge-busy-indicator-open',
-    FIXED: 'fixed'
-};
-const numbers = {
-    TRANSITION_LENGTH: 120
-};
-export const BUSY_INDICATOR_CONSTANTS = {
-    elementName,
-    selectors,
-    events,
-    strings,
-    attributes,
-    numbers,
-    classes
-};

package/esm/busy-indicator/busy-indicator-foundation.d.ts

@@ -1,97 +0,0 @@
-/**
- * @license
- * Copyright 2023 Tyler Technologies, Inc. 
- * License: Apache-2.0
- */
-import { ICustomElementFoundation } from '@tylertech/forge-core';
-import { IBusyIndicatorAdapter } from './busy-indicator-adapter';
-import { BusyIndicatorLayoutDirection } from './busy-indicator-constants';
-export interface IBusyIndicatorFoundation extends ICustomElementFoundation {
-    titleText: string;
-    message: string;
-    cancel: boolean;
-    spinner: boolean;
-    progressBar: boolean;
-    progressBarDeterminate: boolean;
-    progress: number;
-    buffer: number;
-    width: number | 'auto';
-    direction: BusyIndicatorLayoutDirection;
-    manageFocus: boolean;
-    fixed: boolean;
-    hide(force?: boolean): void;
-}
-/**
- * Provides facilities and helper methods for creating a busy indicator component.
- */
-export declare class BusyIndicatorFoundation implements IBusyIndicatorFoundation {
-    private _adapter;
-    private _titleText;
-    private _message;
-    private _canCancel;
-    private _showSpinner;
-    private _showProgressBar;
-    private _progressBarDeterminate;
-    private _progress;
-    private _buffer;
-    private _cancelListenerAttached;
-    private _width;
-    private _previouslyFocusedElement?;
-    private _direction;
-    private _manageFocus;
-    private _fixed;
-    constructor(_adapter: IBusyIndicatorAdapter);
-    destroy(): void;
-    show(): void;
-    /**
-     * Removes the element from the DOM.
-     * @param {boolean} [force=false] Whether to force removal of the busy indicator or not.
-     */
-    hide(force?: boolean): void;
-    /** Sets the elements opacity to 0 which triggers the CSS transition to fade out. */
-    fadeOut(): void;
-    /** Sets the elements opacity to 1 which triggers the CSS transition to fade in after the current delay value. */
-    fadeIn(): void;
-    /** Attaches the click listener to the cancel button. */
-    private _attachCancelClickListener;
-    /** Handles clicks on the cancel button. */
-    private _onCancelClick;
-    /** Cache currently focused element, set focus to the busy indicator. */
-    private _captureFocus;
-    /** Gives focus back to the element that had it when the busy indicator was displayed. */
-    private _releaseFocus;
-    /** The title to be displayed. */
-    set titleText(value: string);
-    get titleText(): string;
-    /** The message to be displayed. */
-    set message(value: string);
-    get message(): string;
-    /** Controls whether the cancel button is visible or not. */
-    set cancel(canCancel: boolean);
-    get cancel(): boolean;
-    /** Controls whether the progress spinner is visible or not. */
-    set spinner(showSpinner: boolean);
-    get spinner(): boolean;
-    /** Controls whether the progres bar is visible or not. */
-    set progressBar(showProgressBar: boolean);
-    get progressBar(): boolean;
-    /** Sets the progress bar mode. */
-    set progressBarDeterminate(determinate: boolean);
-    get progressBarDeterminate(): boolean;
-    /** The progress amount of the progress bar. */
-    set progress(value: number);
-    get progress(): number;
-    /** The buffer amount of the progress bar. */
-    set buffer(value: number);
-    get buffer(): number;
-    get direction(): BusyIndicatorLayoutDirection;
-    set direction(value: BusyIndicatorLayoutDirection);
-    private _applyDirection;
-    /** Sets the width of the busy indicator element. */
-    set width(value: number | 'auto');
-    get width(): number | 'auto';
-    get manageFocus(): boolean;
-    set manageFocus(value: boolean);
-    get fixed(): boolean;
-    set fixed(value: boolean);
-}