Xamarin.Forms SearchBar

Download Sample Download the sample

The Xamarin.Forms SearchBar is a user input control used to initiating a search. The SearchBar control supports placeholder text, query input, search execution, and cancellation. The following screenshot shows a SearchBar query with results displayed in a ListView:

Screenshot of SearchBar on iOS and Android

The SearchBar class defines the following properties:

  • CancelButtonColor is a Color that defines the color of the cancel button.
  • CharacterSpacing, of type double, is the spacing between characters of the SearchBar text.
  • FontAttributes is a FontAttributes enum value that determines whether the SearchBar font is bold, italic, or neither.
  • FontFamily is a string that determines the font family used by the SearchBar.
  • FontSize can be a NamedSize enum value or a double value that represents specific font sizes across platforms.
  • HorizontalTextAlignment is a TextAlignment enum value that defines the horizontal alignment of the query text.
  • VerticalTextAlignment is a TextAlignment enum value that defines the vertical alignment of the query text.
  • Placeholder is a string that defines the placeholder text, such as "Search...".
  • PlaceholderColor is a Color that defines the color of the placeholder text.
  • SearchCommand is an ICommand that allows binding user actions, such as finger taps or clicks, to commands defined on a viewmodel.
  • SearchCommandParameter is an object that specifies the parameter that should be passed to the SearchCommand.
  • Text is a string containing the query text in the SearchBar.
  • TextColor is a Color that defines the query text color.
  • TextTransform is a TextTransform value that determines the casing of the SearchBar text.

These properties are backed by BindableProperty objects, which means the SearchBar can be customized and be the target of data bindings. Specifying font properties on the SearchBar is consistent with customizing text on other Xamarin.Forms Text controls. For more information, see Fonts in Xamarin.Forms.

A SearchBar can be instantiated in XAML. Its optional Placeholder property can be set to define the hint text in the query input box. The default value for the Placeholder is an empty string so no placeholder will appear if it isn't set. The following example shows how to instantiate a SearchBar in XAML with the optional Placeholder property set:

<SearchBar Placeholder="Search items..." />

A SearchBar can also be created in code:

SearchBar searchBar = new SearchBar{ Placeholder = "Search items..." };

SearchBar appearance properties

The SearchBar control defines many properties that customize the appearance of the control. The following example shows how to instantiate a SearchBar in XAML with multiple properties specified:

<SearchBar Placeholder="Search items..."
           FontAttributes="Italic" />

These properties can also be specified when creating a SearchBar object in code:

SearchBar searchBar = new SearchBar
    Placeholder = "Search items...",
    PlaceholderColor = Color.Orange,
    TextColor = Color.Orange,
    TextTransform = TextTransform.Lowercase,
    HorizontalTextAlignment = TextAlignment.Center,
    FontSize = Device.GetNamedSize(NamedSize.Medium, typeof(SearchBar)),
    FontAttributes = FontAttributes.Italic

The following screenshot shows the resulting SearchBar control:

Screenshot of customized SearchBar on iOS and Android


On iOS, the SearchBarRenderer class contains an overridable UpdateCancelButton method. This method controls when the cancel button appears, and can be overridden in a custom renderer. For more information about custom renderers, see Xamarin.Forms Custom Renderers.

Perform a search with event handlers

A search can be executed using the SearchBar control by attaching an event handler to one of the following events:

  • SearchButtonPressed is called when the user either clicks the search button or presses the enter key.
  • TextChanged is called anytime the text in the query box is changed.

The following example shows an event handler attached to the TextChanged event in XAML and uses a ListView to display search results:

<SearchBar TextChanged="OnTextChanged" />
<ListView x:Name="searchResults" >

An event handler can also be attached to a SearchBar created in code:

SearchBar searchBar = new SearchBar {/*...*/};
searchBar.TextChanged += OnTextChanged;

The TextChanged event handler in the code-behind file is the same, whether the SearchBar is created via XAML or code:

void OnTextChanged(object sender, EventArgs e)
    SearchBar searchBar = (SearchBar)sender;
    searchResults.ItemsSource = DataService.GetSearchResults(searchBar.Text);

The previous example implies the existence of a DataService class with a GetSearchResults method capable of returning items that match a query. The SearchBar control's Text property value is passed to the GetSearchResults method and the result is used to update the ListView control's ItemsSource property. The overall effect is that search results are displayed in the ListView control.

The sample application provides a DataService class implementation that can be used to test search functionality.

Perform a search using a viewmodel

A search can be executed without event handlers by binding the SearchCommand and SearchCommandParameter properties to ICommand implementations. The sample project demonstrates these implementations using the Model-View-ViewModel (MVVM) pattern. For more information about data bindings with MVVM, see Data Bindings with MVVM.

The viewmodel in the sample application contains the following code:

public class SearchViewModel : INotifyPropertyChanged
    public event PropertyChangedEventHandler PropertyChanged;

    protected virtual void NotifyPropertyChanged([CallerMemberName] string propertyName = "")
        PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(propertyName));

    public ICommand PerformSearch => new Command<string>((string query) =>
        SearchResults = DataService.GetSearchResults(query);

    private List<string> searchResults = DataService.Fruits;
    public List<string> SearchResults
            return searchResults;
            searchResults = value;


The viewmodel assumes the existence of a DataService class capable of performing searches. The DataService class, including example data, is available in the sample application.

The following XAML shows how to bind a SearchBar to the example viewmodel, with a ListView control displaying the search results:

<ContentPage ...>
        <viewmodels:SearchViewModel />
    <StackLayout ...>
        <SearchBar x:Name="searchBar"
                   SearchCommand="{Binding PerformSearch}"
                   SearchCommandParameter="{Binding Text, Source={x:Reference searchBar}}"/>
        <ListView x:Name="searchResults"
                  ItemsSource="{Binding SearchResults}" />

This example sets the BindingContext to be an instance of the SearchViewModel class. It binds the SearchCommand property to the PerformSearch ICommand in the viewmodel, and binds the SearchBar Text property to the SearchCommandParameter property. The ListView.ItemsSource property is bound to the SearchResults property of the viewmodel.

For more information about the ICommand Interface and bindings, see Xamarin.Forms data binding and the ICommand interface.