@skyux/lookup 9.4.0 → 9.5.0

package/lib/modules/selection-modal/types/selection-modal-context.d.ts

@@ -11,8 +11,9 @@ export declare class SkySelectionModalContext {
     initialSearch: string;
     initialValue: unknown[];
     searchAsync: SkyAutocompleteSearchAsyncFunction;
+    selectionDescriptor: string;
     selectMode: SkyLookupSelectModeType;
     showAddButton: boolean;
     userConfig: SkyLookupShowMoreNativePickerConfig;
-    constructor(descriptorProperty: string, idProperty: string, initialSearch: string, initialValue: unknown[], searchAsync: SkyAutocompleteSearchAsyncFunction, selectMode: SkyLookupSelectModeType, showAddButton: boolean, userConfig: SkyLookupShowMoreNativePickerConfig);
+    constructor(descriptorProperty: string, idProperty: string, initialSearch: string, initialValue: unknown[], searchAsync: SkyAutocompleteSearchAsyncFunction, selectMode: SkyLookupSelectModeType, selectionDescriptor: string, showAddButton: boolean, userConfig: SkyLookupShowMoreNativePickerConfig);
 }

package/lib/modules/selection-modal/types/selection-modal-open-args.d.ts

@@ -18,6 +18,7 @@ export interface SkySelectionModalOpenArgs {
     /**
      * The title for the selection modal.
      * @default "Select an option/Select options"
+     * @deprecated Use the `selectionDescriptor` input to give context to the title and accessibility labels instead.
      */
     title?: string;
     /**
@@ -60,4 +61,10 @@ export interface SkySelectionModalOpenArgs {
      * using a modal as part of a cell editor in Data Entry Grid.
      */
     wrapperClass?: string;
+    /**
+     * A descriptor for the item or items being selected. Use a plural term when `selectMode` is set to `multiple`; otherwise, use a singular term. The descriptor helps set the selection modal's `aria-label` attributes for the multiselect toolbar controls, the search input, and the save button to provide text equivalents for screen readers [to support accessibility](https://developer.blackbaud.com/skyux/components/checkbox#accessibility).
+     * For example, when the descriptor is “constituents,” the search input’s `aria-label` is “Search constituents.” For more information about the `aria-label` attribute, see the [WAI-ARIA definition](https://www.w3.org/TR/wai-aria/#aria-label).
+     * @default "item"/"items"
+     */
+    selectionDescriptor?: string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skyux/lookup",
-  "version": "9.4.0",
+  "version": "9.5.0",
   "author": "Blackbaud, Inc.",
   "keywords": [
     "blackbaud",
@@ -42,15 +42,15 @@
     "@angular/core": "^16.2.5",
     "@angular/forms": "^16.2.5",
     "@angular/platform-browser": "^16.2.5",
-    "@skyux-sdk/testing": "9.4.0",
-    "@skyux/core": "9.4.0",
-    "@skyux/forms": "9.4.0",
-    "@skyux/i18n": "9.4.0",
-    "@skyux/indicators": "9.4.0",
-    "@skyux/layout": "9.4.0",
-    "@skyux/lists": "9.4.0",
-    "@skyux/modals": "9.4.0",
-    "@skyux/theme": "9.4.0"
+    "@skyux-sdk/testing": "9.5.0",
+    "@skyux/core": "9.5.0",
+    "@skyux/forms": "9.5.0",
+    "@skyux/i18n": "9.5.0",
+    "@skyux/indicators": "9.5.0",
+    "@skyux/layout": "9.5.0",
+    "@skyux/lists": "9.5.0",
+    "@skyux/modals": "9.5.0",
+    "@skyux/theme": "9.5.0"
   },
   "dependencies": {
     "intl-tel-input": "18.2.1",

package/testing/selection-modal/selection-modal-harness.d.ts

@@ -18,6 +18,11 @@ export declare class SkySelectionModalHarness extends ComponentHarness {
      * Enters text into the search input and performs a search.
      */
     enterSearchText(value: string): Promise<void>;
+    /**
+     *
+     * Gets the search input's aria-label.
+     */
+    getSearchAriaLabel(): Promise<string | null>;
     /**
      * Selects multiple search results based on a set of criteria.
      */
@@ -26,6 +31,11 @@ export declare class SkySelectionModalHarness extends ComponentHarness {
      * Saves any selections made and closes the modal.
      */
     saveAndClose(): Promise<void>;
+    /**
+     *
+     * Gets the save button's aria-label.
+     */
+    getSaveButtonAriaLabel(): Promise<string | null>;
     /**
      * Closes the picker without saving any selections made.
      */
@@ -38,6 +48,11 @@ export declare class SkySelectionModalHarness extends ComponentHarness {
      * Clears all selections made.
      */
     clearAll(): Promise<void>;
+    /**
+     *
+     * Gets the clear all button's aria-label.
+     */
+    getClearAllButtonAriaLabel(): Promise<string | null>;
     /**
      * Whether the selection modal is configured to allow multiple selections.
      */
@@ -46,6 +61,11 @@ export declare class SkySelectionModalHarness extends ComponentHarness {
      * Selects all search results.
      */
     selectAll(): Promise<void>;
+    /**
+     *
+     * Gets the select all button's aria-label.
+     */
+    getSelectAllButtonAriaLabel(): Promise<string | null>;
     /**
      * Loads more results in the picker.
      */
@@ -58,4 +78,8 @@ export declare class SkySelectionModalHarness extends ComponentHarness {
      * Clicks the add button.
      */
     clickAddButton(): Promise<void>;
+    /**
+     * Gets the "Only show selected" checkbox's aria-label
+     */
+    getOnlyShowSelectedAriaLabel(): Promise<string | null>;
 }