fix: improve accessibility in FilterSearch and Facets (v2.2.0)

docs/search-ui-react.filtergroupcssclasses.md

@@ -129,6 +129,25 @@ string
 _(Optional)_
 
 
+</td></tr>
+<tr><td>
+
+[searchInputLabel?](./search-ui-react.filtergroupcssclasses.searchinputlabel.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_
+
+
 </td></tr>
 <tr><td>
 

docs/search-ui-react.filtergroupcssclasses.searchinputlabel.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-ui-react](./search-ui-react.md) &gt; [FilterGroupCssClasses](./search-ui-react.filtergroupcssclasses.md) &gt; [searchInputLabel](./search-ui-react.filtergroupcssclasses.searchinputlabel.md)
+
+## FilterGroupCssClasses.searchInputLabel property
+
+**Signature:**
+
+```typescript
+searchInputLabel?: string;
+```

docs/search-ui-react.filtergroupprops.md

@@ -167,6 +167,25 @@ number
 _(Optional)_ Limit on the number of options to be displayed.
 
 
+</td></tr>
+<tr><td>
+
+[showOptionsSearchInputLabel?](./search-ui-react.filtergroupprops.showoptionssearchinputlabel.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_ Whether or not to display the visible search input label. Defaults to false.
+
+
 </td></tr>
 <tr><td>
 

docs/search-ui-react.filtergroupprops.showoptionssearchinputlabel.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-ui-react](./search-ui-react.md) &gt; [FilterGroupProps](./search-ui-react.filtergroupprops.md) &gt; [showOptionsSearchInputLabel](./search-ui-react.filtergroupprops.showoptionssearchinputlabel.md)
+
+## FilterGroupProps.showOptionsSearchInputLabel property
+
+Whether or not to display the visible search input label. Defaults to false.
+
+**Signature:**
+
+```typescript
+showOptionsSearchInputLabel?: boolean;
+```

docs/search-ui-react.filtersearch.md

@@ -9,7 +9,7 @@ A component which allows a user to search for filters associated with specific e
 **Signature:**
 
 ```typescript
-declare function FilterSearch({ searchFields, label, placeholder, searchOnSelect, onSelect, onDropdownInputChange, afterDropdownInputFocus, sectioned, customCssClasses, disableBuiltInClasses, ariaLabel, showCurrentLocationButton, geolocationProps }: FilterSearchProps): React.JSX.Element;
+declare function FilterSearch({ searchFields, label, placeholder, searchOnSelect, onSelect, onDropdownInputChange, afterDropdownInputFocus, sectioned, customCssClasses, disableBuiltInClasses, ariaLabel, resultsRegionAriaLabel, showCurrentLocationButton, geolocationProps }: FilterSearchProps): React.JSX.Element;
 ```
 
 ## Parameters
@@ -32,7 +32,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-{ searchFields, label, placeholder, searchOnSelect, onSelect, onDropdownInputChange, afterDropdownInputFocus, sectioned, customCssClasses, disableBuiltInClasses, ariaLabel, showCurrentLocationButton, geolocationProps }
+{ searchFields, label, placeholder, searchOnSelect, onSelect, onDropdownInputChange, afterDropdownInputFocus, sectioned, customCssClasses, disableBuiltInClasses, ariaLabel, resultsRegionAriaLabel, showCurrentLocationButton, geolocationProps }
 
 
 </td><td>

docs/search-ui-react.filtersearchprops.md

@@ -205,6 +205,25 @@ string
 _(Optional)_ The search input's placeholder text when no text has been entered by the user. Defaults to "Search here...".
 
 
+</td></tr>
+<tr><td>
+
+[resultsRegionAriaLabel?](./search-ui-react.filtersearchprops.resultsregionarialabel.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_ The accessible label for the region which contains the filter search input and its filtered content. If provided, this overrides `label` for the region accessible label.
+
+
 </td></tr>
 <tr><td>
 

docs/search-ui-react.filtersearchprops.resultsregionarialabel.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-ui-react](./search-ui-react.md) &gt; [FilterSearchProps](./search-ui-react.filtersearchprops.md) &gt; [resultsRegionAriaLabel](./search-ui-react.filtersearchprops.resultsregionarialabel.md)
+
+## FilterSearchProps.resultsRegionAriaLabel property
+
+The accessible label for the region which contains the filter search input and its filtered content. If provided, this overrides `label` for the region accessible label.
+
+**Signature:**
+
+```typescript
+resultsRegionAriaLabel?: string;
+```

docs/search-ui-react.md

@@ -140,7 +140,7 @@ A divider component used to separate NumericalFacets, HierarchicalFacets, Standa
 </td></tr>
 <tr><td>
 
-[FilterSearch({ searchFields, label, placeholder, searchOnSelect, onSelect, onDropdownInputChange, afterDropdownInputFocus, sectioned, customCssClasses, disableBuiltInClasses, ariaLabel, showCurrentLocationButton, geolocationProps })](./search-ui-react.filtersearch.md)
+[FilterSearch({ searchFields, label, placeholder, searchOnSelect, onSelect, onDropdownInputChange, afterDropdownInputFocus, sectioned, customCssClasses, disableBuiltInClasses, ariaLabel, resultsRegionAriaLabel, showCurrentLocationButton, geolocationProps })](./search-ui-react.filtersearch.md)
 
 
 </td><td>

docs/search-ui-react.standardfacetprops.md

@@ -167,6 +167,25 @@ boolean
 _(Optional)_ Whether or not to show the option counts for each filter. Defaults to true.
 
 
+</td></tr>
+<tr><td>
+
+[showOptionsSearchInputLabel?](./search-ui-react.standardfacetprops.showoptionssearchinputlabel.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_ Whether or not to show the label for the search bar when present. Defaults to false.
+
+
 </td></tr>
 <tr><td>
 

docs/search-ui-react.standardfacetprops.showoptionssearchinputlabel.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-ui-react](./search-ui-react.md) &gt; [StandardFacetProps](./search-ui-react.standardfacetprops.md) &gt; [showOptionsSearchInputLabel](./search-ui-react.standardfacetprops.showoptionssearchinputlabel.md)
+
+## StandardFacetProps.showOptionsSearchInputLabel property
+
+Whether or not to show the label for the search bar when present. Defaults to false.
+
+**Signature:**
+
+```typescript
+showOptionsSearchInputLabel?: boolean;
+```

docs/search-ui-react.staticfiltersprops.md

@@ -167,6 +167,25 @@ boolean
 _(Optional)_ Whether or not a search is automatically run when a filter is selected. Defaults to true.
 
 
+</td></tr>
+<tr><td>
+
+[showOptionsSearchInputLabel?](./search-ui-react.staticfiltersprops.showoptionssearchinputlabel.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_ Whether or not to display the visible search input label. Defaults to false.
+
+
 </td></tr>
 <tr><td>
 

docs/search-ui-react.staticfiltersprops.showoptionssearchinputlabel.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-ui-react](./search-ui-react.md) &gt; [StaticFiltersProps](./search-ui-react.staticfiltersprops.md) &gt; [showOptionsSearchInputLabel](./search-ui-react.staticfiltersprops.showoptionssearchinputlabel.md)
+
+## StaticFiltersProps.showOptionsSearchInputLabel property
+
+Whether or not to display the visible search input label. Defaults to false.
+
+**Signature:**
+
+```typescript
+showOptionsSearchInputLabel?: boolean;
+```

etc/search-ui-react.api.md

@@ -274,6 +274,8 @@ export interface FilterGroupCssClasses {
     // (undocumented)
     searchInput?: string;
     // (undocumented)
+    searchInputLabel?: string;
+    // (undocumented)
     titleLabel?: string;
 }
 
@@ -286,6 +288,7 @@ export interface FilterGroupProps {
     filterOptions: FilterOptionConfig[];
     searchable?: boolean;
     showMoreLimit?: number;
+    showOptionsSearchInputLabel?: boolean;
     title: string;
 }
 
@@ -299,7 +302,7 @@ export interface FilterOptionConfig {
 }
 
 // @public
-export function FilterSearch({ searchFields, label, placeholder, searchOnSelect, onSelect, onDropdownInputChange, afterDropdownInputFocus, sectioned, customCssClasses, disableBuiltInClasses, ariaLabel, showCurrentLocationButton, geolocationProps }: FilterSearchProps): React_2.JSX.Element;
+export function FilterSearch({ searchFields, label, placeholder, searchOnSelect, onSelect, onDropdownInputChange, afterDropdownInputFocus, sectioned, customCssClasses, disableBuiltInClasses, ariaLabel, resultsRegionAriaLabel, showCurrentLocationButton, geolocationProps }: FilterSearchProps): React_2.JSX.Element;
 
 // @public
 export interface FilterSearchCssClasses extends AutocompleteResultCssClasses {
@@ -332,6 +335,7 @@ export interface FilterSearchProps {
     onDropdownInputChange?: (params: OnDropdownInputChangeProps) => void;
     onSelect?: (params: OnSelectParams) => void;
     placeholder?: string;
+    resultsRegionAriaLabel?: string;
     searchFields: Omit<SearchParameterField, 'fetchEntities'>[];
     // @deprecated
     searchOnSelect?: boolean;
@@ -860,6 +864,7 @@ export interface StandardFacetProps {
     label?: string;
     showMoreLimit?: number;
     showOptionCounts?: boolean;
+    showOptionsSearchInputLabel?: boolean;
     transformOptions?: (options: DisplayableFacetOption[]) => DisplayableFacetOption[];
 }
 
@@ -922,6 +927,7 @@ export interface StaticFiltersProps {
     filterOptions: StaticFilterOptionConfig[];
     searchable?: boolean;
     searchOnChange?: boolean;
+    showOptionsSearchInputLabel?: boolean;
     title: string;
 }
 
@@ -1043,7 +1049,7 @@ export interface VisualAutocompleteConfig {
 
 // Warnings were encountered during analysis:
 //
-// dist/index.d.ts:1749:5 - (ae-forgotten-export) The symbol "translations" needs to be exported by the entry point index.d.ts
+// dist/index.d.ts:1764:5 - (ae-forgotten-export) The symbol "translations" needs to be exported by the entry point index.d.ts
 
 // (No @packageDocumentation comment for this package)
 

locales/ar/search-ui-react.json

@@ -30,6 +30,7 @@
   "didYouMean": "هل كنت تقصد <button>{{correctedQuery}}</button>",
   "dropDownScreenReaderInstructions": "عند توفر نتائج الإكمال التلقائي، استخدم الأسهم للأعلى والأسفل للتنقل واضغط Enter للاختيار.",
   "feedback": "ملاحظات",
+  "filterGroupSearchInputLabel": "ابحث في خيارات {{title}}",
   "invalidRange": "نطاق غير صالح",
   "max": "الحد الأقصى",
   "min": "الحد الأدنى",
@@ -63,9 +64,9 @@
   "resultsCountText_zero": "لا توجد نتائج",
   "resultsCountWithPaginationText": "{{paginateStart}} - {{paginateEnd}} من أصل {{resultsCount}} نتيجة",
   "searchHere": "ابحث هنا…",
+  "showingAllInstead": "يتم عرض جميع نتائج {{currentVerticalLabel}} بدلاً من ذلك.",
   "showLess": "عرض أقل",
   "showMore": "عرض المزيد",
-  "showingAllInstead": "يتم عرض جميع نتائج {{currentVerticalLabel}} بدلاً من ذلك.",
   "sources_few": "مصادر ({{count}})",
   "sources_many": "مصدر ({{count}})",
   "sources_one": "مصدر",

locales/cs/search-ui-react.json

@@ -5,10 +5,12 @@
   "apply": "Použít",
   "applyFilters": "Použít filtry",
   "autocompleteOptionsFound_few": "Nalezeny {{count}}{{label}} možnosti automatického dokončování.",
+  "autocompleteOptionsFound_many": "Nalezeno {{count}}{{label}} možností automatického dokončování.",
   "autocompleteOptionsFound_one": "Nalezena {{count}}{{label}} možnost automatického dokončování.",
   "autocompleteOptionsFound_other": "Nalezeno {{count}}{{label}} možností automatického dokončování.",
   "autocompleteSuggestion": "návrh automatického doplňování: {{suggestion}}",
   "autocompleteSuggestionsFound_few": "Nalezeny {{count}} návrhy automatického dokončování.",
+  "autocompleteSuggestionsFound_many": "Nalezeno {{count}} návrhů automatického dokončování.",
   "autocompleteSuggestionsFound_one": "Nalezen {{count}} návrh automatického dokončování.",
   "autocompleteSuggestionsFound_other": "Nalezeno {{count}} návrhů automatického dokončování.",
   "basedOnYourDevice": " (na základě vašeho zařízení)",
@@ -25,6 +27,7 @@
   "didYouMean": "Mysleli jste <button>{{correctedQuery}}</button>",
   "dropDownScreenReaderInstructions": "Pokud jsou dostupné výsledky automatického doplnění, použijte šipky nahoru/dolů pro výběr a Enter pro potvrzení.",
   "feedback": "Zpětná vazba",
+  "filterGroupSearchInputLabel": "Hledat možnosti {{title}}",
   "invalidRange": "Neplatný rozsah",
   "max": "Max",
   "min": "Min",
@@ -37,26 +40,31 @@
   "readMoreAbout": "Přečíst si více o <a>{{name}}</a>",
   "recentSearch": "nedávné vyhledávání: {{query}}",
   "recentSearchesFound_few": "Nalezena {{count}} nedávná hledání.",
+  "recentSearchesFound_many": "Nalezeno {{count}} nedávných hledání.",
   "recentSearchesFound_one": "Nalezeno {{count}} nedávné hledání.",
   "recentSearchesFound_other": "Nalezeno {{count}} nedávných hledání.",
   "removeFilter": "Odebrat filtr „{{displayName}}“",
   "resultPreview": "náhled výsledků: {{value}}",
   "resultPreviewsFound_few": "Nalezeny {{count}} náhledy výsledků.",
+  "resultPreviewsFound_many": "Nalezeno {{count}} náhledů výsledků.",
   "resultPreviewsFound_one": "Nalezen {{count}} náhled výsledku.",
   "resultPreviewsFound_other": "Nalezeno {{count}} náhledů výsledků.",
   "resultsCountText_few": "{{count}} výsledky",
+  "resultsCountText_many": "{{count}} výsledků",
   "resultsCountText_one": "{{count}} výsledek",
   "resultsCountText_other": "{{count}} výsledků",
   "resultsCountWithPaginationText": "{{paginateStart}} – {{paginateEnd}} z {{resultsCount}} výsledků",
   "searchHere": "Hledejte zde…",
+  "showingAllInstead": "Místo toho zobrazujeme všechny {{currentVerticalLabel}}.",
   "showLess": "Zobrazit méně",
   "showMore": "Zobrazit více",
-  "showingAllInstead": "Místo toho zobrazujeme všechny {{currentVerticalLabel}}.",
   "sources_few": "Zdroje ({{count}})",
+  "sources_many": "Zdroje ({{count}})",
   "sources_one": "Zdroj",
   "sources_other": "Zdroje ({{count}})",
   "submitSearch": "Odeslat vyhledávání",
   "suggestionResultsCount_few": "{{label}} – {{count}} výsledky",
+  "suggestionResultsCount_many": "{{label}} – {{count}} výsledků",
   "suggestionResultsCount_one": "{{label}} – {{count}} výsledek",
   "suggestionResultsCount_other": "{{label}} – {{count}} výsledků",
   "thankYouForYourFeedback": "Děkujeme za vaši zpětnou vazbu!",

locales/da/search-ui-react.json

@@ -22,6 +22,7 @@
   "didYouMean": "Mente du <button>{{correctedQuery}}</button>",
   "dropDownScreenReaderInstructions": "Når autoudfyldningsresultater er tilgængelige, brug pil op/ned for at gennemgå og Enter for at vælge.",
   "feedback": "Feedback",
+  "filterGroupSearchInputLabel": "Søg i valgmuligheder for {{title}}",
   "invalidRange": "Ugyldigt rækkevidde",
   "max": "Maks",
   "min": "Min",
@@ -43,9 +44,9 @@
   "resultsCountText_other": "{{count}} resultater",
   "resultsCountWithPaginationText": "{{paginateStart}} - {{paginateEnd}} af {{resultsCount}} resultater",
   "searchHere": "Søg her…",
+  "showingAllInstead": "Viser i stedet alle {{currentVerticalLabel}}.",
   "showLess": "Vis mindre",
   "showMore": "Vis mere",
-  "showingAllInstead": "Viser i stedet alle {{currentVerticalLabel}}.",
   "sources_one": "Kilde",
   "sources_other": "Kilder ({{count}})",
   "submitSearch": "Indsend søgning",

locales/de/search-ui-react.json

@@ -22,6 +22,7 @@
   "didYouMean": "Meinten Sie <button>{{correctedQuery}}</button>",
   "dropDownScreenReaderInstructions": "Wenn Autovervollständigungsergebnisse verfügbar sind, mit Pfeiltasten navigieren und mit Enter auswählen.",
   "feedback": "Rückmeldung",
+  "filterGroupSearchInputLabel": "Optionen für {{title}} durchsuchen",
   "invalidRange": "Ungültiger Bereich",
   "max": "Max",
   "min": "Min",
@@ -43,9 +44,9 @@
   "resultsCountText_other": "{{count}} Ergebnisse",
   "resultsCountWithPaginationText": "{{paginateStart}}–{{paginateEnd}} von {{resultsCount}} Ergebnissen",
   "searchHere": "Suche hier…",
+  "showingAllInstead": "Zeige stattdessen alle {{currentVerticalLabel}} an.",
   "showLess": "Weniger anzeigen",
   "showMore": "Mehr anzeigen",
-  "showingAllInstead": "Zeige stattdessen alle {{currentVerticalLabel}} an.",
   "sources_one": "Quelle",
   "sources_other": "Quellen ({{count}})",
   "submitSearch": "Suche einreichen",