Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
maxLevel2

...

A filter pane is an area located on the left side of a page, allowing users to filter data by a set of selected parameters.

...

Basic Flow

  • The filter pane contains two areas:

    the

    a filter bar

    ,

    and

    the

    a content panel.

  • On relevant pages where the pane is applied, the filter bar is always shown.

  • Selected filters are represented by chicklets chiclets, appearing above the presented data (see The Chicklet the Chiclet Area below).

...

  • The content panel has two states:

    • Unpinned (default) - the panel overlays the content of the page, hiding everything behind it.

    • Pinned - the panel is shown next to the content of the page so nothing is hidden.

Usage and Behavior

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

    • Faceted - the filters are sorted by importance or popularity. Applying a filter affects applying one filter affects other filters, e.g. by updating the number of expected results shown on against the other filters (common)or removing irrelevant options.

    • Funnel - the filters are ordered by hierarchy. Applying applying a parent filter affects child filters, but applying a child filter does not affect parent filters (less common).

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

  • The filter pane can operate in one of two modes:

  • Discrete - the user applies their selection from each filter tab independently, by clicking the Apply button separately for each one (common).
    An exception is if only one selection is allowed within the tab. In this case, the Apply button will be hidden, and performing that single selection will apply the filter and close the filter pane.

  • Combined - the user can apply selections from multiple filter tabs in one go, by clicking the Apply All Filters button

    Users can apply changes on single or multiple tabs using the Apply button (see Interactions below).

  • 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 all related workspaces.

...

The Filter Bar

...

The Filter Bar

...

...

Structure

  • The filter bar contains one or more tabs.

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

  • Once Whenever a filter has been is applied, a blue dot will be shown on the left side of the relevant next to the corresponding tab.

Placement and Positioning

The filter bar

...

should:

  • stick to the left side of the page.The background of the bar stretches from the page header , beside the main workspace,

  • have a fixed width,

  • always fill the vertical space, from beneath the VerinTop to the bottom of the page.

  • The width of the bar is fixed.

  • The , and

  • have the group of tabs is aligned to the top of the bar.

States

  • Each tab can have one of these states:

State

Image

Comments

Regular

Image Modified

Regular, Applied

Image Modified

Hover

Image Modified

Active

Image Modified

Selected

Image Modified

Only one tab can be selected at any given time.

Selected, Hover

Image Modified

Focused

Image Modified

Focused, Hover

Image Modified

Focused, Selected

Image Modified

Default State

  • In most cases, no tabs are selected by default.

Interaction

  • Users will be able to go from tab to tab freely, without the need to apply changes to each tab separately, as long as there are no errors on the current content panel (see below).

  • Clicking a tab:

    • selects it

    , and
    • .

    • unselects any other tab.

...

    • when the content panel is

...

  • clicking a tab will open
    • pinned - updates the content

    panel in overlay mode, hiding everything behind it.

...

    • of the panel to correspond to the selected tab.

    • when the content panel is

...

  • clicking a tab will shows the relevant content in the content panel
    • unpinned - opens the corresponding content panel. When the panel is open, clicking the selected tab again closes it.

The Content Panel

...

...

States

  • The content panel has two states:

    • Unpinned (default) - the panel overlays the content of the page, hiding the content behind it.

    • Pinned - the panel is shown next to the content of the page so nothing is hidden.

Structure

The content panel contains the following elements:

  • At the top:

    • a A title, similar to the corresponding title on the filter bar (e.g. Employees).

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

    • a A help icon button (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:

    • Either an Apply or an Apply to All button, depending on whether you’re using Discrete or Combined filtering (see Basic Flow).

      • The Apply button is disabled until the filters currently shown in the content panel have been changed.

      • The Apply All Filters button is disabled until the filters in any of the tabs have been changed.

    • An indicator An Apply button. Thebutton is disabled until at least one filter was changed.

    • A Cancel button:

      • When the content panel is unpinned, the Cancel button will always be enabled.

      • When the content panel is pinned, the Cancel button will be disabled until a change was made to the content.

    • A counter of the total number of updates made to the filter pane (e.g., 2 updates).

    • In some cases:

      • A counter showing the number of selected items (e.g. 4 queues selected).

    • A Cancel button.

      • The button is disabled until the filter selection in the content panel has been changed.

    • A Clear button (in case the design has no chicklets).

      • The button is disabled if no filters have been applied.

      • An error message (see Validations and Errors below).

Placement and Positioning

The content panel:

  • is positioned to the right of the filter bar.The width of the panel is fixed

  • fills the vertical space, from beneath the VerinTop to the bottom of the page.

  • has a fixed width.

Content

  • The main content area of the panel can may:

    • show either a Form, a List, or a combination of the two.

    The content can
    • have a variety of layouts

    . see Common examples
  • The count of each itemmay be shown in brackets. See Common Examples below.

  • In some cases, users can navigate from the content panel to Subsections, allowing them to access additional settings.

Interaction

  • Clicking the pin icon switches :

    • when the content panel is unpinned:

      • changes the icon

    between
      • to pinned

    and unpinned states
      • .

      When unpinned,
      • changes the

      content of the page stretches to its full width, being partially hidden by
      • state of the content panel to pinned (see above).

    • When pinned, when the content of the page narrows to be shown next to the panel, so nothing is hiddenpanel is pinned:

      • changes the icon to unpinned.

      • closes the content panel.

  • Clicking the help icon, if exists, opens a relevant help page in a new browser window.

  • Changing Updating the content of the a panel:

    • enables the Apply

    / Apply All Filters, Cancel, and Clear buttons, where they exist
    • button.

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

    • shows / updates the number of changes made across allcontent panels.

  • Clicking the Apply /Apply All Filters button:

    • applies the filter(or filterss).

    • disables the Apply button.

    • enables the Clear button, where it exists.

    • shows a blue indicator next to the relevant tab (or tabs) on the filter bar.

    • adds a chicklet (or chicklets) to the chicklet removes the updates counter from the bottom of the panel.

    • adds one or more chiclets to the chiclet area (see The Chicklet Chiclet Area below), unless otherwise specifiedwhere relevant.

    • if unpinned, closes the content panel, if it is unpinned.

  • Clicking the Cancel button:

    • cancels any changes made to the content before hitting the Apply / Apply All Filters button.

    • cancels any reverts all unapplied changes made to the content.

    • disables the Apply/ Apply All Filters and Cancel buttons button.

    • closes if the content panel is unpinned, if closes it is unpinned.

    Clicking the Clear button:

    • Resets all fields in if the content panel to their default states (either blank or with default selections).

      At this point, the user can either:

    • click Apply - this will remove the blue dot next to the relevant tab on the filter bar, as well as the corresponding chicklet, if exists,

    • click Cancel - this will revert the content panel to its previous state, before clicking the Clear button

      is pinned, sets the focus to the first field of the content panel.

  • Clicking outside the content panel :

    The content panel closes if:

  • the panel is unpinned. (When pinned, the panel always stays open).

  • when it is unpinned:

    • If no unapplied changes have been made, closes the panel.

    • If unapplied changes have been made to the content but have not been applied, a Message Popup may will appear , allowing the user to either : close the panel without applying the filter

      ,

      (s) or

      continue editing.

...

Validations and errors

For validations within a form see Field Validation.

...

Transitions

  • The content panel will open and close with a brief slide effect.

  • When pinning / unpinning the content panel, the content on the main area of the page will collapse / expand with a transition effect.

Best Practices

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

  • Allow users to determine the persistency of the pin status in system preferences.

The

...

Chiclet Area

...

General Guidelines

  • Chicklets show the user that their data is currently filtered by one or more filters, which can be quickly clearedChiclets are indicators of the currently applied filters.

  • There are two types of chickletschiclets:

    • Regular - deleting .Deleting these chicklets chiclets will clear the corresponding filters.

    • Mandatory - deleting these chicklets will show an empty state for the data, instructing the user to apply the mandatory filters .Each mandatory chiclet will have a default value.Mandatory chiclets cannot be deleted, only be reset to their default values (see below).

...

  • In Discrete mode (see Basic Flow above):

    • in most cases, clicking Apply in the content panel creates a single chicklet. However, when the panel contains several distinct parameters, applying the filter may create several chicklets.

  • In Combined mode:

    clicking Apply All Filters may create a single or multiple chicklets

    In rare cases, a filter pane can be used without chiclets. In this case, a Clear button should be included in the content panel.

...

  • Clicking Apply on the filter pane may add a single or multiple chiclets, depending on the number of filters that have been

    changed

    applied.

States

  • Each chicklet chiclet can have one of these states:

State

Image

Regular

Mandatory

Comments

Regular

Image Modified

Hover

Image ModifiedImage Added

Active / Selected

Image ModifiedImage Added

Only one

chicklet

chiclet can be selected at any given time.

Ghost

Image RemovedGhost, Hover

Ghost, Active

Image Removed

Image Removed

Focused

Image Modified

Focused, Hover

Image ModifiedImage Added

Focused, Active

Image ModifiedImage Added

Structure

  • The width of a chicklet chiclet will depend on its content, within minimum and maximum limits.

  • Each chicklet chiclet contains:

    • an icon, which is a smaller version of the corresponding tab icon on the filter bar.

    • chicklet chiclet text.

      • For a single selection, the selected value will be shown (e.g. Last 24 hours).

      • For multiple selections, it can show either:

        • the selected values, separated by commas (e.g. APAC, EMEA), or

        • if the text exceeds the maximum width of the chickletchiclet, the name of the filter followed by the number of values in brackets (e.g. Interactions (3)). In this case, hovering the chicklet chiclet will show a tooltip with the full list of items.

    • a Close a close icon button (for regular chiclets) or a reset icon button (Xfor mandatory chiclets), shown on hover.

  • If the content of the chicklet exceeds the maximum width, the text will be truncated, ending with an ellipsis (…). In this case, hovering the chicklet will show a tooltip with the full text.

  • A Clear All icon button, shown to the right of the last chicklet.

  • no mandatory chiclets were defined, a Clear All icon button will appear after the last chiclet, allowing users to clear all filters.

  • If at least one mandatory chiclet was defined, a Reset to default icon button will appear after the last chiclet.

  • The Reset to default button will be disabled by default. Changing the default value or adding more chiclets will enable it.

...

Placement and Positioning

  • The chicklet chiclet area appears in the main workspace, above the corresponding datapage content.

  • When no filters are applied, the chicklet chiclet area will be hidden, and the page content will start directly below the page header. Adding the first chicklet chiclet will push all of the content down, below the chicklet chiclet area.

  • Mandatory chicklets chiclets will be the first items. Other chicklets chiclets will appear in the order they were added.

  • In case the set of chicklets chiclets (including the Clear All button) exceeds the width of the chicklet chiclet area, they will wrap on to the next row, pushing the page content down. There can be up to three rows: beyond that point, a scrollbar will appear.

Interaction

Hovering a chiclet

  • Regular chiclets - shows an X icon inside the chiclet, allowing the user to remove it.

  • Mandatory chiclets - shows a reset icon inside the chiclet, allowing the user to reset the chiclet to its default value.

Clicking a

...

chiclet

  • When the content panel is pinned - shows the relevant content in the content panel.

  • When unpinned - opens the relevant content panel .

...

  • (if not already open).

Clicking the chiclet x icon:

  • removes the chiclet. Any remaining chiclets will move to close the gap, if exists,

  • clears the corresponding filter.,

  • clears the blue indicator from the corresponding tab on the filter bar (unless there are more items related to that filter).In case of a regular chicklet

Clicking the chiclet reset icon:

  • removes the chicklet. Any remaining chicklets will move to close the gap.

...

In case of a mandatory chicklet:

  • switches the chicklet to a “ghost” state.

  • shows an empty state for the data, instructing the user to add the mandatory filter (see example above).

...

If all chicklets were removed, an empty state will appear.

...

  • resets the chiclet to its default value,

  • applies the corresponding filter.

Clicking the Clear all button:

  • shows a confirmation dialog (if needed),

  • removes all non-mandatory chiclets,

  • removes the Clear all button,

  • clears all non-mandatory filters,

  • removes the blue indicator from all tabs, except for mandatory filters.

Clicking the Reset to default button:

  • shows a confirmation dialog (optionalif needed).,

  • removes all chicklets, except for “ghost” chicklets, where they exist.

  • clears all filters.

  • clears regular chiclets,

  • resets all mandatory chiclets to their default values,

  • disables the Reset to default button,

  • applies the default filter,

  • removes the blue indicator from all tabs on the filter bar.shows an empty stateexcept for mandatory filters.

Note: in complex scenarios, behaviour behavior may vary (seeCommon Examples below).

Validations and Errors

...

  • All local field validations will occur when removing focus from a field (or when clicking the Apply button).

  • In case of an error (e.g. an end date earlier than a start date):

    • the Apply button will be disabled.

    • an error message will appear at the bottom of the content panel.

    • clicking outside the content panel when it is unpinned will open a Message Popup, allowing the user to either close the panel without applying any changes or continue editing. (See Interaction above).

  • For detailed information on local field validations see Field Validation.

Best Practices

General

  • Where possible, values should be shown next to each filter in the content panel, showing the number of results that will be produced if the filter is applied.

  • Where the number of filters is great, consider removing filters which will produce zero results.

Use:

  • when a for major data set sets (for example a table, grid, or dashboard) is shown on the page, and there is a need to filter it , which needs to be filtered by one or more parameters.

  • for complex filtering or when a large number of filters is needed.

Don’t use:

  • for data in a Dialog or Details Panel.

Accessibility compliance

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

Responsive design

Verint products should support all devices down to the common tablet size (960px width). For general guidelines, see Fundamentals - Responsive design.

Pane width

  • The filter bar and the content panel always have a fixed width, and do not respond to the width of the screen.

  • The default state of the content panel changes at different widths.

    • For screen sizes of 1366 px and below, it is recommended that it is closed and unpinned by default.

    • For screen sizes of 1367 px and above, it is recommended that it is pinned open by default. (This is optional depending on the use case).

  • At 960px and below, the pin and expand options should be disabled.

Pane height

  • The filter pane should always fill the vertical space available, from beneath the VerinTop to the bottom of the page.

  • When the screen height (and therefore the filter pane height) changes:

    • the content of the filter bar and the content panel (including headers, search, and filter options), should remain fixed to the top.

    • an internal Scrollbar should be used if the content does not fit vertically.

    • the Apply button and footer information should remain fixed to the bottom.

Common Examples

Designs

Comment

Image Removed
Image Added

A single list filter with no dialog buttons.

Image Removed
Image Added

A date picker filter.

Image Removed
Image Added

A multi accordion filter.

Accessibility compliance

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

Design

Zeplin link

Screen thumbnail

https://zpl.io/VYPW7Ew

Image Removed
Image Added

https://zpl.io/aR6MBxE

Image Removed
Image Added

https://zpl.io/ad6xDz7

Image Modified

https://zpl.io/29pqgwy

Image Removed
Image Added

Code

...