Skip to end of banner
Go to start of banner

Details Pane

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 66 Next »

Description

The details pane is located on the right side of the page, presenting information and actions relating to selected items within the main content.

Usage & Behavior

  • The details pane has three basic states (see States below):

    • collapsed,

    • expanded, pinned - the pane is shown next to the main content area, so nothing is hidden,

    • expanded, unpinned - the pane overlays the main area of the page, hiding the content behind it.

  • The default state will be determined for each application separately.

General guidelines

  • When no items are selected, the details pane will show an empty state (see States below).

  • When two or more items are selected, the pane will show either the number of selected items, or a combined view, aggregating data from all items, depending on the application.

Structure

Header

  • The header displays the pane’s title, and may also contain:

    • a secondary title,

    • a thumbnail image (for example, an avatar),

    • a pin icon (see Interaction below),

    • a contextual help icon.

Tabs (optional)

  • Where relevant, the details pane can include up to 5 tabs.

  • Tabs may not exceed the width of the panel; there should be no horizontal scroll.

  • All tabs will be of the same width, regardless of label length.

  • Titles will not wrap onto multiple lines. Long titles will be truncated, and a tooltip will appear on hover.

The Content Area

  • The main area of the details pane may contain various types of content (see Content below).

  • If the content exceeds the height of its container, a scrollbar will appear. The scrollbar will apply only to the content area, excluding the header and the action area, if exists.

Action Area (optional)

  • Where relevant, an actions area will be shown at the bottom of the details pane, allowing users to perform pane-level (or tab-level) actions.

  • The action area may include elements such as indicators, buttons, and drop-down menus.

Collapse/Expand Area (optional)

  • The collapse/expand area is located on the left side of the details pane.

  • An arrow is shown in the middle of it:

    • when expanded, the arrow will direct to the right.

    • when collapsed, the arrow will direct to the left.

Placement & Positioning

  • The details pane is attached to the right side of the page.

  • The pane has a fixed width.

  • The pane will starts a few pixels below the VerinTop, to align with the page title. However, If the page contains a ribbon, the details pane will be attached to it (see example at the description above).

  • The pane will always stretch to the bottom of the page.

Content

  • The content area may contain any combination of elements, such as text, lists, cards, tables, forms, graphs, links. etc.

Examples

States

State

Description

Example

Collapsed

The only visible part of the pane is the collapse/expand area, allowing users to expand it.

Expanded, pinned

the pane is shown next to the main content area, so nothing is hidden.

Expanded, unpinned

the pane overlays the main area of the page, hiding the content behind it.

Empty State

When no items are selected, the details pane will present an empty state with guiding text, guiding actions, or a page summary.

Loading

While the content is loading, a loading state will show, including a progress Indicator.

Interaction

The Pin Icon

  • Clicking the pin icon will switch its state from pinned to unpinned and vice versa:

  • When unpinned, clicking the icon will switch the pane to expanded, pinned state (see States above).

  • When pinned, clicking the icon will switch the pane to expanded, unpinned state (see States above).

When the pane is unpinned

When the pane is pinned

The Collapse/Expand Area

  • Hovering the collapse/expand area switches it to hover state.

  • When the pane is expanded, clicking the area switches it to the collapsed state.

  • When the pane is collapsed, clicking the area switches it to the expanded state.

Validations and Errors

  • The details pane itself does not require special validations.

  • For validations and errors related to content, see Field Validation.

Transitions

  • When the details pane is expanded from collapsed mode, the pane will slide from right to left.

  • When the details pane is collapsed, the pane will slide from left to right.

Best practices

Use:

  • Where items have a lot of related information that needs to be displayed.

  • Where there is a need to perform actions on sub-elements of items (e.g. cards).

Don’t use:

Accessibility Compliance

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

Design

See some examples below:

Code

  • No labels