@tylertech/forge 3.0.0-next.1 → 3.0.0-next.11

package/esm/slider/slider-adapter.js

@@ -0,0 +1,178 @@
+/**
+ * @license
+ * Copyright 2023 Tyler Technologies, Inc. 
+ * License: Apache-2.0
+ */
+import { getShadowElement, toggleAttribute, toggleClass } from '@tylertech/forge-core';
+import { BaseAdapter } from '../core/base/base-adapter';
+import { elementsOverlapping, isPointerOverElement } from '../core/utils/utils';
+import { STATE_LAYER_CONSTANTS } from '../state-layer';
+import { SLIDER_CONSTANTS } from './slider-constants';
+import { createLabel, createStartHandleElement, createStartInputElement } from './slider-utils';
+export class SliderAdapter extends BaseAdapter {
+    constructor(component) {
+        super(component);
+        this._rootElement = getShadowElement(component, SLIDER_CONSTANTS.selectors.ROOT);
+        this._trackElement = getShadowElement(component, SLIDER_CONSTANTS.selectors.TRACK);
+        this._handleContainerElement = getShadowElement(component, SLIDER_CONSTANTS.selectors.HANDLE_CONTAINER);
+        this._endInputElement = getShadowElement(component, SLIDER_CONSTANTS.selectors.END_INPUT);
+        this._endHandleElement = getShadowElement(component, SLIDER_CONSTANTS.selectors.END_HANDLE);
+        this._endHandleThumbElement = getShadowElement(component, SLIDER_CONSTANTS.selectors.END_HANDLE_THUMB);
+        this._endLabelContentElement = getShadowElement(component, SLIDER_CONSTANTS.selectors.END_LABEL_CONTENT);
+    }
+    addInputListener(type, listener) {
+        const inputs = this._getInputs();
+        inputs.forEach(input => input.addEventListener(type, listener));
+    }
+    update({ startFraction, endFraction, tickCount }) {
+        this._rootElement.style.setProperty(SLIDER_CONSTANTS.cssCustomProperties.START_FRACTION, String(startFraction));
+        this._rootElement.style.setProperty(SLIDER_CONSTANTS.cssCustomProperties.END_FRACTION, String(endFraction));
+        this._rootElement.style.setProperty(SLIDER_CONSTANTS.cssCustomProperties.TICK_COUNT, String(tickCount));
+    }
+    updateLabels(labelStart, labelEnd) {
+        var _a;
+        if (this._startLabelContentElement) {
+            this._startLabelContentElement.textContent = labelStart;
+        }
+        if (this._endLabelContentElement) {
+            this._endLabelContentElement.textContent = labelEnd;
+        }
+        (_a = this._startInputElement) === null || _a === void 0 ? void 0 : _a.setAttribute('aria-valuetext', labelStart);
+        this._endInputElement.setAttribute('aria-valuetext', labelEnd);
+    }
+    updateHandleLayering() {
+        const isEndFocused = this._endInputElement.matches(':focus');
+        if (this._startHandleElement) {
+            toggleClass(this._startHandleElement, !isEndFocused, SLIDER_CONSTANTS.classes.ON_TOP);
+        }
+        toggleClass(this._endHandleElement, isEndFocused, SLIDER_CONSTANTS.classes.ON_TOP);
+    }
+    tryHoverStartHandle(coords) {
+        var _a, _b, _c;
+        if (this._startHandleThumbElement && isPointerOverElement(coords, this._startHandleThumbElement)) {
+            this._handleContainerElement.classList.add(SLIDER_CONSTANTS.classes.HOVER);
+            (_a = this._startHandleElement) === null || _a === void 0 ? void 0 : _a.classList.add(SLIDER_CONSTANTS.classes.HOVER);
+        }
+        else if (!((_b = this._startInputElement) === null || _b === void 0 ? void 0 : _b.matches(':focus'))) {
+            this._handleContainerElement.classList.remove(SLIDER_CONSTANTS.classes.HOVER);
+            (_c = this._startHandleElement) === null || _c === void 0 ? void 0 : _c.classList.remove(SLIDER_CONSTANTS.classes.HOVER);
+        }
+    }
+    tryHoverEndHandle(coords) {
+        if (isPointerOverElement(coords, this._endHandleThumbElement)) {
+            this._handleContainerElement.classList.add(SLIDER_CONSTANTS.classes.HOVER);
+            this._endHandleElement.classList.add(SLIDER_CONSTANTS.classes.HOVER);
+        }
+        else if (!this._endInputElement.matches(':focus')) {
+            this._handleContainerElement.classList.remove(SLIDER_CONSTANTS.classes.HOVER);
+            this._endHandleElement.classList.remove(SLIDER_CONSTANTS.classes.HOVER);
+        }
+    }
+    tryDetectOverlap() {
+        if (this._startHandleElement) {
+            const isOverlapping = elementsOverlapping(this._startHandleElement, this._endHandleElement);
+            toggleClass(this._endHandleElement, isOverlapping, SLIDER_CONSTANTS.classes.OVERLAPPING);
+            toggleClass(this._startHandleElement, isOverlapping, SLIDER_CONSTANTS.classes.OVERLAPPING);
+        }
+    }
+    leaveHandleContainer() {
+        this._handleContainerElement.classList.remove(SLIDER_CONSTANTS.classes.HOVER);
+    }
+    syncInputValues(valueStart, valueEnd) {
+        if (this._startInputElement) {
+            this._startInputElement.valueAsNumber = valueStart;
+        }
+        this._endInputElement.valueAsNumber = valueEnd;
+        if (this._startInputElement) {
+            const data = new FormData();
+            data.append(this._component.nameStart, String(valueStart));
+            data.append(this._component.nameEnd, String(valueEnd));
+            this._component.internals.setFormValue(data);
+        }
+        else {
+            this._component.internals.setFormValue(String(valueEnd));
+        }
+    }
+    setRange(value) {
+        var _a, _b;
+        this._rootElement.classList.toggle(SLIDER_CONSTANTS.classes.RANGE, value);
+        if (value) {
+            // Create start input
+            this._startInputElement = createStartInputElement(this._component);
+            this._rootElement.insertAdjacentElement('afterbegin', this._startInputElement);
+            // Ensure the end input is updated to the valueEnd property value now that we are in range mode
+            this._endInputElement.valueAsNumber = this._component.valueEnd;
+            // Create start handle
+            const thumbLabel = this._startInputElement.value;
+            this._startHandleElement = createStartHandleElement(thumbLabel);
+            this._handleContainerElement.insertAdjacentElement('afterbegin', this._startHandleElement);
+            this._startHandleThumbElement = getShadowElement(this._component, SLIDER_CONSTANTS.selectors.START_HANDLE_THUMB);
+            this._startLabelContentElement = getShadowElement(this._component, SLIDER_CONSTANTS.selectors.START_LABEL_CONTENT);
+        }
+        else {
+            (_a = this._startInputElement) === null || _a === void 0 ? void 0 : _a.remove();
+            (_b = this._startHandleElement) === null || _b === void 0 ? void 0 : _b.remove();
+            this._startInputElement = undefined;
+            this._startHandleElement = undefined;
+            this._startHandleThumbElement = undefined;
+            this._startLabelContentElement = undefined;
+        }
+    }
+    setTickmarks(value) {
+        this._trackElement.classList.toggle(SLIDER_CONSTANTS.classes.TICKMARKS, value);
+    }
+    setStep(step) {
+        const inputs = this._getInputs();
+        inputs.forEach(input => input.step = String(step));
+    }
+    setMin(value) {
+        const inputs = this._getInputs();
+        inputs.forEach(input => input.min = String(value));
+    }
+    setMax(value) {
+        const inputs = this._getInputs();
+        inputs.forEach(input => input.max = String(value));
+    }
+    setDisabled(value) {
+        const inputs = this._getInputs();
+        inputs.forEach(input => input.disabled = value);
+        const stateLayers = this._rootElement.querySelectorAll(STATE_LAYER_CONSTANTS.elementName);
+        stateLayers.forEach(sl => sl.disabled = value);
+    }
+    setReadonly(value) {
+        const inputs = this._getInputs();
+        inputs.forEach(input => input.readOnly = value);
+    }
+    toggleLabels(value) {
+        var _a;
+        const labels = this._rootElement.querySelectorAll(SLIDER_CONSTANTS.selectors.LABEL);
+        labels.forEach(label => label.remove());
+        this._endLabelContentElement = undefined;
+        this._startLabelContentElement = undefined;
+        if (value) {
+            const endLabelEl = createLabel(this._endInputElement.value);
+            this._endHandleElement.insertAdjacentElement('beforeend', endLabelEl);
+            this._endLabelContentElement = getShadowElement(this._component, SLIDER_CONSTANTS.selectors.END_LABEL_CONTENT);
+            if (this._startInputElement) {
+                const startLabelEl = createLabel(this._startInputElement.value);
+                (_a = this._startHandleElement) === null || _a === void 0 ? void 0 : _a.insertAdjacentElement('beforeend', startLabelEl);
+                this._startLabelContentElement = getShadowElement(this._component, SLIDER_CONSTANTS.selectors.START_LABEL_CONTENT);
+            }
+        }
+    }
+    setStartAriaLabel(value) {
+        if (this._startInputElement) {
+            toggleAttribute(this._startInputElement, !!value, 'aria-label', value);
+        }
+    }
+    setEndAriaLabel(value) {
+        toggleAttribute(this._endInputElement, !!value, 'aria-label', value);
+    }
+    _getInputs() {
+        const inputs = [];
+        if (this._startInputElement) {
+            inputs.push(this._startInputElement);
+        }
+        return [...inputs, this._endInputElement];
+    }
+}

package/esm/slider/slider-component-delegate.d.ts

@@ -6,8 +6,8 @@
 import { FormFieldComponentDelegate, IFormFieldComponentDelegateOptions } from '../core';
 import { IBaseComponentDelegateConfig } from '../core/delegates/base-component-delegate';
 import { ISliderComponent } from '../slider';
-import { ISliderChangeEventData } from './slider-constants';
-export declare type SliderComponentDelegateProps = Partial<ISliderComponent>;
+import { ISliderRangeEventData } from './slider-constants';
+export type SliderComponentDelegateProps = Partial<ISliderComponent>;
 export interface ISliderComponentDelegateOptions extends IFormFieldComponentDelegateOptions {
 }
 export interface ISliderComponentDelegateConfig extends IBaseComponentDelegateConfig<ISliderComponent, ISliderComponentDelegateOptions> {
@@ -18,9 +18,25 @@ export declare class SliderComponentDelegate extends FormFieldComponentDelegate<
     set value(value: number);
     get valueStart(): number;
     set valueStart(value: number);
+    get valueEnd(): number;
+    set valueEnd(value: number);
     get disabled(): boolean;
     set disabled(value: boolean);
-    onChange(listener: (value: ISliderChangeEventData) => void): void;
+    get min(): number;
+    set min(value: number);
+    get max(): number;
+    set max(value: number);
+    get step(): number;
+    get range(): boolean;
+    set range(value: boolean);
+    get tickmarks(): boolean;
+    set tickmarks(value: boolean);
+    get labeled(): boolean;
+    set labeled(value: boolean);
+    get labelBuilder(): (value: number, which?: 'start' | 'end') => string;
+    set labelBuilder(value: (value: number, which?: 'start' | 'end') => string);
+    onInput(listener: (value: number | ISliderRangeEventData) => void): void;
+    onChange(listener: (value: number | ISliderRangeEventData) => void): void;
     onFocus(listener: (evt: Event) => void): void;
     onBlur(listener: (evt: Event) => void): void;
     protected _build(): ISliderComponent;

package/esm/slider/slider-component-delegate.js

@@ -21,12 +21,60 @@ export class SliderComponentDelegate extends FormFieldComponentDelegate {
     set valueStart(value) {
         this._element.valueStart = value;
     }
+    get valueEnd() {
+        return this._element.valueEnd;
+    }
+    set valueEnd(value) {
+        this._element.valueEnd = value;
+    }
     get disabled() {
         return this._element.disabled;
     }
     set disabled(value) {
         this._element.disabled = value;
     }
+    get min() {
+        return this._element.min;
+    }
+    set min(value) {
+        this._element.min = value;
+    }
+    get max() {
+        return this._element.max;
+    }
+    set max(value) {
+        this._element.max = value;
+    }
+    get step() {
+        return this._element.step;
+    }
+    get range() {
+        return this._element.range;
+    }
+    set range(value) {
+        this._element.range = value;
+    }
+    get tickmarks() {
+        return this._element.tickmarks;
+    }
+    set tickmarks(value) {
+        this._element.tickmarks = value;
+    }
+    get labeled() {
+        return this._element.labeled;
+    }
+    set labeled(value) {
+        this._element.labeled = value;
+    }
+    get labelBuilder() {
+        return this._element.labelBuilder;
+    }
+    set labelBuilder(value) {
+        this._element.labelBuilder = value;
+    }
+    onInput(listener) {
+        this._element.addEventListener('forge-slider-input', ({ detail }) => listener(detail));
+    }
     onChange(listener) {
         this._element.addEventListener('forge-slider-change', ({ detail }) => listener(detail));
     }

package/esm/slider/slider-constants.d.ts

@@ -6,36 +6,72 @@
 export declare const SLIDER_CONSTANTS: {
     elementName: "forge-slider";
     attributes: {
-        TYPE: string;
+        ARIA_LABEL: string;
+        ARIA_LABEL_START: string;
+        ARIA_LABEL_END: string;
         VALUE: string;
         VALUE_START: string;
+        VALUE_END: string;
+        LABEL: string;
+        LABEL_START: string;
+        LABEL_END: string;
         MIN: string;
         MAX: string;
         STEP: string;
+        TICKMARKS: string;
+        LABELED: string;
+        RANGE: string;
         DISABLED: string;
-        COLOR: string;
+        READONLY: string;
     };
     selectors: {
         ROOT: string;
-        THUMB: string;
-        THUMB_START: string;
-        VALUE_INPUT: string;
-        VALUE_INPUT_START: string;
-        TRACK_CONTAINER: string;
-        TRACK_ACTIVE_FILL: string;
+        TRACK: string;
+        HANDLE_CONTAINER: string;
+        START_INPUT: string;
+        END_INPUT: string;
+        START_HANDLE: string;
+        START_HANDLE_THUMB: string;
+        END_HANDLE: string;
+        END_HANDLE_THUMB: string;
+        START_LABEL: string;
+        START_LABEL_CONTENT: string;
+        END_LABEL: string;
+        END_LABEL_CONTENT: string;
+        LABEL: string;
+        INPUT: string;
+    };
+    classes: {
+        RANGE: string;
+        TICKMARKS: string;
+        ON_TOP: string;
+        OVERLAPPING: string;
+        HOVER: string;
+        HANDLE: string;
+        HANDLE_THUMB: string;
+        HANDLE_START: string;
+        HANDLE_LABEL: string;
+        LABEL: string;
+        LABEL_CONTENT: string;
     };
     events: {
-        MDC_INPUT: string;
-        MDC_CHANGE: string;
-        FORGE_INPUT: string;
-        FORGE_CHANGE: string;
+        INPUT: string;
+        CHANGE: string;
+    };
+    numbers: {
+        DEFAULT_STEP: number;
+        DEFAULT_VALUE: number;
+        DEFAULT_START_VALUE: number;
+        DEFAULT_END_VALUE: number;
+    };
+    cssCustomProperties: {
+        START_FRACTION: string;
+        END_FRACTION: string;
+        TICK_COUNT: string;
     };
 };
-export interface ISliderInputEventData {
-    value?: number;
-    valueStart?: number;
-    valueEnd?: number;
-}
-export interface ISliderChangeEventData extends ISliderInputEventData {
+export interface ISliderRangeEventData {
+    valueStart: number;
+    valueEnd: number;
 }
-export declare type SliderType = 'continuous' | 'discrete' | 'discrete-markers' | 'continuous-range' | 'discrete-range' | 'discrete-range-markers';
+export type SliderLabelBuilder = (value: number, which?: 'start' | 'end') => string;

package/esm/slider/slider-constants.js

@@ -6,33 +6,75 @@
 import { COMPONENT_NAME_PREFIX } from '../constants';
 const elementName = `${COMPONENT_NAME_PREFIX}slider`;
 const attributes = {
-    TYPE: 'type',
+    ARIA_LABEL: 'data-aria-label',
+    ARIA_LABEL_START: 'data-aria-label-start',
+    ARIA_LABEL_END: 'data-aria-label-end',
     VALUE: 'value',
     VALUE_START: 'value-start',
+    VALUE_END: 'value-end',
+    LABEL: 'label',
+    LABEL_START: 'label-start',
+    LABEL_END: 'label-end',
     MIN: 'min',
     MAX: 'max',
     STEP: 'step',
+    TICKMARKS: 'tickmarks',
+    LABELED: 'labeled',
+    RANGE: 'range',
     DISABLED: 'disabled',
-    COLOR: 'color'
+    READONLY: 'readonly'
 };
 const selectors = {
-    ROOT: '.mdc-slider',
-    THUMB: '.mdc-slider__thumb[part=thumb],.mdc-slider__thumb[part=\'thumb-end\']',
-    THUMB_START: '.mdc-slider__thumb[part=\'thumb-start\']',
-    VALUE_INPUT: 'input[id=\'value-input\']',
-    VALUE_INPUT_START: 'input[id=\'value-input-start\']',
-    TRACK_CONTAINER: '.mdc-slider__track-container',
-    TRACK_ACTIVE_FILL: '.mdc-slider__track--active_fill'
+    ROOT: '.forge-slider',
+    TRACK: '.track',
+    HANDLE_CONTAINER: '.handle-container',
+    START_INPUT: 'input.start',
+    END_INPUT: 'input.end',
+    START_HANDLE: '.handle.start',
+    START_HANDLE_THUMB: '.handle.start .handle-thumb',
+    END_HANDLE: '.handle.end',
+    END_HANDLE_THUMB: '.handle.end .handle-thumb',
+    START_LABEL: '.handle.start .handle-label',
+    START_LABEL_CONTENT: '.handle.start .handle-label-content',
+    END_LABEL: '.handle.end .handle-label',
+    END_LABEL_CONTENT: '.handle.end .handle-label-content',
+    LABEL: '.handle-label',
+    INPUT: 'input[type=range]'
+};
+const classes = {
+    RANGE: 'range',
+    TICKMARKS: 'tickmarks',
+    ON_TOP: 'on-top',
+    OVERLAPPING: 'overlapping',
+    HOVER: 'hover',
+    HANDLE: 'handle',
+    HANDLE_THUMB: 'handle-thumb',
+    HANDLE_START: 'start',
+    HANDLE_LABEL: 'handle-label',
+    LABEL: 'handle-label',
+    LABEL_CONTENT: 'handle-label-content'
 };
 const events = {
-    MDC_INPUT: 'MDCSlider:input',
-    MDC_CHANGE: 'MDCSlider:change',
-    FORGE_INPUT: 'forge-slider-input',
-    FORGE_CHANGE: 'forge-slider-change'
+    INPUT: 'forge-slider-input',
+    CHANGE: 'forge-slider-change'
+};
+const cssCustomProperties = {
+    START_FRACTION: '--_start-fraction',
+    END_FRACTION: '--_end-fraction',
+    TICK_COUNT: '--_tick-count'
+};
+const numbers = {
+    DEFAULT_STEP: 1,
+    DEFAULT_VALUE: 50,
+    DEFAULT_START_VALUE: 33,
+    DEFAULT_END_VALUE: 67
 };
 export const SLIDER_CONSTANTS = {
     elementName,
     attributes,
     selectors,
-    events
+    classes,
+    events,
+    numbers,
+    cssCustomProperties
 };

package/esm/slider/slider-foundation.d.ts

@@ -0,0 +1,94 @@
+/**
+ * @license
+ * Copyright 2023 Tyler Technologies, Inc. 
+ * License: Apache-2.0
+ */
+import { ICustomElementFoundation } from '@tylertech/forge-core';
+import { ISliderAdapter } from './slider-adapter';
+import { SliderLabelBuilder } from './slider-constants';
+export interface ISliderFoundation extends ICustomElementFoundation {
+    ariaLabel: string | null;
+    ariaLabelStart: string | null;
+    ariaLabelEnd: string | null;
+    value: number;
+    valueStart: number;
+    valueEnd: number;
+    label: string;
+    labelStart: string;
+    labelEnd: string;
+    labelBuilder: SliderLabelBuilder;
+    min: number;
+    max: number;
+    step: number;
+    tickmarks: boolean;
+    labeled: boolean;
+    range: boolean;
+    disabled: boolean;
+    readonly: boolean;
+}
+export declare class SliderFoundation implements ISliderFoundation {
+    private readonly _adapter;
+    private _value;
+    private _valueStart;
+    private _valueEnd;
+    private _labelStart;
+    private _labelEnd;
+    private _labelBuilder;
+    private _min;
+    private _max;
+    private _step;
+    private _tickmarks;
+    private _labeled;
+    private _range;
+    private _disabled;
+    private _readonly;
+    private readonly _pointerEnterListener;
+    private readonly _pointerMoveListener;
+    private readonly _pointerLeaveListener;
+    private readonly _changeUpdateListener;
+    private readonly _focusListener;
+    constructor(_adapter: ISliderAdapter);
+    initialize(): void;
+    private _update;
+    private _clampMinMax;
+    private _applyInputListeners;
+    private _handlePointerEnter;
+    private _handlePointerMove;
+    private _handlePointerLeave;
+    private _handleInputUpdate;
+    private _handleFocus;
+    private _canClamp;
+    get value(): number;
+    set value(value: number);
+    get valueStart(): number;
+    set valueStart(value: number);
+    get valueEnd(): number;
+    set valueEnd(value: number);
+    get label(): string;
+    set label(value: string);
+    get labelStart(): string;
+    set labelStart(value: string);
+    get labelEnd(): string;
+    set labelEnd(value: string);
+    get labelBuilder(): SliderLabelBuilder;
+    set labelBuilder(cb: SliderLabelBuilder);
+    get min(): number;
+    set min(value: number);
+    get max(): number;
+    set max(value: number);
+    get step(): number;
+    set step(value: number);
+    get tickmarks(): boolean;
+    set tickmarks(value: boolean);
+    get labeled(): boolean;
+    set labeled(value: boolean);
+    get range(): boolean;
+    set range(value: boolean);
+    get disabled(): boolean;
+    set disabled(value: boolean);
+    get readonly(): boolean;
+    set readonly(value: boolean);
+    set ariaLabel(value: string | null);
+    set ariaLabelStart(value: string | null);
+    set ariaLabelEnd(value: string | null);
+}