...
The search field should have a minimum width of 27 characters.
Internal Logic
...
Search Query
The X button appears after the first character is typed, and disappears when the text is cleared (either manually or by clicking the X button).
Clicking the X button will:
delete all characters.
focus on the text field, so that new search term can be enteredSpaces in the query:
Spaces are included in the search string. For example, when searching “repeated c” the result “repeated calls” may be found.
When searching a list of names (such as employees or agents), the space may be addressed as a separator between 2 distinct searches. For example, when searching “sh kl” the employee “Shiri Klein” may be found.
The search query should not be case sensitive. For example, searching for RAR is equal to rar, Rar, or RaR etc.)
Search logic
2 types of search logic may be applied, according to the specific needs:
Type-ahead: all results will start with the typed string. For example:
Contains: the search string may appear anywhere within a result. For example:
Type-ahead should be the default approach. However, consider using the contains approach when:
The user is not familiar with the list terminology or the full name of the item.
The list includes complex items, such as agent names or combinations of numbers and strings.
String Highlight
The searched string is highlighted in bold within the list of results:
An additional background color will be added to the bold string in these cases:
When the searched items are already presented in bold within the list of results.
Where there are other, non-searchable bold items within the set of results list, such as bold headers in a hierarchical list, that may cause confusion.
Clear All
The X button appears after the first character is typed, and disappears when the text is cleared (either manually or by clicking the X button).
Clicking the X button will:
delete all characters.
focus on the text field, so that new search term can be entered.
Recent / Popular Searches (optional)
When an empty search field is
...
in focus, a list of recent or popular/trending suggestions may be displayed to enable the user to conduct a quick search.
The suggestions list will include up to 8 items.
Recent items are strings that the specific user has searched for in the past. They will be presented only after the user has conducted at least one previous search, and will include the most recent searches only.
Popular items are strings that are being frequently searched by a lot of users.
Trending items are strings that are being frequently searched by a lot of users, within a recent time frame.
The number of recent and popular/trending items should be equal, unless there’s not enough data to provide an equal amount of both types. In this case the list may be divided unequally.
Recent items will be placed above popular/trending items.
Each item will be accompanied by an icon, indicating the type of suggestion (recent or popular/trending).
Use
...
this component only if the user is expected to search for previously searched queries or popular/trending queries.
...
The search query should not be case sensitive. For example, searching for RAR is equal to rar, Rar, or RaR etc.)
Spaces in the query:
Spaces are included in the search string. For example, when searching “repeated c” the result “repeated calls” may be found.
When searching a list of names (such as employees or agents), the space may be addressed as a separator between 2 distinct searches. For example, when searching “sh kl” the employee “Shiri Klein” may be found.
States
State | Empty | Filled - Live Search | Filled - Search with auto-suggest | ||
---|---|---|---|---|---|
Regular | Coming soon… | ||||
Hover | Coming soon… | ||||
Active | Coming soon… | ||||
Disabled | -N/A | Coming soon… | |||
Error Only applies to Search with Auto-suggest (See Field Validation for more details). | - | - | N/A | N/A | Coming soon… |
Focused | Coming soon… | ||||
Focused, Hover | Coming soon… | ||||
Focused, Active | Coming soon… |
Interaction
Varies per each search type. See Live Search and Search with Auto-suggest.
Validations and Errors
Varies per each search type. See Live Search and Search with Auto-suggest.
...
the searched list has 10 items or fewer.
the user wants to browse through the data or to look for datasets, and is not looking for specific items → use Filters.
users are unlikely to know what they’re looking for
General
Accessibility compliance
Unless otherwise specified, see our general compliance information in Fundamentals - Accessibility.
Design
As per each individual search typeSee Live Search and Search with Auto-suggest.
Code
As per each individual search typeSee Live Search and Search with Auto-suggest.