Description

A widget is a container element which holds a distinct set of content. They are used to organise elements into Layouts and Dashboards within the main workspace.

Open	Open

Usage & Behavior

General guidelines

Structure

Each widget consists of:

• a header, which includes:

  • either:

    • a widget title, with or without additional information, or

    • Tabs (see below).

  • widget controls (optional), including Icon Buttons and an Action Menu (see below).

  • a collapse/expand icon to the left of the title (optional - not to be used within customisable dashboards).

• the content area.

Widget Title

• The widget name will be aligned to the left.

• Additional information (if exists) will be aligned to the widget name, separated by a line separator.

• Where space is constrained, the widget name and the additional information will be truncated. In this case, the full information (both name and additional information) will be presented in a Tooltip on hover.

Widget controls

• Only controls that relate to the widget itself may appear in the header area. These include:

  • maximize, such as into a Popup or separate page.

  • expand/collapse (not to be used within customisable dashboards).

  • add, remove, and resize (only in customisable dashboards).

  • configuration.

• Content-related actions will be presented in a toolbar within the content area.

• All widget controls (except for expand/collapse) are aligned to the right of the header area, and may include up to 3 elements, including:

  • Icon Buttons, usually used for primary actions.

  • an Action Menu, usually used for secondary actions. Where there are no primary actions, all widget controls may be presented in one action menu (without any icon buttons).

Tabbed Widgets

• Different content types can be gathered under a single widget using Tabs. In this case:

  • tabs replace the widget title and any additional information.

  • any widget controls refer to the widget as a whole (and not to each tab individually).

Placement and Positioning

A widget can be placed anywhere within the main workspace.

• For standard pages, see Layouts for guidance on how to arrange widgets within the workspace.

• For data overview pages, see Dashboards.

States

Edge Cases

Interaction

Expand/Collapse

Clicking the expand/collapse icon will show or hide the widget content using an animation. In this case the workspace layout may be changed.

Note: expand/collapse may not be used for widgets within a customisable Dashboard.

Drag and drop (customisable dashboards only)

• Hovering over the widget will switch the widget to the hover state.

• Hovering over the header area (including the handle) will change the mouse cursor to a dragging state.

• The user can drag the widget to a new location.

See Dashboards and Drag and Drop for more information.

Note: widgets not within a customisable dashboard cannot be moved.

Maximize

• Widgets may include a maximize option to show the content in a larger space, such as a Popup or separate page.

Validations and errors

• Widgets has no special validations.

• When there are errors in the content area of a collapsed widget, an indicator will appear next to the widget title.

Transitions

Expand and collapse will be animated.

Best practices

Use:

• for all content containers within the main workspace.

• in dashboards.

Don’t use:

• scroll within widgets, where possible. Instead:

  • make sure the allocated space is appropriate for widgets which contain a lot of data.

  • limit the content shown, and include an option to show the full content in a larger space such as a Popup or separate page.

General

• Widget title and additional information should be short and informative. Avoid long text that will not be fully presented in various responsive states.

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.

• The layout of the content within each widget should fluidly respond to its width. This may include changing text, graphics, table, and spacing sizes.

• Where possible, avoid using internal scroll within widgets, either vertical or horizontal.

• Where widget size is limited:

  • use Tooltips for parts which cannot be fully displayed, e.g. truncated headers and data labels.

  • reduce the amount of content shown, and include an option to show the full content in a larger space such as a Popup or separate page.

See Layout workspaces or Dashboards for guidance on the responsive behavior of widgets relative to one another.

Design

Code