Skip to end of banner
Go to start of banner

Live Search

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 33 Next »

Description

Live search is a type of Search where each character that the user enters or deletes runs the search query. This type of search is usually suitable for small-medium databases.

Live search is also known as Active search, Incremental search or Search-as-you-type.

Usage and Behavior

General Guidelines

Internal Logic

Results Presentation

  • The searched string will be highlighted in bold within the list of results.

  • The results are displayed in the results list according to the existing sort method.

  • Where the list items are arranged in a hierarchical tree, the search results may be presented in either the same hierarchical view or as a simple list. See Best Practices below for guidelines on selecting the appropriate approach.

    • If the results are presented in a hierarchical view, all sections will be auto-expanded to show the searched items.

Example of a hierarchical view in the results list:

  • Where needed (and possible), consider presenting the number of results in a prominent area, particularly for larger or more complex results lists.

Results Loading Time

The system should mitigate long loading times.

  • Less than 0.1 seconds: no loader is needed.

  • 0.1 - 5 seconds: use a circular Progress Indicator with the text Searching <Categories>...

  • More than 5 seconds: this loading time is too long for Live Search → use Search with Auto-Suggest instead.

Interaction

Step

Visual Example

Description

Initial state

  • Guiding / hint text in grey.

Click on the Text Field

  • Search is in focus.

  • The guiding / hint text is hidden.

  • The text cursor is blinking.

  • (Optional) It is recommended that a suggestions list with recent and/or popular queries are used. See Search for more information.

Enter first letter

  • Suggestions are hidden (where used).

  • The list is filtered.

  • The searched string is highlighted in bold within the list of results.

  • A Clear All icon button (X) appears.

Enter next letters

  • The list is filtered to show relevant results.

Clear all
(either manually or clicking the X button)

  • Characters are cleared.

  • The focus is set on the text field.

  • The X button disappears.

Validations and errors

There are no validations on the search string.

No results found

  • The results area will clearly state that no results were found.

  • The text will say No <items> were found. For example No categories were found or No employees were found.

Best Practice

Use when:

  • the database is small-medium size.

  • the results can be filtered immediately, with no need to retrieve the data from the backend.

  • the results list is located below and near the search field.

Don’t use when the query is applied to a complex or large database that will cause a long loading time → use Search with Auto-Suggest.

Automatic focus

  • Use auto-focus on the search field to aid the user in conducting a fast search, and to reduce clicks. Make sure to use it under these conditions:

    • The list is the only or main component presented in the area or section of the interface, e.g. in a filter panel or in a modal window.

    • The list is presented upon request, e.g. on clicking to open filter panel, or clicking to open modal window.

  • Where the list items are arranged in a hierarchical tree, the search results may be presented in either the same hierarchical view or as a simple list. See Best Practices below for guidelines on selecting the appropriate approach.

    • If the results are presented in a hierarchical view, all sections will be auto-expanded to show the searched items.

Hierarchical tree view vs. simple list

Where the list items are arranged in a hierarchical tree, the search results may be presented in either the same hierarchical view or as a simple list. Select the most appropriate type:

  • Is the search expected to produce a single or multiple results?

    • If the search is expected to produce a single result → a simple list may be sufficient.

    • If the search is expected to produce multiple results → use the hierarchical tree view where appropriate.

  • If several results may have a similar name and the parent category may help in differentiating between results → use the hierarchical tree view.

  • If the parent category may be searched itself → use the hierarchical tree view.

Accessibility compliance

Unless otherwise specified, see our general compliance information in Fundamentals - Accessibility.

Design

Zeplin link

Screen thumbnail

https://zpl.io/25Gz0na

Code

  • No labels