All files / lib/toggle-button-group toggle-button-group.component.ts

93.61% Statements 469/501
87.69% Branches 57/65
84.37% Functions 27/32
93.61% Lines 469/501

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 5021x 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 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 116x 116x 116x 1x 1x 54x 45x 45x 3x   3x 3x 3x 45x 45x 45x 45x 54x 54x 54x 54x 1x 1x 1x 1x 1x 1x       1x 1x 14x 14x 14x 1x 1x 1x 1x 1x 4591x 4591x 4591x 1x 1x 104x 104x 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 42x 42x 42x 1x 1x 42x 42x 42x 42x 42x 42x 42x 42x 42x 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 17x 17x 17x 17x 17x 17x 17x 1x 1x 1x 1x 1x             1x 1x 1x 1x 1x 10x 10x 10x 10x 10x 4x 4x 4x 4x 4x 2x 2x 2x 2x 10x             10x 10x 10x 10x 10x 10x 10x 10x 6x 6x 10x 10x 1x 1x 1x 1x 1x 1890x 1890x 633x 1257x 1890x 1890x 1x 1x 1x 1x 1x 1890x 1890x 1x 1x 1x 1x 1890x 1890x 1x 1x 1x 1x 1x 1890x 1890x 1890x 1x 1x 1x 1x 1x 23x 23x 23x 23x 23x 1x 1x 1x 1x 1x 17x 17x 1x 1x 1x 1x 1x 112x 112x 1x 1x 1x 1x 1x 90x 90x 90x 90x 90x 90x 90x 90x 90x 90x 88x 84x 90x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 90x 90x 1x 1x 1x 1x 1x 4x 4x   4x 4x 4x 4x 4x 1x 1x 1x 1x 1x 2x 2x 1x 1x 1x 2x 2x 2x 1x 1x 1x 1x 1x     1x 1x 1x 1x 1x         1x 1x 1x 1x 1x 10x 10x 10x 10x 10x 10x 1x 1x 1x 29x 29x 3x 29x 29x 1x 1x 1x 1x 1x 2834x 126x 126x 126x 126x   2834x 2834x 2834x 1x 1x 1x 1x 1x 54x 54x 1x 1x 1x 1x 1x 17x 17x 1x  
/*******************************************************************************
 * Copyright bei
 * Entwicklungs- und Pflegeverbund für das gemeinsame Fachverfahren gefa
 *
 *******************************************************************************/
import {
  AfterViewInit,
  Component,
  ElementRef,
  EventEmitter,
  Input,
  NgZone,
  OnDestroy,
  Output,
  QueryList,
  TemplateRef,
  ViewChild,
  ViewChildren,
} from '@angular/core';
 
import { createResizeObserver } from '../utils/internal-utils';
import {
  Callback,
  Converter,
  FocusableElementOwner,
  Item,
} from '../utils/util.types';
import { createWidgetKeySet, isItem, itemTrack } from '../utils/utilities';
 
import type {
  PickerComponent,
  TooltipComponent,
  WidgetKeySet,
} from '../../public-api';
import { ToggleButtonComponent } from './toggle-button.component';
 
/**
 * A Toggle Button Group component that contains multiple Toggle Button components.
 */
@Component({
  selector: 'gc-toggle-button-group',
  templateUrl: './toggle-button-group.component.html',
  styleUrls: ['./toggle-button-group.component.css'],
})
export class ToggleButtonGroupComponent<T, I extends Item = Item>
  implements FocusableElementOwner, OnDestroy, AfterViewInit
{
  /**
   * A label text to be used for aria-label attribute.
   */
  @Input()
  public label = '';
 
  /**
   * Defines how the content is displayed
   * - icon-only: only the icon is shown
   * - icon-left: icon is shown on the left of the text
   * - text-only: only text is displayed
   */
  @Input()
  public contentDisplay: 'icon-only' | 'text-only' | 'icon-left' = 'text-only';
 
  /**
   * If set to true moving the focus item also selects the item
   */
  @Input()
  public selectionFollowFocus = false;
 
  /**
   * Adapter that manages the conversion of item types.
   */
  @Input()
  public itemAdapter?: Converter<T, I>;
 
  /**
   * Optional template to render icon
   */
  @Input()
  public iconProvider?: TemplateRef<unknown>;
 
  /**
   * Inform about the change of the selection state
   */
  @Output()
  public readonly valueChange: EventEmitter<T> = new EventEmitter<T>();
 
  /**
   * @ignore
   */
  @ViewChild('tooltip')
  private _tooltip?: TooltipComponent;
 
  /**
   * @ignore
   */
  @ViewChild('picker')
  private pickerElement?: PickerComponent<Item>;
 
  /**
   * @ignore
   */
  @ViewChild('toggleButtonGroup')
  private toggleButtonGroup?: ElementRef<HTMLElement>;
 
  /**
   * @ignore
   */
  @ViewChildren('toggleButton')
  private _toggleButtons?: QueryList<ToggleButtonComponent>;
 
  /**
   * List of items that will be rendered as toggle buttons.
   */
  @Input()
  public get items(): readonly T[] {
    return this._items;
  }
 
  public set items(value: readonly T[]) {
    if (!value.includes(this.value)) {
      const idx = this.items.findIndex(e => e == this.value);
      if (idx >= 0) {
        if (idx < value.length) {
          this.value = value[idx];
        } else {
          if (value[value.length - 1]) {
            this.value = value[value.length - 1];
          }
        }
      }
    }
 
    this._items = value;
    this.convertItems();
  }
 
  /**
   * Force condensed mode (responsive picker)
   * @ignore
   */
  @Input()
  public get _condensedMode() {
    return this._condensedModeInternal;
  }
 
  public set _condensedMode(value) {
    this._condensedModeInternal = value;
    this.responsivePickerEnabled = value;
  }
 
  /**
   * Currently selected value.
   */
  @Input()
  public get value(): T {
    return this._value;
  }
 
  public set value(item: T) {
    this._value = item;
  }
 
  /**
   * @ignore
   */
  protected convertedItems: readonly Item[] = [];
 
  /** @ignore */
  protected readonly widgetKeys: WidgetKeySet = createWidgetKeySet(
    'gc-toggle-button-group',
  );
 
  /**
   * @ignore
   */
  protected responsivePickerEnabled = false;
 
  /**
   * @ignore
   */
  private _focusedToggleButtonIndex = 0;
 
  /**
   * @ignore
   */
  private _focused = false;
 
  /** @ignore */
  private _condensedModeInternal = false;
 
  /**
   * @ignore
   */
  private _value!: T;
 
  /**
   * @ignore
   */
  private _items: readonly T[] = [];
 
  /**
   * @ignore
   */
  private resizeObserver?: ResizeObserver;
 
  /**
   * @ignore
   */
  private resizeObserverCleanup?: Callback;
 
  constructor(
    private el: ElementRef<HTMLElement>,
    private zone: NgZone,
  ) {}
 
  ngAfterViewInit(): void {
    [this.resizeObserver, this.resizeObserverCleanup] = createResizeObserver(
      this.zone,
      () => this.recomputeResponsiveDesign(),
    );
    this.resizeObserver.observe(this.el.nativeElement);
    if (this.toggleButtonGroup) {
      this.resizeObserver.observe(this.toggleButtonGroup.nativeElement);
    }
  }
 
  /**
   * @ignore
   */
  ngOnDestroy(): void {
    if (this.resizeObserverCleanup) {
      this.resizeObserverCleanup();
    }
  }
 
  focusChild(): boolean {
    if (!this.responsivePickerEnabled && this._toggleButtons) {
      const activeButton = this._toggleButtons.toArray().find(btn => btn.value);
      const firstNonDisabledButton = this._toggleButtons
        .toArray()
        .find(btn => !btn._buttonElement.nativeElement.disabled);
 
      if (activeButton) {
        activeButton._buttonElement.nativeElement.focus();
        return true;
      } else if (firstNonDisabledButton) {
        firstNonDisabledButton._buttonElement.nativeElement.focus();
        return true;
      } else {
        return false;
      }
    } else if (this.responsivePickerEnabled && this.pickerElement) {
      return this.pickerElement.focusChild();
    }
    return false;
  }
 
  /**
   * @ignore
   */
  _valueChanged(key: string): void {
    const foundValue = this.findValueByKey(key);
 
    if (foundValue) {
      this.value = foundValue;
      this.valueChange.emit(this._value);
    }
  }
 
  /**
   * @ignore
   */
  _onFocus(tb: ToggleButtonComponent): void {
    const foundIndex = this._toggleButtons?.toArray().indexOf(tb);

    if (foundIndex) {
      this.updateFocusIndex(foundIndex);
    }
  }
 
  /**
   * @ignore
   */
  _onKeyDown(event: KeyboardEvent): void {
    const key = event.key;
    let flag = false;
 
    switch (key) {
      case 'ArrowRight':
      case 'ArrowDown':
        flag = true;
        this.moveToNextToggleButtonIndex();
        break;
      case 'ArrowLeft':
      case 'ArrowUp':
        flag = true;
        this.moveToPrevToggleButtonIndex();
        break;
      case 'Home':
        flag = true;
        this.moveToFirstToggleButtonIndex();
        break;
      case 'End':
        flag = true;
        this.moveToLastToggleButtonIndex();
        break;
      default:
        break;
    }
 
    this.setFocusToFocusedToggleButtonIndex();
 
    if (flag) {
      event.stopPropagation();
      event.preventDefault();
    }
  }
 
  /**
   * @ignore
   */
  public _isChecked(key: string): boolean {
    const foundItem =
      this.value && this.getAsItem(this.value).key === key
        ? this.getAsItem(this.value).key
        : undefined;
    return foundItem !== undefined;
  }
 
  /**
   * @ignore
   */
  public _itemTrackBy(index: number, item: Item): string {
    return itemTrack(item);
  }
  /**
   * @ignore
   */
  public _isFirstInToggleButtonGroup(key: string): boolean {
    return Array.from(this.convertedItems)[0].key === key;
  }
 
  /**
   * @ignore
   */
  public _isLastInToggleButtonGroup(key: string): boolean {
    const itemsArray = Array.from(this.convertedItems);
    return itemsArray[itemsArray.length - 1].key === key;
  }
 
  /**
   * @ignore
   */
  protected toggleButtonFocusChanged(key: string): void {
    this.updateFocusIndex(
      Array.from(this.convertedItems).findIndex(i => i.key === key),
    );
    this._focused = true;
  }
 
  /**
   * @ignore
   */
  protected overallFocusChanged(focused: boolean): void {
    this._focused = focused;
  }
 
  /**
   * @ignore
   */
  protected getSelectedItem(): Item {
    return this.getAsItem(this.value);
  }
 
  /**
   * @ignore
   */
  private recomputeResponsiveDesign(): void {
    if (this.toggleButtonGroup) {
      const formWidth = this.el.nativeElement.getBoundingClientRect().width;
      const groupWidth =
        this.toggleButtonGroup.nativeElement.getBoundingClientRect().width;
      const groupHeight =
        this.toggleButtonGroup.nativeElement.getBoundingClientRect().height;
 
      if (
        this.responsivePickerEnabled !==
        (groupWidth > formWidth ||
          groupHeight > 62 ||
          this._condensedModeInternal)
      ) {
        this.responsivePickerEnabled = !this.responsivePickerEnabled;
 
        const focused = this._focused;
        setTimeout(() => {
          if (
            this.responsivePickerEnabled &&
            this._tooltip &&
            this.pickerElement
          ) {
            this._tooltip.tooltipOwner = this.pickerElement.buttonElement;
          }
 
          /* when focused, keep the focus when switching between the responsive modes */
          if (focused) {
            this.focusChild();
          }
        });
      }
    }
  }
 
  /**
   * @ignore
   */
  private moveToNextToggleButtonIndex(): void {
    if (this._toggleButtons) {
      if (this._focusedToggleButtonIndex + 1 >= this._toggleButtons.length) {
        this.updateFocusIndex(0);
      } else {
        this.updateFocusIndex(this._focusedToggleButtonIndex + 1);
      }
    }
  }
 
  /**
   * @ignore
   */
  private moveToPrevToggleButtonIndex(): void {
    if (this._toggleButtons) {
      if (this._focusedToggleButtonIndex - 1 < 0) {
        this.updateFocusIndex(this._toggleButtons.length - 1);
      } else {
        this.updateFocusIndex(this._focusedToggleButtonIndex - 1);
      }
    }
  }
 
  /**
   * @ignore
   */
  private moveToFirstToggleButtonIndex(): void {
    this.updateFocusIndex(0);
  }
 
  /**
   * @ignore
   */
  private moveToLastToggleButtonIndex(): void {
    if (this._toggleButtons) {
      this.updateFocusIndex(this._toggleButtons.length - 1);
    }
  }
 
  /**
   * @ignore
   */
  private setFocusToFocusedToggleButtonIndex(): void {
    if (this._toggleButtons) {
      this._toggleButtons
        .get(this._focusedToggleButtonIndex)
        ?._buttonElement.nativeElement.focus();
    }
  }
 
  /** @ignore */
  private updateFocusIndex(index: number) {
    this._focusedToggleButtonIndex = index;
    if (this.selectionFollowFocus && this._toggleButtons) {
      this._valueChanged(this.convertedItems[index].key);
    }
  }
 
  /**
   * @ignore
   */
  private getAsItem(item: T): Item {
    if (this.itemAdapter === undefined) {
      if (isItem(item)) {
        return item;
      }
      throw new Error('missing converter');
    } else {
      return this.itemAdapter(item);
    }
  }
 
  /**
   * @ignore
   */
  private convertItems() {
    this.convertedItems = this.items.map(i => this.getAsItem(i));
  }
 
  /**
   * @ignore
   */
  private findValueByKey(key: string): T | undefined {
    return this.items.find(i => this.getAsItem(i).key == key);
  }
}