Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 19 additions & 0 deletions docs/search-ui-react.facetsprops.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,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.facetsprops.showoptionssearchinputlabel.md)


</td><td>


</td><td>

boolean


</td><td>

_(Optional)_ Whether or not to display the options search input label visibly on facets that render an options search input. Defaults to false, and is overridden by the same prop on a child facet.


</td></tr>
</tbody></table>

18 changes: 18 additions & 0 deletions docs/search-ui-react.facetsprops.showoptionssearchinputlabel.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<!-- 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; [FacetsProps](./search-ui-react.facetsprops.md) &gt; [showOptionsSearchInputLabel](./search-ui-react.facetsprops.showoptionssearchinputlabel.md)

## FacetsProps.showOptionsSearchInputLabel property

Whether or not to display the options search input label visibly on facets that render an options search input. Defaults to false, and is overridden by the same prop on a child facet.

**Signature:**

```typescript
showOptionsSearchInputLabel?: boolean;
```

## Remarks

The label is always associated with the search input so that it has an accessible name. When false, the label is visually hidden but remains available to assistive technology. Hierarchical facets do not render an options search input, so this has no effect on them.

2 changes: 1 addition & 1 deletion docs/search-ui-react.filtergroupprops.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ boolean

</td><td>

_(Optional)_ Whether or not to display the visible search input label. Defaults to false.
_(Optional)_ Whether or not to display the search input label visibly. Defaults to false.


</td></tr>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,15 @@

## FilterGroupProps.showOptionsSearchInputLabel property

Whether or not to display the visible search input label. Defaults to false.
Whether or not to display the search input label visibly. Defaults to false.

**Signature:**

```typescript
showOptionsSearchInputLabel?: boolean;
```

## Remarks

The label is always associated with the search input so that it has an accessible name. When false, the label is visually hidden but remains available to assistive technology.

2 changes: 1 addition & 1 deletion docs/search-ui-react.standardfacetprops.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ boolean

</td><td>

_(Optional)_ Whether or not to show the label for the search bar when present. Defaults to false.
_(Optional)_ Whether or not to display the search input label visibly. Defaults to false.


</td></tr>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,15 @@

## StandardFacetProps.showOptionsSearchInputLabel property

Whether or not to show the label for the search bar when present. Defaults to false.
Whether or not to display the search input label visibly. Defaults to false.

**Signature:**

```typescript
showOptionsSearchInputLabel?: boolean;
```

## Remarks

The label is always associated with the search input so that it has an accessible name. When false, the label is visually hidden but remains available to assistive technology.

2 changes: 1 addition & 1 deletion docs/search-ui-react.staticfiltersprops.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ boolean

</td><td>

_(Optional)_ Whether or not to display the visible search input label. Defaults to false.
_(Optional)_ Whether or not to display the search input label visibly. Defaults to false.


</td></tr>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,15 @@

## StaticFiltersProps.showOptionsSearchInputLabel property

Whether or not to display the visible search input label. Defaults to false.
Whether or not to display the search input label visibly. Defaults to false.

**Signature:**

```typescript
showOptionsSearchInputLabel?: boolean;
```

## Remarks

The label is always associated with the search input so that it has an accessible name. When false, the label is visually hidden but remains available to assistive technology.

3 changes: 2 additions & 1 deletion etc/search-ui-react.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -262,6 +262,7 @@ export interface FacetsProps {
hierarchicalFieldIds?: string[];
onlyRenderChildren?: boolean;
searchOnChange?: boolean;
showOptionsSearchInputLabel?: boolean;
}

// @public
Expand Down Expand Up @@ -1174,7 +1175,7 @@ export interface VisualAutocompleteConfig {

// Warnings were encountered during analysis:
//
// dist/index.d.ts:1921:5 - (ae-forgotten-export) The symbol "translations" needs to be exported by the entry point index.d.ts
// dist/index.d.ts:1934:5 - (ae-forgotten-export) The symbol "translations" needs to be exported by the entry point index.d.ts

// (No @packageDocumentation comment for this package)

Expand Down
Loading
Loading