Search

An implementation of a search component. The <FluentSearch> supports two visual appearances, outline and filled, with the control defaulting to the outline appearance.

<FluentSearch> wraps the <fluent-search> element, a web component implementation of a search element leveraging the Fluent UI design system.

Examples

Default

The search box with a label has autocomplete turned off explicitly by using the AutoComplete parameter

Example
Without a label:
Download: 

Interactive

Example

no results

You searched for:

Download: 

Interactive with debounce

Example

No results

You searched for:

Download: 

Immediate (with and without debounce)

Example

You searched for:

No results
Download: 

States

Example

Full Width

Placeholder

Required

Disabled

label

Read only

label
Download: 

Icons

Example

With start

With end

Download: 

Focus

Example

Autofocus

Commented out to prevent page actually jumping to this location. See example code below for implementation.

Focus Async

FocusAsync
Download: 

Filled style

Example

Default

label

Placeholder

Required

Disabled

label

Read only

label
Download: 

Miscellaneous

Example

Minlength

Minlength

Maxlength

Maxlength
Download: 

Documentation

FluentSearch Class

Inherits from FluentInputBase<string?>.
There might be parameters and/or methods shown here that are inherited from the component's base type but are not applicable to this component.

Parameters

Name
Type
Default
Description
AppearanceFluentInputAppearance
Outline
Gets or sets the visual appearance. See Appearance
AriaLabelstring?
Gets or sets the text used on aria-label attribute.
AutoCompletestring?
Gets or sets whether a form or an input field should have autocomplete 'on' or 'off' or another value.
Autofocusbool
False
Determines if the element should receive document focus on page load.
ChildContentRenderFragment?
Gets or sets the content to be rendered inside the component.
DataListstring?
Allows associating a datalist to the element by id.
Disabledbool
False
Disables the form control, ensuring it doesn't participate in form submission.
DisplayNamestring?
Gets or sets the display name for this field.
This value is used when generating error messages when the input value fails to parse correctly.
Embeddedbool
False
Gets or sets if the derived component is embedded in another component.
If true, the ClassValue property will not include the EditContext's FieldCssClass.
FieldFieldIdentifier?
Gets or sets the FluentInputBase.FieldIdentifier that identifies the bound value.
If set, this parameter takes precedence over FluentInputBase.ValueExpression.
Immediatebool
False
Change the content of this input field when the user write text (based on 'OnInput' HTML event).
ImmediateDelayint
0
Gets or sets the delay, in milliseconds, before to raise the FluentInputBase.ValueChanged event.
Labelstring?
Gets or sets the text to label the input.
This is usually displayed just above the input
LabelTemplateRenderFragment?
Gets or sets the content to label the input component.
This is usually displayed just above the input
Maxlengthint?
Gets or sets the maximum number of characters a user can enter.
Minlengthint?
Gets or sets the minimum number of characters a user can enter.
Namestring?
Gets or sets the name of the element.
Allows access by name from the associated form.
⚠️ This value needs to be set manually for SSR scenarios to work correctly.
Patternstring?
Gets or sets a regular expression that the value must match to pass validation.
Placeholderstring?
Gets or sets the short hint displayed in the input before the user enters a value.
ReadOnlybool
False
When true, the control will be immutable by user interaction. readonly HTML attribute for more information.
Requiredbool
False
Gets or sets a value indicating whether the element needs to have a value.
Sizeint?
Gets or sets the size of the text field.
Spellcheckbool?
Gets or sets the if spellcheck should be used.
Valuestring?
Gets or sets the value of the input. This should be used with two-way binding.
ValueExpressionExpression<Func<string>>?
Gets or sets an expression that identifies the bound value.

EventCallbacks

Name
Type
Description
ValueChangedEventCallback<string>
Gets or sets a callback that updates the bound value.

Methods

Name
Parameters
Type
Description
FocusAsyncvoid
Exposes the elements FocusAsync(bool preventScroll) method.
FocusAsyncbool preventScroll
void
Exposes the elements FocusAsync(bool preventScroll) method.
Filled
Outline
An error has occurred. This application may no longer respond until reloaded. Reload 🗙