@energycap/components 0.28.7 → 0.28.8

package/lib/controls/item-picker/item-picker.component.d.ts

@@ -0,0 +1,108 @@
+import { OnChanges, OnDestroy, OnInit, TemplateRef } from '@angular/core';
+import { FormGroup } from '@angular/forms';
+import { Observable, Subject } from 'rxjs';
+import { TableSearchResults } from '../../display/table/searchable-table.component';
+import { PagingInfo } from '../../display/table/table-pagination.component';
+import { TableSelectableRowContext } from '../../display/table/table-selectable-row.component';
+import { Overlay } from '../../display/view-overlay/view-overlay.component';
+import { MenuItem } from '../menu/menu.component';
+export interface PickerItem<TValue = any, SItems = any> extends MenuItem {
+    id: string;
+    /** When set to true the available item will be automatically added to the selected list */
+    defaultSelected?: boolean;
+    /** Redefining to get the typing */
+    value: TValue;
+}
+export declare class ItemPickerSelectableContext<T> extends TableSelectableRowContext {
+    /** id/value map of the selected items. Used for keeping track of what is selected */
+    selectedItemsMap: Map<string, PickerItem<T>>;
+    /**
+     * Gives a way to tell the picker component that the map was modified externally and to update
+     * the available/selected lists
+     */
+    selectedItemsMapChanged: Subject<void>;
+}
+export declare class ItemPickerComponent<T> implements OnInit, OnChanges, OnDestroy {
+    /** Identifier for the component. This will be added to the beginning of all internal action elements */
+    id?: string;
+    /** Title displayed above the available items table */
+    availableTitle: string;
+    /** Title displayed above the selected items list */
+    selectedTitle: string;
+    /** The type of item being selected. Ex. Meters, Addresses */
+    itemName: string;
+    /** Form group that is given to the internal Searchable Table */
+    formModel?: FormGroup;
+    /** Template for when a custom header is needed for the available items table */
+    customAvailableHeaderTemplate?: TemplateRef<any>;
+    /** Template for when a custom available item is needed. Default template is a label only */
+    customAvailableItemTemplate?: TemplateRef<any>;
+    /** Template for when a custom selected item is needed. Default template is a label only */
+    customSelectedItemTemplate?: TemplateRef<any>;
+    /** Used by the internal Searchable Table to know when the page is ready */
+    ready?: Observable<void>;
+    /** Used by Searchable Table to retrieve the available items */
+    getItems?: (search?: string, pageChangeInfo?: PagingInfo) => Observable<TableSearchResults>;
+    /** Used to maintain the available items checkbox selection as well as the selected items list */
+    selectionContext: ItemPickerSelectableContext<T>;
+    /** Used by the internal Searchable Table when there is no available items to choose from based on the getItems results. Do not supply
+     *  to inherit the default message.
+     */
+    noDataMessage: string;
+    /** List of available items to pick from */
+    availableItems: PickerItem[];
+    /**
+     * Selected items array. Created from the selected items map. Binding to the
+     * map iterate values caused angular "expression changed" errors so after a map
+     * update this gets set to the values
+     */
+    selectedItems: PickerItem[];
+    /** Track by used for the searchable table rows */
+    trackByIndex: (index: number) => number;
+    tableStatus: Overlay;
+    /**
+     * Template used to display the available and selected items as well as the available item header.
+     * This will be set to the default template if a custom is not provided
+     */
+    internalizedAvailableHeaderTemplate: TemplateRef<any>;
+    internalizedAvailableItemTemplate: TemplateRef<any>;
+    internalizedSelectedItemTemplate: TemplateRef<any>;
+    /** Default templates used if a custom template is not provided */
+    private defaultAvailableHeaderTemplate;
+    private defaultAvailableItemTemplate;
+    private defaultSelectedItemTemplate;
+    /** Used to shut down our subscriptions when the component is destroyed */
+    private destroyed;
+    constructor();
+    ngOnInit(): void;
+    /**
+     * Watch for changes and react if the custom item template value changes
+     */
+    ngOnChanges(): void;
+    ngOnDestroy(): void;
+    /**
+     * Called by the searchable table when a new set of items are returned from the getItems call
+     * @param results
+     */
+    onItemsChange(results: TableSearchResults): void;
+    /**
+     * Called when the clear selection link button is clicked
+     */
+    onClearSelectionClick(): void;
+    /**
+     * Called when the remove item button is clicked for a selected item
+     * @param removeItem
+     */
+    removeSelectedItem(removeItem: PickerItem): void;
+    /**
+     * Watch for changes to the row checkboxes form array and update the selected items
+     * list
+     */
+    private setupRowCheckboxesWatcher;
+    /**
+     * Watch to be told if changes to the map were made outside of the component and if so update
+     * the array displayed in the selected list and select checkboxes for visible available items
+     */
+    private setupSelectedItemsChangedWatcher;
+    private setInternalizedTemplates;
+}

package/lib/display/table/searchable-table.component.d.ts

@@ -149,6 +149,8 @@ export declare class SearchableTableComponent implements OnInit, OnDestroy, OnCh
     removeCard: boolean;
     /** Classes to add to the overlay/card element */
     overlayClasses: string;
+    /** When true the overlay and table will not have flex-shrink-max but instead flex-grow */
+    fillParentHeight?: boolean;
     /**
      * PagingInfo for the current page.
      */

package/lib/shared/wizard/wizard-buttons/wizard-buttons.component.d.ts

@@ -4,6 +4,7 @@ export declare class WizardButtonsComponent {
     nextLabel?: string;
     backLabel?: string;
     cancelLabel?: string;
+    saveLabel?: string;
     cancelId?: string;
     saveId?: string;
     tabindex: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@energycap/components",
-  "version": "0.28.7",
+  "version": "0.28.8",
   "dependencies": {
     "tslib": "^2.0.0"
   },

package/public-api.d.ts

@@ -94,3 +94,4 @@ export * from './lib/display/hierarchy/hierarchy-mocks.spec';
 export * from './lib/shared/testing/hierarchy-base-test-injector-factory.spec';
 export * from './lib/display/hierarchy/hierarchy-tree/hierarchy-tree.component';
 export * from './lib/display/tree/tree.component';
+export * from './lib/controls/item-picker/item-picker.component';

package/src/assets/locales/en_US.json

@@ -37,5 +37,7 @@
   "PasswordInvalidValidationMessage_LC": "does not meet all requirements",
   "Next_TC": "Next",
   "Back_TC": "Back",
-  "DomainValidationMessage_SC": "must be a valid domain name"
+  "DomainValidationMessage_SC": "must be a valid domain name",
+  "ClearSelection_TC": "Clear Selection",
+  "ItemPickerNoItemsSelected_SC": "No {{itemName}} selected. Select from the available {{itemName}} list."
 }