Description

Search enables users to find relevant content in a list or dataset, by specifying a word, phrase or query

Types

Type	Description	Example
Live Search	Live search (aka "active search", “incremental search” or “search-as-you-type”) is a search type in which each character that the user enters or deletes runs the search query. This type is usually suitable for small-medium databases
Search with auto-suggest	In this search type the system autosuggest terms as the user types 2 or more characters. The search itself is being conducted only after manually running it (by selecting a suggestion, clicking "search" or 'Enter'). This type of search is usually suitable for complex and big database search

Usage & Behaviour

General Guidlines

Structure

Magnifier icon: placed at the right area of text field. In Search with Auto-Suggest the user may click the magnifier icon button to initiate the search. In Live Search the magnifier icon functions as an additional indicator to the search input field.
Hint and text input: left-aligned.
'x' icon (clear): added and aligned to the magnifier icon.

Content

Empty search field includes a hint text.
The hint text must start with the word 'Search' to indicate the search functionality.
The next word/s should provide helpful context and imply the results type (e.g. 'search employee', 'search custom data field').

Length

The search field should be in the minimum width of 27 characters.

Internal Logic

Clear All

“Clear all” is presented using an "x" icon.
The "x" is presented after the first character is typed, and disappears when the text is cleared (both manually or using the "x" button)
Clicking the "x" will: (1) delete all characters (2) focus on the text field, so that new search term can be entered.

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:

“Contains”: the search string may appear within a result.

Select the appropriate approach according to:

The users' knowledge and expected behaviour: do they know the full name of the item? how familiar they are with the list terminology and the structure of each item?
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 “type-ahead” approach should be the default approach, yet 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.

String Highlight

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

Exceptions- an additional background color will be added to the bold string in these cases:

Searched items are presented in bold within the list of result (regardless of the search string)
There are other (non-searchable) bold items within the set of results that may cause confusion (e.g. bold titles in an hierarchical view)

Suggestions (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
The list will include recent searches and/or popular/trending searches.
- Recent item are items that the specific user searched for in the past. They will be presented only after conducting at list one search and will include the most recent searches only.
- Popular items are items that are being searched by many users in many occasions
- 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
Each item will be accompanied with an icon, indicating the type of suggestion (recent or popular)

Use the suggestion list only if the user is expected to search for previously searched queries or popular/trending queries.

Search Query

The search query should NOT be case sensitive (e.g. search for “RAR” is equal to “rar”, “Rar”, “RaR”, etc.)
Using 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 on lists of names (e.g. employees, 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			TBD
Hover			TBD
Active			TBD
Disabled		-	TBD
Error Applies to “search with auto-suggest” only - TBD (See Field Validation for more details)	-	-
Focused			TBD
Focused hover			TBD
Focused active			TBD

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)

Best Practice

Use when:
- The searched list has more than 10 items.
- Users are looking for specific items and know, to some extent, how to look for it (e.g. when supervisors are looking for their agents in a list).
Don’t use when:
- The searched list has 10 items or less.
- The user wants to browse through the data or to look for datasets, and is not looking for specific items (in this case use filters)
- The user doesn’t know what he’s looking for

Accessibility compliance

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

Design

Zeplin link	Screen thumbnail
https://zpl.io/25Gz0na

Code

As per each individual search type.