Versions Compared

Key

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

Description

The details pane is a panel located on the right side of the screen, presenting contextual information related to selected items. It may also include actions or links to other pages.

Image RemovedImage Added

Usage & Behavior

General guidelines

The details pane may have an option to be pinned to the side of the screen, or unpinned (i.e., expanded by demand).

Structure

Header

  • The

Details Panel may
  • details panel may contain a header with general information.

  • The header may present a title, secondary title (optional), Thumbnail (optional), pinning option, contextual help etc.

Image RemovedImage RemovedImage RemovedImage AddedImage AddedImage Added

Tabs

  • The details panel may contain up to 5 tabs.

  • All tabs will be of the same width. In case the title is long it will be truncated and a tooltip will appear on hover.

Image RemovedImage Added

Tab Content

  • In case of one tab (or no tabs) the details pane won't show the tab, and its name will be presented as a title

  • Tab may contain:

    • A header

    • Content area - card/s, table, list, text, form, visual graphs, etc.

    • Action area (optional) - may be along the data and/or below in a designated area at the bottom of the tab

    • Vertical scroll - when needed will be applied only on the content area, plus the header and action area should be sticky

  • Some tabs may include drill down options or links to other areas


Actions Area

If needed there may be a contextual actions area at the bottom of the pane

Placement & Positioning

The Details Panel is part of the entire workspace, on the right side of the screen (when in LTR mode).

Default State

  • When first entering the workspace the details pane should be pinned and expanded (if the resolution allows, see responsive design)

Content

  • The detail pane presents Item/s related content with additional options

  • more information and/or actions related to the selected item

  • in some areas multi item selection is available and may present other content and options

  • The tabs can be changed contextually according to the selected item

Image Added

States

State

Empty state -

Description

Example

Empty State

In case no items are selected, the details pane can present an empty state with guiding text or actions, and/or page summary

(Rotem Avidan (Unlicensed)

Please

please update the empty state here)

Image RemovedStates

Loading

When details pane is being loaded a corresponding animation should be presented

Image Modified

The Collapse/Expand bar

State

Collapsed details pane

Expanded details pane

Hover

Interaction

Clicking the pin icon switches between pinned and unpinned states.

  • When unpinned, the content of the page stretches to its full width, being partially hidden by the content panel.

  • When pinned, the content of the page narrows to be shown next to the panel, so nothing is hidden.

Validations and Errors

  • The

Details Panel may have
  • details pane do not require special validations.

  • For validations and errors

within the content (cards, forms, etc)

Transitions

  • When the Details Pane is being expanded from collapsed mode, the transition will be a slide from right to left (RTL mode).

  • When the Details Pane is being collapsed, the transaction will be slide from left to right.

Best practices

Use:

  • When there is a lot of information/meta data to present on an item.

  • When there is additional secondary information and actions to present on an item.

  • When there is a benefit of viewing some content see side by side.

Don’t use:

When the information isn’t related to a selected item. In this case use a /wiki/spaces/UserExp/pages/2496694037 instead.

Accessibility compliance

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

Design

See some examples below:

Code

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