Class SearchBar

A search input field with a magnifying glass icon that allows users to enter search queries.

Inheritance
object
CallbackEventHandler
Focusable
VisualElement
BaseVisualElement
ExVisualElement
TextField
SearchBar
Implements
Inherited Members
VisualElement.Focus()
VisualElement.Overlaps(Rect)
VisualElement.ToString()
VisualElement.TryGetBinding(BindingId, out Binding)
VisualElement.TryGetDataSourceContext(BindingId, out DataSourceContext)
VisualElement.TryGetLastBindingToUIResult(in BindingId, out BindingResult)
VisualElement.TryGetLastBindingToSourceResult(in BindingId, out BindingResult)
VisualElement.GetFirstOfType<T>()
VisualElement.GetFirstAncestorOfType<T>()
VisualElement.canGrabFocus
VisualElement.focusController
VisualElement.cacheAsBitmap
CallbackEventHandler.RegisterCallback<TEventType>(EventCallback<TEventType>, TrickleDown)
CallbackEventHandler.RegisterCallbackOnce<TEventType>(EventCallback<TEventType>, TrickleDown)
CallbackEventHandler.RegisterCallback<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, TUserArgsType, TrickleDown)
CallbackEventHandler.RegisterCallbackOnce<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, TUserArgsType, TrickleDown)
CallbackEventHandler.RegisterCallback<TEventType>(EventCallback<TEventType>, CallbackOptions)
CallbackEventHandler.RegisterCallback<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, TUserArgsType, CallbackOptions)
CallbackEventHandler.UnregisterCallback<TEventType>(EventCallback<TEventType>, TrickleDown)
CallbackEventHandler.UnregisterCallback<TEventType>(EventCallback<TEventType>, CallbackOptions)
CallbackEventHandler.UnregisterCallback<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, TrickleDown)
CallbackEventHandler.UnregisterCallback<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, CallbackOptions)
CallbackEventHandler.NotifyPropertyChanged(in BindingId)
Namespace: Unity.AppUI.UI
Assembly: Unity.AppUI.dll
Syntax
[UxmlElement]
public class SearchBar : TextField, IEventHandler, IResolvedStyle, ITransform, ITransitionAnimations, IExperimentalFeatures, IVisualElementScheduler, IContextOverrideElement, IAdditionalDataHolder, IInputElement<string>, IValidatableElement<string>, INotifyValueChanging<string>, INotifyValueChanged<string>
Remarks

The SearchBar component is a specialized TextField that provides a dedicated interface for search functionality. It comes with a built-in magnifying glass icon and placeholder text, making it instantly recognizable as a search input.

By default, the SearchBar displays a magnifying glass icon on the left side and includes a 'Search...' placeholder text, providing clear affordance for its purpose.

The SearchBar inherits from TextField, which means it includes all TextField functionality including validation, size variants, and read-only states.

SearchBars are commonly used in:

  • Navigation menus to filter items
  • Data tables to search through records
  • Document libraries to find specific files
  • Any interface where users need to search through content
Examples

Basic Usage

// Creating a basic search bar
var searchBar = new SearchBar();
searchBar.RegisterValueChangedCallback(evt => {
    Debug.Log($"Search query: {evt.newValue}");
});

Search with Validation

var searchBar = new SearchBar();
// Add validation to ensure minimum search length
searchBar.validateValue = (value) => value.Length >= 3;
searchBar.placeholder = "Enter at least 3 characters...";

UXML Usage

<ui:UXML xmlns:ui="UnityEngine.UIElements" xmlns:appui="Unity.AppUI.UI">
    <appui:SearchBar size="M"
                     placeholder="Search documents..."
                     leading-icon-name="magnifying-glass" />
</ui:UXML>

Complete Search Implementation

public class SearchableList : VisualElement
{
    private SearchBar searchBar;
    private ListView listView;
    private List<string> allItems;

public SearchableList()
{
    // Create and configure search bar
    searchBar = new SearchBar();
    searchBar.placeholder = "Search items...";
    searchBar.size = Size.M;

    // Handle search input
    searchBar.RegisterValueChangedCallback(OnSearchQueryChanged);

    // Add to visual hierarchy
    Add(searchBar);

    // Initialize list view...
}

private void OnSearchQueryChanged(ChangeEvent<string> evt)
{
    var query = evt.newValue.ToLower();
    var filteredItems = allItems
        .Where(item => item.ToLower().Contains(query))
        .ToList();
    listView.itemsSource = filteredItems;
}



}

Constructors

SearchBar()

Default Constructor.

Declaration
public SearchBar()

Fields

ussClassName

The SearchBar main styling class.

Declaration
public const string ussClassName = "appui-searchbar"
Field Value
Type Description
string

Implements

Extension Methods