Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

A dual list selector allows the user to select multiple items. It is particularly useful when there are a large number of available items.

A The most common use of the dual list selector is a column picker, used in Data Tables. For this reason, this document describes the structure and function for a column picker.

Image Modified

Usage & Behavior

General guidelines

Structure

  • The column picker contains two Lists lists:

    • Available Columns (on the left) . A - a list of all of the columns available in the table, including a header.

    • Selected Chosen Columns (on the right) . A - a list of the currently selected chosen columns, including a header.

  • Move buttons (right and left), shown between the two lists. These allow the user to move items between the lists.

  • Reorder buttons (up and down), shown underneath the Selected Chosen Columns list. These allow the user the reorder the selected chosen items.

  • Selected items countA “Up to X” indicator, shown next to the Selected Chosen Columns header . It shows the (optional - if a maximum number of selected items out of the total number of items, for example: 7/22chosen items was set).

  • A Search search bar above each list (optional). This allows the user to quickly locate specific items. The search bar is optional, depending on the number of items.

  • A vertical Scrollbar scrollbar, used where the list is too long to be displayed in its container.

  • A Restore Defaultsdefaults button (optional), shown in the bottom-left corner of the dialog box.

  • Done and CancelDialog Buttonsdialog buttons, shown in the bottom-right corner of the dialog box.

...

  • The Selected Columns list shows the list of columns in the same order as they appear in the data table.

  • The Available Chosen Columns list is sorted alphanumerically.

...

  • The Move buttons (left and right) are disabled until the user has selected at least one item: selecting items in the right list enables the left button, and vice versa.

  • The Reorder buttons (up and down) are disabled until the user has selected at least one item in the Selected Chosen Columns list.:

    • Selecting the top item will only enable the down button.

    • Selecting the bottom item will only enable the up button.

    • Selecting any other item will enable both the up and down buttons.

  • If a column contains items which cannot be moved or reordered, they its checkbox should be shown as disabled.

Interaction

Selecting Items

  • In either list, clicking checking an item selects it. 

  • The user can select more than one item using the Ctrl (or Command) key for discrete selection, or the Shift key for a block selection.

  • Selecting items in one list deselects all items in the other list.

...

  • The user can move selected items between lists using one of two methods:

    • clicking the right or left button between the lists.

    • using Drag and Drop.

  • Items moved to the Selected Columns list will appear at the bottom of the list.

  • Items moved to the Available Columns list will appear in their original locations, so the list is always sorted alphanumerically.

  • Items should remain selected after they were moved.

  • Moved items should always be visible. Where the target list is outside of the visible area, the list will scroll automatically.

...

  • In the Selected Columns list, the user can reorder items by selecting them and then clicking the up and down buttons underneath the list.

    • Reordering multiple items together will keep their relative locations (i.e. including the gaps between items, where they exist).

  • Items can also be reordered using Drag and Drop. In this case, when reordering multiple items they will be clustered.

  • After the items are reordered they will remain selected until the user selects other items.

...

Pinning columns (optional)

Image Modified
  • The user can pin any column in the Selected Columns list by clicking the pin icon, which is shown on hover. In this case:

    • the icon toggles from pinned to unpinned.

    • the item moves to the top of the list.

    • the item can be ordered only inside the group of pinned items.

    • within a Data Table, pinned columns are anchored to the left. Pinned columns can be reordered only inside the group of pinned columns.

  • The user can unpin the item by clicking the pin icon again.

...

  • the search bar and reordering buttons will be disabled.

  • a message will appear inside the container, advising the user to select at least one item.

Image Modified
  • In this case, clicking the Done button:

    • shows an error message at the bottom of the dialog.

    • disables the button.

Image Modified

Limiting the number of items

  • It is recommended to limit the number of items which can be selected, depending on common usage and system performance.

  • In this case, the maximum number of items should be shown with the count above the Selected Columns list, regardless of the number of available columns.

  • If the user reaches the maximum number of items:

    • the right arrow button will be disabled.

    • dragging items from the Available Columns list will be disabled.

    • a relevant message will appear at the bottom of the popup.

Image Modified

Accessibility compliance

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

Design

Zeplin link

Screen thumbnail

https://zpl.io/2j6oopW

Image Modified

Code

...