From c61fd03f727358c61ff3ae6da1059f61ac8dcb46 Mon Sep 17 00:00:00 2001
From: Stephanie Leary <stephanie.leary@equinoxoli.org>
Date: Tue, 16 May 2023 20:28:36 +0000
Subject: [PATCH] LP1828575 Revised keyboard support for grid options

Additional cleanup on keyboard compatibility and ARIA labels in the
eg-grid toolbar dropdowns.

Signed-off-by: Stephanie Leary <stephanie.leary@equinoxoli.org>
---
 .../share/grid/grid-column-config.component.html   | 20 ++++----
 .../grid/grid-toolbar-actions-menu.component.html  |  8 ++--
 .../src/app/share/grid/grid-toolbar.component.html | 53 ++++++++++++----------
 3 files changed, 42 insertions(+), 39 deletions(-)

diff --git a/Open-ILS/src/eg2/src/app/share/grid/grid-column-config.component.html b/Open-ILS/src/eg2/src/app/share/grid/grid-column-config.component.html
index 7d5b4a93bb..5b12131075 100644
--- a/Open-ILS/src/eg2/src/app/share/grid/grid-column-config.component.html
+++ b/Open-ILS/src/eg2/src/app/share/grid/grid-column-config.component.html
@@ -19,32 +19,32 @@
     <div class="row pt-1" *ngFor="let col of columnSet.columns"
       [ngClass]="{visible : col.visible}">
       <div class="col-lg-1" (click)="toggleVisibility(col)">
-        <span *ngIf="col.visible" class="badge badge-success">&#x2713;</span>
-        <span *ngIf="!col.visible" class="badge badge-warning">&#x2717;</span>
+        <span *ngIf="col.visible" class="badge badge-success" aria-label="Visible" i18n-aria-label>&#x2713;</span>
+        <span *ngIf="!col.visible" class="badge badge-warning" aria-label="Hidden" i18n-aria-label>&#x2717;</span>
       </div>
       <div class="col-lg-3" (click)="toggleVisibility(col)">{{col.label}}</div>
       <div class="col-lg-1">
-        <button class="btn" title="Move column up" i18n-title
+        <button class="btn" title="Move column up" i18n-title aria-label="Move column up" i18n-aria-label
           (click)="columnSet.moveColumn(col, -1)">
-          <span class="material-icons">arrow_upward</span>
+          <span class="material-icons" aria-hidden="true">arrow_upward</span>
         </button>
       </div>
       <div class="col-lg-1">
-        <button class="btn" title="Move column down" i18n-title
+        <button class="btn" title="Move column down" i18n-title aria-label="Move column down" i18n-aria-label
           (click)="columnSet.moveColumn(col, 1)">
-          <span class="material-icons">arrow_downward</span>
+          <span class="material-icons" aria-hidden="true">arrow_downward</span>
         </button>
       </div>
       <div class="col-lg-2">
-        <button class="btn" title="Make first visible" i18n-title
+        <button class="btn" title="Make first visible" i18n-title aria-label="Make first visible" i18n-aria-label
           (click)="columnSet.moveColumn(col, -10000)">
-          <span class="material-icons">vertical_align_top</span>
+          <span class="material-icons" aria-hidden="true">vertical_align_top</span>
         </button>
       </div>
       <div class="col-lg-2">
-        <button class="btn" title="Make last visible" i18n-title
+        <button class="btn" title="Make last visible" i18n-title aria-label="Make last visible" i18n-aria-label
           (click)="columnSet.moveColumn(col, 10000)">
-          <span class="material-icons">vertical_align_bottom</span>
+          <span class="material-icons" aria-hidden="true">vertical_align_bottom</span>
         </button>
       </div>
       <div class="col-lg-2" *ngIf="columnSet.isMultiSortable">
diff --git a/Open-ILS/src/eg2/src/app/share/grid/grid-toolbar-actions-menu.component.html b/Open-ILS/src/eg2/src/app/share/grid/grid-toolbar-actions-menu.component.html
index 80ecceb503..c4d7ca0fbe 100644
--- a/Open-ILS/src/eg2/src/app/share/grid/grid-toolbar-actions-menu.component.html
+++ b/Open-ILS/src/eg2/src/app/share/grid/grid-toolbar-actions-menu.component.html
@@ -1,7 +1,7 @@
 <!-- Copy To Clipboard is only displayed when using a row-specific
      context menu as the entry point. -->
-<button *ngIf="viaContextMenu" class="dropdown-item scrollable-menu"
-  (click)="openCopyToClipboard()" tabindex="0">
+<button *ngIf="viaContextMenu" class="dropdown-item"
+  (click)="openCopyToClipboard()" type="button">
   <div i18n>Copy to Clipboard</div>
   <div class="dropdown-divider"></div>
 </button>
@@ -10,9 +10,9 @@
 
 <ng-container 
   *ngFor="let action of gridContext.toolbarActions; let idx = index">
-  <button class="dropdown-item scrollable-menu" *ngIf="!action.hidden"
+  <button ngbDropdownItem class="dropdown-item" *ngIf="!action.hidden"
     [disabled]="shouldDisable(action)"
-    (click)="performAction(action)" tabindex="0">
+    (click)="performAction(action)" type="button">
     <ng-container *ngIf="action.isGroup">
       <span class="fw-bold fst-italic">{{action.label}}</span>
     </ng-container>
diff --git a/Open-ILS/src/eg2/src/app/share/grid/grid-toolbar.component.html b/Open-ILS/src/eg2/src/app/share/grid/grid-toolbar.component.html
index 00267baf71..920aa8652c 100644
--- a/Open-ILS/src/eg2/src/app/share/grid/grid-toolbar.component.html
+++ b/Open-ILS/src/eg2/src/app/share/grid/grid-toolbar.component.html
@@ -11,13 +11,13 @@
     <!-- buttons -->
     <div class="btn-grp" *ngIf="gridContext.toolbarButtons.length || gridContext.isFilterable">
       <!-- special case for remove filters button -->
-      <button *ngIf="gridContext.isFilterable"
+      <button *ngIf="gridContext.isFilterable" type="button" 
         class="btn btn-outline-dark me-1" (click)="gridContext.removeFilters()"
         [disabled]="!gridContext.filtersSet() || gridContext.dataSource.requestingData" i18n>
         Remove Filters
       </button>
       <button *ngFor="let btn of gridContext.toolbarButtons"
-        [disabled]="btn.disabled"
+        [disabled]="btn.disabled" type="button" 
         class="btn btn-outline-dark me-1" (click)="performButtonAction(btn)">
         {{btn.label}}
       </button>
@@ -44,13 +44,13 @@
   <div class="font-sm fst-italic d-flex flex-column-reverse me-2">
     {{gridContext.getSelectedRows().length}} selected
   </div>
-  <div ngbDropdown class="me-1" placement="bottom-right">
-    <button ngbDropdownToggle [disabled]="!gridContext.toolbarActions.length"
+  <div ngbDropdown autoClose="false" class="me-1" placement="bottom-right">
+    <button ngbDropdownToggle type="button" [disabled]="!gridContext.toolbarActions.length"
         class="btn btn-outline-dark no-dropdown-caret">
       <span title="Actions For Selected Rows" i18n-title
         class="material-icons mat-icon-in-button">playlist_add_check</span>
     </button>
-    <div class="dropdown-menu" ngbDropdownMenu>
+    <div class="dropdown-menu scrollable-menu" ngbDropdownMenu>
       <eg-grid-toolbar-actions-menu [gridContext]="gridContext">
       </eg-grid-toolbar-actions-menu>
     </div>
@@ -61,32 +61,32 @@
   <ng-container *ngIf="!gridContext.disablePaging">
 
   <button [disabled]="gridContext.pager.isFirstPage()" type="button"
+    title="First Page" i18n-title aria-label="First Page" i18n-aria-label
     class="btn btn-outline-dark me-1" (click)="gridContext.pager.toFirst()">
-    <span title="First Page" i18n-title
-        class="material-icons mat-icon-in-button">first_page</span>
+    <span class="material-icons mat-icon-in-button">first_page</span>
   </button>
   <button [disabled]="gridContext.pager.isFirstPage()" type="button"
+    title="Previous Page" i18n-title aria-label="Previous Page" i18n-aria-label
     class="btn btn-outline-dark me-1" (click)="gridContext.pager.decrement()">
-    <span title="Previous Page" i18n-title
-        class="material-icons mat-icon-in-button">keyboard_arrow_left</span>
+    <span class="material-icons mat-icon-in-button">keyboard_arrow_left</span>
   </button>
   <button [disabled]="gridContext.pager.isLastPage()" type="button"
+    title="Next Page" i18n-title aria-label="Next Page" i18n-aria-label
     class="btn btn-outline-dark me-1" (click)="gridContext.pager.increment()">
-    <span title="Next Page" i18n-title
-        class="material-icons mat-icon-in-button">keyboard_arrow_right</span>
+    <span class="material-icons mat-icon-in-button" aria-hidden="true">keyboard_arrow_right</span>
   </button>
   <div ngbDropdown class="me-1" placement="bottom-right">
-    <button ngbDropdownToggle class="btn btn-outline-dark text-button">
+    <button ngbDropdownToggle type="button" class="btn btn-outline-dark text-button">
       <span title="Select Row Count" i18n-title i18n>
         Rows {{gridContext.pager.limit}}
       </span>
     </button>
     <div class="dropdown-menu" ngbDropdownMenu>
-      <a class="dropdown-item"
+      <button type="button" class="dropdown-item"
         *ngFor="let count of [5, 10, 25, 50, 100]"
         (click)="gridContext.pager.setLimit(count)">
         <span class="ms-2">{{count}}</span>
-      </a>
+      </button>
     </div>
   </div>
   
@@ -107,41 +107,42 @@
   <eg-grid-column-config #columnConfDialog [gridContext]="gridContext">
   </eg-grid-column-config>
   <div ngbDropdown placement="bottom-right">
-    <button ngbDropdownToggle class="btn btn-outline-dark no-dropdown-caret">
-      <span title="Show Grid Options" i18n-title class="material-icons mat-icon-in-button">settings</span>
+    <button ngbDropdownToggle class="btn btn-outline-dark no-dropdown-caret"
+      title="Show Grid Options" i18n-title aria-label="Show Grid Options" i18n-aria-label>
+      <span class="material-icons mat-icon-in-button">settings</span>
     </button>
     <div class="dropdown-menu scrollable-menu" ngbDropdownMenu>
       <button nbgDropdownItem class="dropdown-item label-with-material-icon"
         (click)="columnConfDialog.open({size:'lg'})">
-        <span class="material-icons">build</span>
+        <span class="material-icons" aria-hidden="true">build</span>
         <span class="ms-2" i18n>Manage Columns</span>
       </button>
       <button nbgDropdownItem class="dropdown-item label-with-material-icon"
         (click)="colWidthConfig.isVisible = !colWidthConfig.isVisible">
-        <span class="material-icons">compare_arrows</span>
+        <span class="material-icons" aria-hidden="true">compare_arrows</span>
         <span class="ms-2" i18n>Manage Column Widths</span>
       </button>
       <button nbgDropdownItem class="dropdown-item label-with-material-icon"
         [disabled]="gridContext.toolbarActions.length === 0" (click)="toolbarActionsEditor.open().subscribe()">
-        <span class="material-icons">menu</span>
+        <span class="material-icons" aria-hidden="true">menu</span>
         <span class="ms-2" i18n>Manage Actions Menu</span>
       </button>
       <button nbgDropdownItem class="dropdown-item label-with-material-icon" *ngIf="!disableSaveSettings"
         (click)="saveGridConfig()">
-        <span class="material-icons">save</span>
+        <span class="material-icons" aria-hidden="true">save</span>
         <span class="ms-2" i18n>Save Grid Settings</span>
       </button>
       <button nbgDropdownItem class="dropdown-item label-with-material-icon" (click)="gridContext.columnSet.reset()">
-        <span class="material-icons">restore</span>
+        <span class="material-icons" aria-hidden="true">restore</span>
         <span class="ms-2" i18n>Reset Columns</span>
       </button>
       <a nbgDropdownItem class="dropdown-item label-with-material-icon" (click)="generateCsvExportUrl($event)"
         [download]="csvExportFileName" [href]="csvExportUrl">
-        <span class="material-icons">cloud_download</span>
+        <span class="material-icons" aria-hidden="true">cloud_download</span>
         <span class="ms-2" i18n>Download Full CSV</span>
       </a>
       <button nbgDropdownItem class="dropdown-item label-with-material-icon" (click)="printHtml()">
-        <span class="material-icons">print</span>
+        <span class="material-icons" aria-hidden="true">print</span>
         <span class="ms-2" i18n>Print Full Grid</span>
       </button>
   
@@ -149,8 +150,10 @@
   
       <button nbgDropdownItem class="dropdown-item label-with-material-icon" (click)="toggleVisibility(col)"
         *ngFor="let col of gridContext.columnSet.sortForColPicker()">
-        <span *ngIf="col.visible" class="badge badge-success">&#x2713;</span>
-        <span *ngIf="!col.visible" class="badge badge-warning">&#x2717;</span>
+        <!-- Note that the ARIA labels describe the action that will happen when the button
+          is pressed, not the current state indicated by the badge -->
+        <span *ngIf="col.visible" class="badge badge-success" aria-label="Hide" i18n-aria-label>&#x2713;</span>
+        <span *ngIf="!col.visible" class="badge badge-warning" aria-label="Show" i18n-aria-label>&#x2717;</span>
         <span class="ms-2">{{col.label}}</span>
       </button>
   
-- 
2.11.0