All files / lib/filter/filter-button filter-button.component.ts

100% Statements 233/233
100% Branches 23/23
100% Functions 10/10
100% Lines 233/233

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 2341x 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 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 2508x 2508x 2508x 134x 134x 2508x 2508x 134x 134x 134x 134x 134x 2508x 2508x 2508x 134x 134x 102x 33x 33x 33x 69x 69x 69x 102x 102x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 134x 1x 1x 1x 1x 1x 1x 1x 11x 1x 11x 11x 1x 1x 1x 1x 1x 9x 9x 9x 1x 1x 1x 1x 1x 2x 2x 1x  
/*******************************************************************************
 * Copyright bei
 * Entwicklungs- und Pflegeverbund für das gemeinsame Fachverfahren gefa
 *
 *******************************************************************************/
import {
  Component,
  ElementRef,
  EventEmitter,
  HostListener,
  Input,
  Output,
  ViewChild,
} from '@angular/core';
 
import {
  FilterItem,
  FilterSlots,
  FocusableElementOwner,
  HasSublabel,
  ItemGroup,
  SlotItem,
  WidgetKeySet,
} from '../../utils/util.types';
import { createWidgetKeySet } from '../../utils/utilities';
 
import { MenuComponent } from '../../internal/menu/menu.component';
 
/**
 * A Filter Button element that allows users to fire an action on a button press or as menu.
 */
@Component({
  selector: 'gc-filter-button',
  templateUrl: './filter-button.component.html',
  styleUrls: [
    './../../utils/styles/reset-button.css',
    './filter-button.component.css',
  ],
  host: {
    // host element generates an extra text node, which causes Firefox + Jaws to read out the button
    // text twice when it's used in a list -> remove it from the a11y tree
    role: 'presentation',
  },
})
export class FilterButtonComponent implements FocusableElementOwner {
  /**
   * Status of the button. true === selected
   */
  @Input()
  public selected = false;
 
  /**
   * Filter label.
   */
  @Input()
  public label = '';
 
  /**
   * Value text of the filter.
   */
  @Input()
  public value = '';
 
  /**
   * If not empty, the button will open a menu on click and render these as items of the menu.
   */
  @Input()
  public menuItems: readonly ItemGroup<FilterItem & HasSublabel>[] = [];
 
  /**
   * Decides on which side of the menu button the menu is going to appear.
   */
  @Input()
  public menuAlignment: 'start' | 'end' | 'auto' = 'end';
 
  /**
   * Text that will appear in the button tooltip.
   */
  @Input()
  public tooltipText?: string;
 
  /**
   * Key of the filter item which this button controls.
   */
  @Input()
  public itemKey = '';
 
  /**
   * Display the "remove" button on the filter pill.
   */
  @Input()
  public showRemoveButton = false;
 
  /**
   * Adds a context menu to the filter pill
   */
  @Input()
  public contextMenu = false;
 
  /**
   * text may be abbreviated
   */
  @Input()
  public allowAbbreviation = false;
 
  /**
   * Event which is fired when an menu item is activated.
   */
  @Output()
  public readonly onMenuAction: EventEmitter<FilterItem & HasSublabel> =
    new EventEmitter<FilterItem & HasSublabel>();
 
  /**
   * Event emitted when pressed on context menu action.
   */
  @Output()
  public readonly onContextMenuAction: EventEmitter<SlotItem<FilterSlots>> =
    new EventEmitter<SlotItem<FilterSlots>>();
 
  /**
   * Event which is fired when clicked on the filter pill.
   */
  @Output()
  public readonly onAction: EventEmitter<FilterItem> =
    new EventEmitter<FilterItem>();
 
  /**
   * Event which is fired when "remove" button is pressed
   */
  @Output()
  public readonly onRemove: EventEmitter<void> = new EventEmitter<void>();
 
  /**
   * @ignore
   */
  @ViewChild('button')
  public button!: ElementRef<HTMLButtonElement>;
 
  /**
   * @ignore
   */
  @ViewChild('menu')
  public menu?: MenuComponent<FilterItem>;
 
  /**
   * Actions that will be shown in the context menu of the button
   */
  @Input()
  public get contextMenuActions(): readonly SlotItem<FilterSlots>[] {
    return this._contextMenuActions;
  }
 
  public set contextMenuActions(value: readonly SlotItem<FilterSlots>[]) {
    this._contextMenuActions = value.length > 0 ? value : this._defaultActions;
  }
 
  /**
   * keys of all disabled actions
   */
  @Input()
  public get disabledActionKeys(): ReadonlySet<string> {
    return this._disabledActionKeys;
  }
 
  public set disabledActionKeys(value: ReadonlySet<string> | undefined) {
    if (value) {
      this._disabledActionKeys = new Set([
        ...value,
        ...[this._defaultActions[0].key],
      ]);
    } else {
      this._disabledActionKeys = new Set([this._defaultActions[0].key]);
    }
  }
 
  /**
   * @ignore
   */
  public _controlsElementId?: string;
 
  /**
   * @ignore
   * Figma: aligned to bottom of text. 22px / 2 + 4px (default margin of the menu)
   */
  protected readonly contextMenuOffset = 15;
 
  /** @ignore */
  private readonly _widgetKeys: WidgetKeySet =
    createWidgetKeySet('gc-filter-button');
 
  /** @ignore */
  private readonly _defaultActions: SlotItem<FilterSlots>[] = [
    {
      key: this._widgetKeys.widgetKey + '-tree-default',
      label: 'Keine Aktion verfügbar',
      slot: 'header',
    },
  ];
 
  /** @ignore */
  private _contextMenuActions: readonly SlotItem<FilterSlots>[] =
    this._defaultActions;
 
  /** @ignore */
  private _disabledActionKeys: ReadonlySet<string> = new Set([
    this._defaultActions[0].key,
  ]);
 
  /**
   * @ignore
   */
  @HostListener('keydown', ['$event'])
  public onKeyDown(event: KeyboardEvent): void {
    if (this.showRemoveButton && event.key === 'Delete') {
      this.onRemove.emit();
    }
  }
 
  /**
   * @ignore
   */
  public focusChild(): boolean {
    this.button.nativeElement.focus();
    return true;
  }
 
  /**
   * @ignore
   */
  protected _onContextMenuAction(item: SlotItem<FilterSlots>): void {
    this.onContextMenuAction.emit(item);
  }
}