Lead: Rotem Avidan (Unlicensed) -
| Status | ||||
|---|---|---|---|---|
|
| Table of Contents |
|---|
Description
The A card is an expanded container of content and actions for single item. 
a container, containing details and actions related to a selected item in the main workspace (e.g. cards of events related to a calendar).
...
Usage & Behavior
A card
...
The card should be easy to scan and aiming at what action can be done at him.
...
may appear when selecting an element in the main workspace, e.g. a row or a cell in a table.
When clicked on, some elements on the main workspace may display more than one card (for example, when showing multiple schedule items of a single employee).
General guidelines
Structure
...
1. The Card Body
The Card body has two state mode - read and edit.
This part will include the expanded information of the selected single subject which will display by:
A. Filed / Text
Using text or filed follow the card state mode (readable or edit)
B. Status icons (optional)
...
2. Action bar (optional)
The action bar includes more optional actions that affected on the single subject
...
Positioning and Size
1. The card will display as part of the Detail Pane
2. The card width is fixed - 280px and height may change follow the content
3. The card will not have an inside scroll
4. The card can not be drag and move
States
...
Card with not information vs. Card with information
...
Mode
View state mode - is when the card is unselected, the information will display but with out the action
...
Edit state mode - is when the card is selected, the information and action will display
...
Validations and Errors
1. The card doesn't have validation and errors as an item
2. The card context can have validation and errors - see Field Validation
Best practices
Using Card's fields and buttons clear and understandable what they are aiming to.
Keeping elements on hierarchy layout - first context and then action.
When to use card
1. If you have a massive workspace and you need to give more information specific for an item
2. If you want to focus between main and secondary information for an item
When to consider using Card or Popup
1. Using Card when the expand information is not massive, if it is not - use the Popup
2. Using Card when is needed seeing the expand information next to the selected single item, if it is not - use the Popup
Accessibility compliance
<<In general each component should be A11y complied, please follow the 3 guidelines linked below. At the very least we should document that each component is in compliance with each of the 3>>
Focus management
<<How will the component work with keyboard only - without a mouse. Can be reference if written above
We already set a general guidelines described in Keyboard & Focus Management Guidelines >>
Screen reader support
<<Make sure the components support screen reader for content or behaviour where needed - see Screen Reader Guidelines >>
Contrast & size compliance
<<Visual designers must comply with the minimal of Contrast + Font Size Guidelines for each component>>
Design
...
Zeplin link
...
Screen thumbnail
...
<<Zeplin Link>>
Code
...
A card can have two modes: read-only and editable.
On read-only mode, the card contains a non-editable text area.
On editable mode, the card contains:
a set of input fields (e.g. Drop-down Menus, Date Pickers, Time Pickers, etc.).
an action bar at the bottom-left side of the card (optional). The action bar appears only when a card has been selected.
a Save and a Cancel buttons at the bottom-right side of the card.
A card may also contain:
a status bar at the top right side of the card, containing a set of status icons and/or toggle buttons. Toggle buttons will be grouped and aligned to the left of the status icons outside the status bar.
an expand button at the bottom-left side of the card, allowing the user to see more information (see below).
A card in read-only mode | A card in editable mode |
|---|---|
 |  |
Placement & Positioning
Cards are aligned to the top and the center of the details panel.
Cards have a fixed width. Their height may vary according to the content they hold. A card will not contain a scrollbar.
...
States
State | Read-Only | Editable | Comment |
|---|---|---|---|
Regular |  |  | |
Selected |  |  | The selected card can be read-only or editable depending on the user’s permissions. |
Hover |  |  | |
Focus |  |  | When using the arrow keys to navigate between items |
Interaction
Clicking a card will:
select that card, deselecting any other cards.
if allowed, switch the card to editable mode.
move the focus to the corresponding element on the workspace.
On editable mode, updating any input field will enable both the Save and Cancel buttons. In this case:
clicking the Save button will save the data.
clicking the Cancel button will roll back the fields to their previous values.
clicking either Save or Cancel will also disable both buttons.
Clicking the Expand button:
in read-only mode: will open a Message Popup with additional information.
in editable mode: will open a dialog with additional settings.
Clicking outside the card:
deselects the card (unless the click was on a relevant element on the main workspace).
in editable mode: rolls back to any changes made before clicking the Save button.
Validations & Errors
Cards do not require special validations.
For validations on card’s content, see Field Validation.
Best practices
Use cards:
when it is beneficial to display extra information alongside the selected item in the workspace.
to group several related pieces of information together, providing an entry point for further details on each item.
Don’t use cards:
when users need to compare attributes from different objects.
General
A card should:
contain information relating to one selected item or topic only.
be easy to scan.
prioritise any actions which can be performed on the item.
A card’s content and action options should be clear and understandable.
Accessibility compliance
Unless otherwise specified, see our general compliance information in Fundamentals - Accessibility.
Design
Zeplin link | Screen thumbnail |
|---|---|
 |
Code
...