@spartanfx/react v1.2.2
@spartanfx/react / index / IExtendedSearchBoxProps
Interface: IExtendedSearchBoxProps
Props for the ExtendedSearchBox component.
Properties
Required
| Property | Type | Default | Description |
|---|
onChange | (newValue) => void | - | Callback triggered when a new search value is submitted or cleared. |
Options
| Property | Type | Default | Description |
|---|
ariaLabel? | string | - | Aria label for accessibility. |
disabled? | boolean | false | Whether the component is disabled. |
fullWidth? | boolean | false | If true, allows the search input to expand to fill available horizontal space. |
placeholder? | string | 'Search...' | Placeholder text for the search box. |
searchType? | SearchTypes | SearchTypes.searchByText | The current search mode (searchByText or searchById). |
showSearchTypeMenu? | boolean | true | Whether to show the search type dropdown menu. |
Events & callbacks
| Property | Type | Default | Description |
|---|
translate? | (text) => string | - | Optional localization function to translate UI strings. |
Advanced & escape hatches
| Property | Type | Default | Description |
|---|
buttonProps? | IButtonProps | - | Optional props passed to the Fluent UI PrimaryButton. |
searchBoxProps? | ISearchBoxProps | - | Optional props passed directly to the underlying Fluent UI SearchBox. |