Lead:  Liav Nadler Asaf Ben-Oved  ONGOING

Description

A filter pane is a panel located on the left side of a page, allowing users to filter the presented data set by a variety of parameters

Basic Flow

• The filter pane contains two areas: the filter bar and the filter panel

• On the relevant pages, the filter bar is always shown

• The filter panel has two states:

  • Unpinned (default) - the panel overlays the content

  • Pinned - the panel pushes the content so nothing is hidden

• In some cases, active filters are represented by chicklets, appearing at the top of the data set

• A set of filters can behave in one of three ways:

  • Faceted filters - the filters are sorted by importance or popularity. Applying a filter affects the number of results shown on other filters

  • Funnel - the filters are ordered by hierarchy. Applying a parent filter will affect child filters, but applying a child filter will not affect parents filters

  • Independent filters - applying a filter does not affect other filters (not recommended)

• An application may have a similar set of filters across related workspaces. In this case, applying a filter on one workspace will affect the same filter on the related workspaces

• For more information see The Filter Bar, The Filter Panel and The Chicklet Bar below

Types

• In addition to the basic type described below, the filter pane can have these other types:

The Filter Bar

Structure

• The filter bar contains one or more tabs

• Each tab consists of an icon and a title (e.g. Employees)

Placement and Positioning

• The filter bar sticks to the left side of the page

• The background of the bar stretches from the page header to the bottom of the page

• The width of the bar is fixed

• The group of tabs is aligned to the top of the bar

States

• Each tab can have one of these states:

• In addition, if the data set is already filtered, a blue dot will appear next to the the relevant tabs

Default State

• By default no tabs are selected

Interaction

• Clicking a tab:

  • Switches the tab to the selected state

  • Unselects any other selected tabs

  • If the filter panel is unpinned - opens the relevant filter panel in overlay mode, hiding the content behind it

  • If it’s pinned - switches to the relevant panel

The Filter Panel

Structure

• The filter panel contains the following elements:

  • At the top:

    • A title, similar to the filter’s name on the filter bar

    • A pin icon, allowing the user to switch between pinned and unpinned states

    • A help icon (optional)

  • The area under the title is the main content area of the panel. See content below

  • The bottom of the panel may contain the following elements:

    • An Apply button (mandatory, unless the panel contains only one action)

    • An indicator showing the number of selected items (e.g. 4 queues selected)

    • A Cancel button

    • A Clear button

Placement and Positioning

• The filter panel will be attached to the right side of the filter bar

• The width of the panel is fixed

Content

• The main content area of the panel can hold either a form, a list or a combination of the two

• The content area may have a variety of layouts. see common examples below

Interaction

• Clicking the pin icon:

  • When pinned:

    • Switches the icon to unpinned

    • Closes the panel

    • Stretches the main area of the page to take the place of the closed panel

    • In case the panel’s content was updated but the filter was not applied, a toast will appear, informing the user that the changes were not saved

  • When unpinned:

    • Switches the icon to pinned

    • Narrows the main area of the page to be shown next to the panel (so nothing is hidden)

  • Note: pinning and unpinning a panel will pin/unpin all other panels simultaneously

• Clicking the help icon will open a relevant help page in a new tab

• Clicking outside the panel:

  • If changes were made but the filter was not applied, a toast will appear, informing the user that the changes were not saved

  • If unpinned - closes the panel

• Clicking the Apply button:

  • Applies the filter to the data set

  • Shows a blue indicator next to the relevant tab on the filter bar

  • If relevant - adds a chicklet to the chicklet bar (see below)

  • If unpinned - closes the panel

• Clicking the Cancel button will:

  • When unpinned - close the panel without saving any changes

  • When pinned?

• Clicking the Clear button will reset the panel content to default values

Validations and errors

• For validations within a form see Field Validation

Transitions

• The filter pane will open and close with a brief slide effect

Best Practices

• Opening a panel containing a blank form will set the focus to the first field of the form

The Chicklet Bar

General Guidelines

• Chicklets gives the user an indication that the data set is currently filtered by one or more filters

• There are two types of chicklets:

  • Pre-defined - The user can change their value but cannot remove them (for example, when filtering by a single organization is mandatory)

  • Optional - the user can add, update and delete the chicklet

Structure

• The chicklet bar stretched to the full width of its container

• The bar may contain any number of items. In case items doesn’t fit in a single row, the bar will expand to the next row

• Each chicklet contains:

  • An icon, similar to the relevant icon on the filter bar

  • A label, showing the filter value (e.g. Last 24 hours) multiple selection?

  • If the chicklet is optional - a closing icon (x), allowing the user to remove the filter

Placement and Positioning

• The chicklet bar appears on the main area of the page, above the data set

• In case the chicklet bar has no item it will be hidden. Adding the first item will show the bar, pushing all the content below it

• Pre-defined chicklets will be the first items on the bar. Other items will appear in the order they were added (in the order shown on the chicklet bar?)

• In case the set of chicklets exceeds the width of the chicklet bar’s container, it will wrap to another row

Interaction

• Clicking a chicklet:

  • When the filter panel is pinned: switches the panel to the selected filter

  • When unpinned: opens the relevant filter panel

• Clicking the x icon:

  • Hides the chicklet

  • Removes the relevant filter

  • Remove the relevant blue indicator from the filter bar

Best Practices

• When to use

  • When a major data set ( a table or a grid) is shown in the page and there is a need to filter it by one or more parameters

  • When dealing with complex filtering or with a large number of filters

• When not to use

  • When the data set is presented in a dialog or details pane

Common Examples

Future Version (TBD)

< Edge cases, uncertain aspects, incomplete description>

• <…>

• <…>

Accessibility compliance

<<In general each component should be A11y complied,  please follow the 3 guidelines linked below. At the very least we should document that each component is in compliance with each of the 3>>

Focus management

<<How will the component work with keyboard only - without a mouse. Can be reference if written above

We already set a general guidelines described in /wiki/spaces/UX/pages/308969693 >>

Screen reader support 

<<Make sure the components support screen reader for content or behaviour where needed - see /wiki/spaces/UX/pages/308248620 >>

Contrast & size compliance

<<Visual designers must comply with the minimal of /wiki/spaces/UX/pages/301498483 for each component>>

Design

Code

<<a box containing the code - discuss with Femi>>