Lead: Shani Laendler (Unlicensed)
| Status | ||||
|---|---|---|---|---|
|
| Table of Contents |
|---|
Description
Live search (aka "active search ", “incremental search” or “search-as-you-type”) is a search type in which 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
Search logic
2 search approaches may be applied (should be considered according to the specific need):
...
“Type-ahead”: all results will start with the typed string. For example:
...
...
...
Select the appropriate approach according to:
The users' knowledge and expected behavior: do they know the full name of the item? how familiar they are with the list terminology and content?
The list content and design: does it include complex items (e.g. agents names?)? does it have a complex design (e.g. a combination of numbers and strings)?
The more complex the list is, and the less knowledge the user have, tend to choose the “contain” approach to provide more flexibility to the user.
...
Results Presentation
The searched string will be highlighted in bold within the textlist of results.
The results are displayed in the results list area according to the existing sort method.
In case Where the items list area is arranged in an a hierarchical viewtree:
The the search results will usually also be displayed presented in the same hierarchical view as well:
...
In some cases the search results should be displayed as a flat list, and not in hierarchical view. See 'Best Practices' section for guidelines on selecting the appropriate approach.
.
the user will be able to search on all hierarchies, unless otherwise specified.
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 secondseconds: no loader is needed.
0.1 - 5 second:
Option 1: loading spinnerseconds: use a circular Progress Indicator with the text
"Searching <Categories>...
"
Option 2: loader within the field and list area as a placeholder for the results (consider Asaf’s use cases where there are several loading areas in the results area)
More than 5 seconds: this loading time is too long for “Live Search”. Use Manual Search Live Search → use Search with Auto-Suggest instead.
...
(Optional)
...
When focusing on an empty search field, a list of suggestions may be displayed to aid the user conduct a quick search.
List definitions:
The list will include up to 8 items
Each item will be accompanied with an icon
The list will include recent searches and/or popular/trending searches.
Recents will be presented only after conducting at list one search. They will include the most recent searches only.
Popular items are items that are being searched by many users in many occasions (make sure to collect this information from the relevant database. For example, include searches that were conducted on the specific project only)
Trending item are items that are being searched by many users in many occasions, on a recent defined time frame.
The number of recent and popular/trending items should be equal. If there’s not enough data to provide an equal amount of both types the list may be divided unequally.
Recent items will be placed above popular/trending items
...
Delay trigger of initial search until at least 3 characters have been entered to improve performance.
...
Interaction
Step | Visual Example | Description |
|---|---|---|
Initial state |
 |
|
Hover over the search field
|
Click on the |
Suggestions:  |
|
Hint text presented
Text mark is flickering
|
|
Enter first letter |
 |
|
|
|
Enter next |
letters |
 |
|
Click on item in the list
Focus is moved away from the search field
Clear all
Click on the “x”: (1) clears all characters (2) focus on the text field, so that new search term can be entered.
The "x" disappears when the text is cleared (both manually or using the "x" button)
Best Practice
Automatic focus: use auto-focus on the search field to aid the user in conducting a fast search (and reduce clicks). Make sure to use it under these conditions:
...
| ||
Clear all |  |
|
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 (coming soon).
General
In case the list is the main component presented in the area or section of the interface (e.g. in a filter panel or in a modal window)
...
,
...
...
Display results in an hierarchical tree view vs. flat list: the results may be presented in both list types. Use these questions to select the most appropriate type:
Is the search expected to produce a single or multiple results? (if single than list is probably good enough)
May several results have a similar name? (if yes, tend to choose a tree view)
What will help to differentiate between items with similar name? (will it be the root?)
Will the root be searched by itself?
In case the results are presented in tree view, all roots will be auto-expanded to present the searched item.
...
Use:
<…>
<…>
Don’t use
...
When the query is applied on a complex or big database that will cause a long loading time. Use Manual Search (with Auto-Suggest) instead
...
the focus will be set to the search field automatically to aid the user in conducting a fast search.
Accessibility compliance
Unless otherwise specified, see our general compliance information in Fundamentals - Accessibility.
Design
See Search
Code
See Search