@energycap/components 0.41.1-ECAP-26841-date-input-features.20250108-1012 → 0.42.0

package/lib/controls/date-input/date-input.component.d.ts

@@ -1,115 +1,80 @@
-import { CdkConnectedOverlay, Overlay } from '@angular/cdk/overlay';
-import { ElementRef, OnChanges, OnInit, SimpleChanges } from '@angular/core';
-import { KeyboardNavContainerDirective } from '../../../public-api';
-import { ValidationMessageService } from '../../core/validation-message.service';
-import { FormGroupHelper } from '../../shared/form-group.helper';
-import { UserPreferenceService } from '../../shared/user-preference.service';
-import { Calendar } from '../calendar/calendar.types';
-import { FormControlBase } from '../form-control-base';
-import { DateInputSelectionStrategyBase } from './date-input-selection-strategies/date-input-selection-strategy-base';
-import { DateInput } from './date-input.types';
-import * as i0 from "@angular/core";
-export declare class DateInputComponent extends FormControlBase implements OnInit, OnChanges {
-    protected validationMessageService: ValidationMessageService;
-    protected formGroupHelper: FormGroupHelper;
-    private userPreferenceService;
-    private el;
-    private overlayService;
-    private selectionStrategies;
-    id: string;
-    /** The form control provided by the hosting form. */
-    formModel: DateInput.FormModel;
-    minDate: Date;
-    maxDate: Date;
-    /** The initial selection mode for the calendar. Defaults to day if not provided */
-    selectionMode: DateInput.SelectionMode;
-    /** The available selection modes for the calendar. Defaults to only the initial selection mode if not provided.  */
-    selectionModeOptions: DateInput.SelectionMode[];
-    /**
-     * When a date is provided, enables the 'quick select' button.
-     * Clicking the button will shift the selected date range to the provided date.
-     */
-    quickSelectDate?: Date;
-    /** Enables the next/previous selection buttons. */
-    enableSteppers: boolean;
-    /** The form group for the internal textboxes. Textbox2 is only used for ranges. */
-    textboxGroup: DateInput.TextboxGroup;
-    /**
-     * The current calendar selection.
-     * Updated when the user clicks on a calendar item or when the date entered into the textbox is parsed.
-     */
-    calendarSelection: DateInput.Selection | null;
-    /** Controls whether the calendar overlay is open or not. */
-    isCalendarOpen: boolean;
-    /** Placeholder for the textbox. Updated to reflect the user's date display preference. */
-    placeholder: string;
-    /** Overlay scroll strategy for the calendar overlay. Closes the calendar on scroll. */
-    overlayScrollStrategy: import("@angular/cdk/overlay").CloseScrollStrategy;
-    primaryCalendarView: Calendar.View;
-    secondaryCalendarView: Calendar.View;
-    primaryCalendarMaxDate: Date;
-    secondaryCalendarMinDate: Date;
-    disableSteppers: boolean;
-    selectionStrategy: DateInputSelectionStrategyBase;
-    /**
-     * Date parsing formats for user-entered dates. Defaults to month-first formats, but is updated in onInit
-     * to use the user's preferred date format.
-     */
-    private parseFormats;
-    calendar?: KeyboardNavContainerDirective;
-    controls?: KeyboardNavContainerDirective;
-    /** Reference to the overlay directive (see template). Used to update the overlay position on validation changes. */
-    overlay?: CdkConnectedOverlay;
-    constructor(validationMessageService: ValidationMessageService, formGroupHelper: FormGroupHelper, userPreferenceService: UserPreferenceService, el: ElementRef, overlayService: Overlay, selectionStrategies: DateInput.SelectionStrategies);
-    ngOnChanges(changes: SimpleChanges): void;
-    ngOnInit(): void;
-    /** Focuses the input whenever the calendar is shift-tabbed out of. */
-    onCalendarFocusOutStart(): void;
-    /** Closes the calendar and focuses the input whenever the calendar is tabbed out of. */
-    onCalendarFocusOutEnd(): void;
-    /** Closes the calendar if the user clicks outside of the calendar and date input. */
-    onOverlayOutsideClick(event: MouseEvent): void;
-    /** If the user tabs out of the form control's action button and the calendar is open, focus the first item in the calendar overlay */
-    onControlsFocusOutEnd(): void;
-    onTextboxBlur(): void;
-    onTextbox2Blur(): void;
-    onSelectionModeChange(mode: DateInput.SelectionMode): void;
-    onCalendarDateSelected(date: Date): void;
-    onPrimaryCalendarViewChange(view: Calendar.View): void;
-    onSecondaryCalendarViewChange(view: Calendar.View): void;
-    /** Shifts the calendar views to display today. Does not update the calendar selection. */
-    goToToday(): void;
-    goToQuickSelectDate(): void;
-    nextSelection(): void;
-    previousSelection(): void;
-    private updateFormModel;
-    private onFormModelStatusChanges;
-    private onFormModelValueChanges;
-    private onTextboxValueChanges;
-    private syncTextboxControlDisabledStatus;
-    private syncFormErrors;
-    /**
-     * Updates the date parsing formats and placeholder based on the user's display preference.
-     * NOTE: This is async because we're retrieving the user's preferences. We're not awaiting the result
-     * because the only logic that depends on this is the text box date parsing logic and placeholder.
-     * Our forms should always be behind a pending overlay, so the user won't be able to interact with the
-     * form until the user is loaded anyway.
-     */
-    private setDateFormats;
-    /** Focuses the date input. */
-    private focusInput;
-    private setSelectionMode;
-    /**
-     * Sets the max date for the primary calendar and the min date for the secondary calendar based
-     * on the current views in each. This prevents the user from moving the calendars out of order.
-     */
-    private updateCalendarMinMaxDates;
-    private updateCalendars;
-    private updatePrimaryCalendar;
-    private updateSecondaryCalendar;
-    private updateSteppers;
-    private validateTextboxes;
-    private validateDateString;
-    static ɵfac: i0.ɵɵFactoryDeclaration<DateInputComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<DateInputComponent, "ec-date-input", never, { "id": "id"; "formModel": "formModel"; "minDate": "minDate"; "maxDate": "maxDate"; "selectionMode": "selectionMode"; "selectionModeOptions": "selectionModeOptions"; "quickSelectDate": "quickSelectDate"; "enableSteppers": "enableSteppers"; }, {}, never, never, false, never>;
-}
+import { CdkConnectedOverlay, Overlay } from '@angular/cdk/overlay';
+import { ElementRef, OnInit } from '@angular/core';
+import { FormControl } from '@angular/forms';
+import { ValidationMessageService } from '../../core/validation-message.service';
+import { DateDisplayPipe } from '../../shared/display/pipes/date-display.pipe';
+import { FormGroupHelper } from '../../shared/form-group.helper';
+import { UserPreferenceService } from '../../shared/user-preference.service';
+import { CalendarSelection } from '../calendar/calendar.types';
+import { FormControlBase } from '../form-control-base';
+import * as i0 from "@angular/core";
+export type DateInputFormControl = FormControl<Date | null>;
+export declare class DateInputComponent extends FormControlBase implements OnInit {
+    protected validationMessageService: ValidationMessageService;
+    protected formGroupHelper: FormGroupHelper;
+    private userPreferenceService;
+    private dateDisplayPipe;
+    private el;
+    private overlayService;
+    id: string;
+    /** The form control provided by the hosting form. */
+    formModel: DateInputFormControl;
+    minDate: Date;
+    maxDate: Date;
+    /** The internal textbox's form control. */
+    textboxControl: FormControl<string | null>;
+    /**
+     * The current calendar selection.
+     * Updated when the user clicks on a calendar item or when the date entered into the textbox is parsed.
+     */
+    calendarSelection: CalendarSelection | null;
+    /** Controls whether the calendar overlay is open or not. */
+    isCalendarOpen: boolean;
+    /** Placeholder for the textbox. Updated to reflect the user's date display preference. */
+    placeholder: string;
+    /** Overlay scroll strategy for the calendar overlay. Closes the calendar on scroll. */
+    overlayScrollStrategy: import("@angular/cdk/overlay").CloseScrollStrategy;
+    /**
+     * Date parsing formats for user-entered dates. Defaults to month-first formats, but is updated in onInit
+     * to use the user's preferred date format.
+     */
+    private parseFormats;
+    /** Reference to the overlay directive (see template). Used to access the overlay's host element to control focus. */
+    overlay?: CdkConnectedOverlay;
+    constructor(validationMessageService: ValidationMessageService, formGroupHelper: FormGroupHelper, userPreferenceService: UserPreferenceService, dateDisplayPipe: DateDisplayPipe, el: ElementRef, overlayService: Overlay);
+    /** Focuses the input whenever the calendar is shift-tabbed out of. */
+    onCalendarFocusOutStart(event: KeyboardEvent): void;
+    /** Closes the calendar and focuses the input whenever the calendar is tabbed out of. */
+    onCalendarFocusOutEnd(event: KeyboardEvent): void;
+    /** Close the calendar if the user clicks outside of the calendar and date input. */
+    onOverlayOutsideClick(event: MouseEvent): void;
+    /** If the user tabs out of the form control's action button and the calendar is open, focus the first item in the calendar overlay */
+    onActionKeydown(event: KeyboardEvent): void;
+    onTextboxKeydown(event: KeyboardEvent): void;
+    /** Whenever the user selects a date from the calendar, update the formModel with the selection */
+    onSelectionChange(selection: CalendarSelection | null): void;
+    onTextboxBlur(): void;
+    ngOnInit(): void;
+    private onFormModelStatusChanges;
+    private onFormModelValueChanges;
+    private onTextboxValueChanges;
+    private syncTextboxControlDisabledStatus;
+    /**
+     * Updates the date parsing formats and placeholder based on the user's display preference.
+     * NOTE: This is async because we're retrieving the user's preferences. We're not awaiting the result
+     * because the only logic that depends on this is the text box date parsing logic and placeholder.
+     * Our forms should always be behind a pending overlay, so the user won't be able to interact with the
+     * form until the user is loaded anyway.
+     */
+    private setDateFormats;
+    /**
+     * Validator that checks if the date is within the min and max date range.
+     * If the date is outside of the range, the validator returns an error that
+     * triggers the validation message service to show the error in the label.
+     */
+    private dateValidator;
+    /** Focuses the date input. */
+    private focusInput;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DateInputComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<DateInputComponent, "ec-date-input", never, { "id": { "alias": "id"; "required": false; }; "formModel": { "alias": "formModel"; "required": false; }; "minDate": { "alias": "minDate"; "required": false; }; "maxDate": { "alias": "maxDate"; "required": false; }; }, {}, never, never, false, never>;
+}

package/lib/controls/dropdown/dropdown.component.d.ts

@@ -1,161 +1,161 @@
-import { AfterViewInit, EventEmitter, OnDestroy, OnInit, TemplateRef } from '@angular/core';
-import { PopupStatus } from '../../shared/directives/popup/popup-container.directive';
-import { DisplayStatus } from '../../shared/display';
-import { ButtonComponent, ButtonType } from '../button/button.component';
-import { MenuItem, MenuTemplateType } from '../menu/menu.component';
-import * as i0 from "@angular/core";
-export declare class DropdownComponent implements OnInit, AfterViewInit, OnDestroy {
-    /**
-     * Base id for the component's sub-elements
-     */
-    id?: string;
-    /**
-     * Automatically focus the dropdown toggle button
-     */
-    autofocus: boolean;
-    /**
-     * Controls the display status overlay for the menu
-     */
-    status?: DisplayStatus;
-    /**
-     * Disable the button to prevent the menu from being opened
-     */
-    disabled: boolean;
-    /**
-     * Optional label for the button
-     */
-    label?: string;
-    /**
-     * Optional icon for the button
-     */
-    icon?: string;
-    /**
-     * The button type, defaults to icon
-     */
-    buttonType?: ButtonType;
-    /**
-     * Optionally align the label of the button to the left or right. If not set,
-     * will be centered.
-     */
-    buttonAlignment?: 'left' | 'right';
-    /**
-     * Adds a tooltip to the dropdown toggle button. Should only be used when
-     * the toggle buttonType is 'icon'
-     */
-    buttonTitle: string;
-    /**
-     * The tabindex of the button
-     */
-    tabindex?: number;
-    /**
-     * Display a caret with the button label or icon
-     */
-    showArrow: boolean;
-    /**
-     * Items to display in the menu
-     */
-    items: MenuItem[];
-    /**
-     * The menu item template
-     */
-    menuTemplateType: MenuTemplateType;
-    /**
-     * Display a header on the menu
-     * @deprecated use first menu item with display set to 'heading' instead
-     */
-    menuTitle?: string;
-    /**
-     * Set a fixed height for the menu, auto by default
-     */
-    menuHeight?: number;
-    /**
-     * Set a fixed width in pixels for the menu, auto by default
-     */
-    menuWidth?: number;
-    /**
-     * Set a min-width in pixels on the menu. It will expand if the content is greater than the min-width
-     */
-    menuMinWidth?: number;
-    /**
-     * Pin the menu to the left or right of the button. Right by default
-     */
-    menuPosition?: 'left' | 'right';
-    /**
-     * Sticky footer to display at the bottom of the popup menu
-     */
-    menuFooter?: string;
-    /**
-     * Fix position the menu instead of absolute. Useful when the dropdown is in a
-     * dialog
-     */
-    popupFixed: boolean;
-    /**
-     * Pass a custom template to the toggle button
-     */
-    buttonCustomTemplate?: TemplateRef<any>;
-    /**
-    * Used to set the menu buttons state to pending
-    */
-    pending: boolean;
-    /**
-     * Emits an event when a menu item is selected
-     */
-    itemSelected: EventEmitter<MenuItem>;
-    /**
-     * Emits an event when the popup menu opens
-     */
-    popupOpened: EventEmitter<void>;
-    /**
-     * The status of the menu
-     */
-    menuStatus: PopupStatus;
-    /** Item to highlight when the menu is opened, used when the user
-     *  opens the menu via the keyboard
-     */
-    highlightedItem: MenuItem | null;
-    /** Used to know if the menu was toggled via the keyboard */
-    private isKeyboardEvent;
-    /**
-     * Internal reference to the menu element
-     */
-    private menuEl;
-    /**
-     * Internal reference to the popup directive
-     */
-    private popup;
-    /**
-     * Get a reference to the toggle button
-     */
-    dropdownToggleButton: ButtonComponent;
-    /**
-     * Unsubscribe any active subscriptions when the component is destroyed
-     */
-    private componentDestroyed;
-    constructor();
-    /**
-     * Subscribe to changes to the menu status
-     */
-    ngOnInit(): void;
-    /**
-     * Set up the popup
-     */
-    ngAfterViewInit(): void;
-    /**
-     * Unsubscribe to any active subscriptions
-     */
-    ngOnDestroy(): void;
-    /**
-     * Open and close the menu
-     */
-    toggleMenu(event?: Event): void;
-    /**
-     * Emit the selected item when it changes and close the menu
-     */
-    selectedChanged(item: MenuItem): void;
-    /**
-     * Closes the menu if the tab key is pressed
-     */
-    keyNavigate(event: KeyboardEvent): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<DropdownComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<DropdownComponent, "ec-dropdown", never, { "id": "id"; "autofocus": "autofocus"; "status": "status"; "disabled": "disabled"; "label": "label"; "icon": "icon"; "buttonType": "buttonType"; "buttonAlignment": "buttonAlignment"; "buttonTitle": "buttonTitle"; "tabindex": "tabindex"; "showArrow": "showArrow"; "items": "items"; "menuTemplateType": "menuTemplateType"; "menuTitle": "menuTitle"; "menuHeight": "menuHeight"; "menuWidth": "menuWidth"; "menuMinWidth": "menuMinWidth"; "menuPosition": "menuPosition"; "menuFooter": "menuFooter"; "popupFixed": "popupFixed"; "buttonCustomTemplate": "buttonCustomTemplate"; "pending": "pending"; }, { "itemSelected": "itemSelected"; "popupOpened": "popupOpened"; }, never, never, false, never>;
-}
+import { AfterViewInit, EventEmitter, OnDestroy, OnInit, TemplateRef } from '@angular/core';
+import { PopupStatus } from '../../shared/directives/popup/popup-container.directive';
+import { DisplayStatus } from '../../shared/display';
+import { ButtonComponent, ButtonType } from '../button/button.component';
+import { MenuItem, MenuTemplateType } from '../menu/menu.component';
+import * as i0 from "@angular/core";
+export declare class DropdownComponent implements OnInit, AfterViewInit, OnDestroy {
+    /**
+     * Base id for the component's sub-elements
+     */
+    id?: string;
+    /**
+     * Automatically focus the dropdown toggle button
+     */
+    autofocus: boolean;
+    /**
+     * Controls the display status overlay for the menu
+     */
+    status?: DisplayStatus;
+    /**
+     * Disable the button to prevent the menu from being opened
+     */
+    disabled: boolean;
+    /**
+     * Optional label for the button
+     */
+    label?: string;
+    /**
+     * Optional icon for the button
+     */
+    icon?: string;
+    /**
+     * The button type, defaults to icon
+     */
+    buttonType?: ButtonType;
+    /**
+     * Optionally align the label of the button to the left or right. If not set,
+     * will be centered.
+     */
+    buttonAlignment?: 'left' | 'right';
+    /**
+     * Adds a tooltip to the dropdown toggle button. Should only be used when
+     * the toggle buttonType is 'icon'
+     */
+    buttonTitle: string;
+    /**
+     * The tabindex of the button
+     */
+    tabindex?: number;
+    /**
+     * Display a caret with the button label or icon
+     */
+    showArrow: boolean;
+    /**
+     * Items to display in the menu
+     */
+    items: MenuItem[];
+    /**
+     * The menu item template
+     */
+    menuTemplateType: MenuTemplateType;
+    /**
+     * Display a header on the menu
+     * @deprecated use first menu item with display set to 'heading' instead
+     */
+    menuTitle?: string;
+    /**
+     * Set a fixed height for the menu, auto by default
+     */
+    menuHeight?: number;
+    /**
+     * Set a fixed width in pixels for the menu, auto by default
+     */
+    menuWidth?: number;
+    /**
+     * Set a min-width in pixels on the menu. It will expand if the content is greater than the min-width
+     */
+    menuMinWidth?: number;
+    /**
+     * Pin the menu to the left or right of the button. Right by default
+     */
+    menuPosition?: 'left' | 'right';
+    /**
+     * Sticky footer to display at the bottom of the popup menu
+     */
+    menuFooter?: string;
+    /**
+     * Fix position the menu instead of absolute. Useful when the dropdown is in a
+     * dialog
+     */
+    popupFixed: boolean;
+    /**
+     * Pass a custom template to the toggle button
+     */
+    buttonCustomTemplate?: TemplateRef<any>;
+    /**
+    * Used to set the menu buttons state to pending
+    */
+    pending: boolean;
+    /**
+     * Emits an event when a menu item is selected
+     */
+    itemSelected: EventEmitter<MenuItem>;
+    /**
+     * Emits an event when the popup menu opens
+     */
+    popupOpened: EventEmitter<void>;
+    /**
+     * The status of the menu
+     */
+    menuStatus: PopupStatus;
+    /** Item to highlight when the menu is opened, used when the user
+     *  opens the menu via the keyboard
+     */
+    highlightedItem: MenuItem | null;
+    /** Used to know if the menu was toggled via the keyboard */
+    private isKeyboardEvent;
+    /**
+     * Internal reference to the menu element
+     */
+    private menuEl;
+    /**
+     * Internal reference to the popup directive
+     */
+    private popup;
+    /**
+     * Get a reference to the toggle button
+     */
+    dropdownToggleButton: ButtonComponent;
+    /**
+     * Unsubscribe any active subscriptions when the component is destroyed
+     */
+    private componentDestroyed;
+    constructor();
+    /**
+     * Subscribe to changes to the menu status
+     */
+    ngOnInit(): void;
+    /**
+     * Set up the popup
+     */
+    ngAfterViewInit(): void;
+    /**
+     * Unsubscribe to any active subscriptions
+     */
+    ngOnDestroy(): void;
+    /**
+     * Open and close the menu
+     */
+    toggleMenu(event?: Event): void;
+    /**
+     * Emit the selected item when it changes and close the menu
+     */
+    selectedChanged(item: MenuItem): void;
+    /**
+     * Closes the menu if the tab key is pressed
+     */
+    keyNavigate(event: KeyboardEvent): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DropdownComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<DropdownComponent, "ec-dropdown", never, { "id": { "alias": "id"; "required": false; }; "autofocus": { "alias": "autofocus"; "required": false; }; "status": { "alias": "status"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "label": { "alias": "label"; "required": false; }; "icon": { "alias": "icon"; "required": false; }; "buttonType": { "alias": "buttonType"; "required": false; }; "buttonAlignment": { "alias": "buttonAlignment"; "required": false; }; "buttonTitle": { "alias": "buttonTitle"; "required": false; }; "tabindex": { "alias": "tabindex"; "required": false; }; "showArrow": { "alias": "showArrow"; "required": false; }; "items": { "alias": "items"; "required": false; }; "menuTemplateType": { "alias": "menuTemplateType"; "required": false; }; "menuTitle": { "alias": "menuTitle"; "required": false; }; "menuHeight": { "alias": "menuHeight"; "required": false; }; "menuWidth": { "alias": "menuWidth"; "required": false; }; "menuMinWidth": { "alias": "menuMinWidth"; "required": false; }; "menuPosition": { "alias": "menuPosition"; "required": false; }; "menuFooter": { "alias": "menuFooter"; "required": false; }; "popupFixed": { "alias": "popupFixed"; "required": false; }; "buttonCustomTemplate": { "alias": "buttonCustomTemplate"; "required": false; }; "pending": { "alias": "pending"; "required": false; }; }, { "itemSelected": "itemSelected"; "popupOpened": "popupOpened"; }, never, never, false, never>;
+}