All files / lib/multi-picker multi-picker.component.ts

94.99% Statements 531/559
94.49% Branches 103/109
91.66% Functions 33/36
94.99% Lines 531/559

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 5601x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 1x 1x 1x 1x 1x 1x 25x 25x 25x 1x 1x 191x 191x 191x 1x 1x 1x 5704x 5704x 5704x 1x 1x 29x 29x 29x 1x 1x 1x 25x 25x     25x 25x 1x 1x 21609x 21609x 1x 1x 1x 1x 1x 1x 5419x 5419x 5419x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 141x 141x 141x 141x 141x 141x 1x 1x 1x 71x 71x 1x 1x 1x 15x 13x 13x 15x 15x 1x 1x 1x 220x 220x 69x 69x 155x 155x 220x 220x 1x 1x 1x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 141x 1x 1x 1x         1x 1x 1x 5637x 5637x 5637x 5637x 5637x 5637x 5637x 551x 551x 269x 551x 551x 551x 3x 1x 2x 1x 5637x 5637x 5637x 5637x 5637x 1x 1x 1x 22349x 22349x 1x 1x 1x 6140x 6140x 6140x 6140x 6140x 6140x 6140x 1x 1x 1x 4x   4x 4x 4x 4x 4x 4x 1x 1x 1x 167x 167x 167x 16x 16x 16x 167x 1x 1x 1x 167x 167x 1x 1x 1x 17x 17x 17x 17x 17x 17x 17x 17x 17x 17x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 41x 41x 41x   41x 41x 41x 41x 41x 37x 37x   41x 37x 37x 37x 10x 27x 27x 37x 37x 37x 37x 39x 1x 41x 41x 1x 1x 1x 41x 41x 1x 1x 1x 816x 816x 1x 1x 1x 816x 816x 1x 1x 1x                         1x 1x 1x 27x 27x 67x 67x 67x 27x 27x 27x 27x 27x 27x 27x 27x 27x 27x 27x 1x 1x 1x 17x 17x 11x 8x 8x 8x 8x 7x 8x 17x 17x 17x 1x 1x 1x 23x 23x 23x 23x 20x 17x 17x 20x 20x 5x 5x 5x 5x 5x 5x 3x 1x 1x 1x 1x 2x 2x 1x 1x 1x 5x 5x 15x 20x 20x 23x 23x 23x 22x 23x 23x 1x 1x 1x 5613x 5613x 133x 5613x 5613x 1x 1x 1x               1x 1x 1x 178x 5x 178x 178x 1x 1x 1x 5613x 5613x 1x  
/*******************************************************************************
 * Copyright bei
 * Entwicklungs- und Pflegeverbund für das gemeinsame Fachverfahren gefa
 *
 *******************************************************************************/
import {
  AfterViewInit,
  ChangeDetectorRef,
  Component,
  ElementRef,
  EventEmitter,
  HostBinding,
  Input,
  IterableDiffers,
  NgZone,
  OnChanges,
  OnDestroy,
  Output,
  SimpleChanges,
  TemplateRef,
  ViewChild,
} from '@angular/core';
 
import {
  BaseIndexedItem,
  IndexedItem,
  isSetEqual,
  observeSize,
} from '../utils/internal-utils';
import {
  Callback,
  FormControlStatus,
  Item,
  WidgetKeySet,
} from '../utils/util.types';
import { SoundType, createWidgetKeySet, playSound } from '../utils/utilities';
 
import { LabelContainerComponent } from '../internal/label-container/label-container.component';
import { ListBoxItemDirective } from '../internal/listbox-item.directive';
import {
  ListBoxDirective,
  SelectionEvent,
} from '../internal/listbox.directive';
 
import {
  BasePickerComponent,
  KeyFocusTarget,
} from '../picker/base-picker.component';
 
const SELECT_ALL_ITEM_KEY: unique symbol = Symbol('select_all');
 
/**
 * A Picker allowing the user to choose an item from a collapsible list of options.
 */
@Component({
  selector: 'gc-multi-picker',
  templateUrl: './multi-picker.component.html',
  styleUrls: ['./multi-picker.component.css'],
})
export class MultiPickerComponent<T, I extends Item = Item>
  extends BasePickerComponent<T, I>
  implements OnDestroy, AfterViewInit, OnChanges
{
  /** Inform about the change of the selection state */
  @Output()
  public readonly valueChange: EventEmitter<ReadonlySet<T>> = new EventEmitter<
    ReadonlySet<T>
  >();
 
  /** Controls the separation of items. */
  @Input()
  public separatorVariant: 'semikolon' | 'komma' = 'semikolon';
 
  /**
   * Determines if a short summarized text should be displayed as value when all entries are selected.
   * If `true`, a summarized "all" value is shown, if `false` all selected entries are listed invividually.
   */
  @Input()
  public summarizeAllSelectedValue = true;
 
  /** The label that shows on the input. */
  @Input()
  public label = '';
 
  /** Marks the input field as required. true == required */
  @Input()
  public required = false;
 
  /** A hint message that will appear below the picker if set. */
  @Input()
  public hint = '';
 
  /** Optional icon provider to use for the selected entry */
  @Input()
  public iconProvider?: TemplateRef<unknown>;
 
  /** Optional icon provider to use for the entries in the popup list */
  @Input()
  public listIconProvider?: TemplateRef<unknown>;
 
  /** Decides whether large or small icons appearing. */
  @Input()
  public smallIcons = false;
 
  /**
   * Overrides the default text which is shown when the control is readonly and empty.
   */
  @Input()
  public readonlyEmptyValue = '';
 
  /**
   * If true, the component will be rendered in a slot-element mode.
   * This enables the component to be used in two-slot components (e.g. `gc-two-slot-label-container`).
   * @ignore
   */
  @Input()
  public _slotElementMode?: 'ext-search-single-field';
 
  /**
   * Error message id used when `_slotElementMode` is enabled.
   * @ignore
   */
  @Input()
  public _errorMessageId?: string;
 
  /**
   * Info (hint) message id used when `_slotElementMode` is enabled.
   * @ignore
   */
  @Input()
  public _infoMessageId?: string;
 
  /**
   * Enables setting of the value only when the Promise resolves with value "true".
   */
  @Input()
  public permitValueChange?: (v: ReadonlySet<T>) => Promise<boolean> | boolean;
 
  /**
   * Signals changes of the current (combined) status of the component, e.g. also reports errors triggered by internal
   * validation or input handling.
   */
  @Output()
  public readonly onStatusChange: EventEmitter<FormControlStatus> =
    new EventEmitter<FormControlStatus>(true);
 
  /** @ignore */
  @Output()
  public readonly _onHideFocusBorder: EventEmitter<boolean> =
    new EventEmitter<boolean>();
 
  /** @ignore */
  @ViewChild(LabelContainerComponent)
  public labelContainer?: LabelContainerComponent;
 
  /** @ignore */
  @ViewChild('drawerSlot')
  public drawerSlot?: ElementRef;
 
  /** @ignore */
  @ViewChild('button')
  private button?: ElementRef<HTMLElement>;
 
  /** @ignore */
  @ViewChild('itemArea')
  private itemArea?: ElementRef<HTMLSpanElement>;
 
  /** @ignore */
  @ViewChild(ListBoxDirective)
  private listbox?: ListBoxDirective;
 
  /**
   * The value represents the selected values.
   */
  @Input()
  public get value(): ReadonlySet<T> {
    return this._value;
  }
 
  public set value(value: ReadonlySet<T>) {
    this.storage.multiSelected = value;
    this._value = this.storage.multiSelected;
  }
 
  /** Determines if select all entry should be shown. */
  @Input()
  public get showSelectAll() {
    return this._showSelectAll;
  }
 
  public set showSelectAll(value) {
    this.storage.startingIndex = value ? this.selectAllItem.index + 1 : 0;
    this._showSelectAll = value;
  }
 
  /** An error message that will appear below the picker if set. */
  @Input()
  public set errorMessage(message: string) {
    if (this._errorMessage !== message) {
      this._errorMessage = message;
      this.emitStatusChange();
    }
  }
 
  public get errorMessage(): string {
    return this._errorMessage;
  }
 
  /**
   * @ignore
   * backwards compat for older Firefox (<121) only
   */
  @HostBinding('class.gc-disabled')
  protected get disabledCssClass(): boolean {
    return this.disabled;
  }
 
  /** @ignore */
  public _impl_id?: string;
  /** @ignore */
  public _impl_listbox_id?: string;
  /** @ignore */
  public _impl_visibleLabelId?: string;
 
  /** @ignore */
  public _sortedItems: IndexedItem<T, I>[] = [];
 
  /** @ignore */
  public focusItemId: string | undefined;
 
  /** @ignore */
  protected readonly selectAllItem: BaseIndexedItem = {
    index: 0,
    key: SELECT_ALL_ITEM_KEY,
    label: 'Alle Einträge auswählen',
  };
 
  /** @ignore */
  protected readonly _widgetKeys: WidgetKeySet = createWidgetKeySet(
    'gc-multi-picker-input',
  );
 
  /** @ignore */
  private _errorMessage = '';
 
  /** @ignore */
  private _resizeObserver?: Callback;
 
  /** @ignore */
  private _showSelectAll = false;
 
  private _value: ReadonlySet<T> = new Set();
 
  constructor(
    private zone: NgZone,
    private change: ChangeDetectorRef,
    itDiff: IterableDiffers,
  ) {
    super(itDiff);
  }
 
  /** @ignore */
  _impl_onItemFocus(item: ListBoxItemDirective | undefined) {
    this.focusItemId = item?.itemId;
  }
 
  /** @ignore */
  _impl_button_onKeydown(event: KeyboardEvent) {
    if (this._impl_drawerOpen) {
      // send event to listbox
      this.listbox?.handleKeyDown(event);
    }
  }
 
  /** @ignore */
  public ngOnChanges(changes: SimpleChanges): void {
    if (
      'items' in changes ||
      'itemAdapter' in changes ||
      'showSelectAll' in changes
    ) {
      this.storage.update();
    }
  }
 
  /** @ignore */
  public override ngAfterViewInit(): void {
    this._impl_id = this.autoIdDirective?.autoId;
    this._impl_listbox_id = (this._impl_id ?? '') + '_listbox';
    this._impl_visibleLabelId = (this.autoIdDirective?.labelId ?? '') + '_vis';
    if (this.itemArea) {
      this._resizeObserver = observeSize(
        this.itemArea,
        this.zone,
        this._resizeCallback.bind(this),
      );
    }
 
    this.change.detectChanges();
    super.ngAfterViewInit();
  }
 
  /** @ignore */
  public ngOnDestroy(): void {
    if (this._resizeObserver) {
      this._resizeObserver();
    }
  }
 
  /** @ignore */
  computeReadonlyText(): string {
    let result = '';
 
    const list: string[] = [];
    this.storage.multiSelectedItems.forEach(item => list.push(item.label));
 
    for (let idx = 0; idx < list.length; idx++) {
      result += list[idx];
 
      if (this.separatorVariant == 'semikolon' && idx != list.length - 1) {
        result += '; ';
      }
 
      if (this.separatorVariant == 'komma') {
        if (idx == list.length - 2) {
          result += ' und ';
        } else if (idx != list.length - 1) {
          result += ', ';
        }
      }
    }
    return result;
  }
 
  /** @ignore */
  public _isSelected(item: Item): boolean {
    return this.storage._multiSelectedKeys.has(item.key);
  }
 
  /** @ignore */
  public _isAllSelected(): boolean {
    return (
      this.storage.indexItems.length > 0 &&
      this.storage.indexItems
        .map(it => this._isSelected(it))
        .reduce((l, r) => l && r)
    );
  }
 
  /** @ignore */
  public _toggleSelectAll(): void {
    if (this._isAllSelected()) {
      this._impl_handleChange(new Set());
    } else {
      this._impl_handleChange(
        new Set<T>(this.storage.indexItems.map(it => it.value)),
      );
    }
  }
 
  /** @ignore */
  public override getAnker(): ElementRef {
    if (this.labelContainer) {
      return this.labelContainer.drawerSlot;
    } else if (this.drawerSlot) {
      return this.drawerSlot;
    }
    throw new Error('Unable to find a drawer slot');
  }
 
  /** @ignore */
  public override getScrollTarget(): ElementRef<HTMLElement> | undefined {
    return this.labelContainer?.boxEl;
  }
 
  /** @ignore */
  public override _impl_onFocusLeft(event?: EventTarget | null): void {
    super._impl_onFocusLeft(event);
 
    // We need to wait a tick so that the control is back
    // in a sync state
    setTimeout(() => {
      if (this.errorMessage.length > 0) {
        void playSound(SoundType.ERROR);
      }
    });
  }
 
  /** @ignore */
  public _impl_onLabelClick(): void {
    if (!this.disabled) {
      this.button?.nativeElement.focus();
      this.button?.nativeElement.click();
    }
  }
 
  /** @ignore */
  public _impl_onSelect(event: SelectionEvent): void {
    if (event.key === this.selectAllItem.key) {
      this._toggleSelectAll();
      if (event.source === 'enter') {
        void this._impl_close();
      }
      return;
    }
 
    const value =
      typeof event.key === 'string'
        ? this.storage.getValueByKey(event.key)
        : undefined;
    if (value !== undefined) {
      // toggle
      const newValue = new Set(this.storage.multiSelected);
      if (newValue.has(value)) {
        newValue.delete(value);
      } else {
        newValue.add(value);
      }
 
      this._impl_handleChange(newValue);
    }
    if (event.source === 'enter') {
      void this._impl_close();
    }
  }
 
  /** @ignore */
  public _impl_handleChange(value: ReadonlySet<T>): void {
    this.storage.multiSelected = value;
  }
 
  /** @ignore */
  protected getLabelId(): string {
    return this._widgetKeys.labelKey;
  }
 
  /** @ignore */
  protected getButtonId(): string {
    return this._widgetKeys.baseKey + '-button';
  }
 
  /** @ignore */
  protected computeAriaDescribedBy(): string | null {
    const errId = this._errorMessageId;
    const hintId = this._infoMessageId;
    if (errId && hintId) {
      return hintId + ' ' + errId;
    } else if (errId) {
      return errId;
    } else if (hintId) {
      return hintId;
    } else {
      return null;
    }
  }
 
  /** @ignore */
  protected override _impl_onOpen(focusItem: KeyFocusTarget): KeyFocusTarget {
    // sort once, selected on top
    const selectedFirstCmp = (
      a: IndexedItem<T, I>,
      b: IndexedItem<T, I>,
    ): number => (this._isSelected(b) ? 1 : 0) - (this._isSelected(a) ? 1 : 0);
    this._sortedItems = this.storage.indexItems
      .map(i => i)
      .sort(selectedFirstCmp);
 
    // emit true if button is focused and the closed drawer is going to be opened
    this._onHideFocusBorder.emit(
      this.isButtonFocused() && !this._impl_drawerOpen,
    );
 
    return focusItem;
  }
 
  /** @ignore */
  protected _impl_onButtonBlur(event: FocusEvent) {
    if (
      this.popup?.visible &&
      (event.relatedTarget === null || event.relatedTarget === document.body)
    ) {
      super._impl_close(false);
      this.zone.runOutsideAngular(() => {
        requestAnimationFrame(() => {
          this.buttonElement?.nativeElement.focus();
        });
      });
    }
  }
 
  /** @ignore */
  protected override async _impl_close(): Promise<void> {
    super._impl_close(false);
    this.focusItemId = undefined;
 
    if (!isSetEqual(this.storage.multiSelected, this.value)) {
      const doChange = () => {
        this.value = this.storage.multiSelected;
        this.valueChange.emit(this.storage.multiSelected);
      };
      if (this.permitValueChange !== undefined) {
        // Await focus transferable to complete so that it is restored
        // after the dialog opened
        await new Promise(res => setTimeout(res));
 
        const permit = this.permitValueChange(this.storage.multiSelected);
        if (typeof permit !== 'boolean') {
          const proceed = await permit;
          if (proceed) {
            doChange();
          } else {
            this.storage.multiSelected = this.value;
          }
        } else if (permit) {
          doChange();
        } else {
          this.storage.multiSelected = this.value;
        }
      } else {
        doChange();
      }
    }
 
    // emit false if button is focused and opened drawer is going to be closed
    this._onHideFocusBorder.emit(
      this.isButtonFocused() && this._impl_drawerOpen,
    );
  }
 
  /** @ignore */
  protected charactersExceedingLimit(): boolean {
    return (
      this.computeReadonlyText().length > this._characterLimit() &&
      this.storage.multiSelected.size > 1
    );
  }
 
  /** @ignore */
  private emitStatusChange() {
    const status: FormControlStatus = {};
    if (this.errorMessage) {
      status.error = [this.errorMessage];
    }

    this.onStatusChange.emit(status);
  }
 
  /** @ignore */
  private _resizeCallback(): void {
    if (this._impl_drawerOpen && this.popup) {
      void this.popup._handleAttach();
    }
  }
 
  /** @ignore */
  private _characterLimit(): number {
    return this.iconProvider ? 18 : 24;
  }
}