Lead:  Liav Nadler

Issues to cover

...

• • Invalid values

  • Blank mandatory fields

  Form-level elements

  • Status tags

  • Messages

• Action buttons

  • Distances between buttons (if more than 2)

• Guidance

  • Form instructions

  • Field help

  • Ask Femi about web SDK form guidance

• Autosave

Description

A form is a collection of input fields, allowing users to enter data that is then sent for further processing.
Forms may appear in workspaces, dialog popups, popovers,wizards,filter panes, details panes and cards.

...

• A form consists of two areas: the input area and the action area.

• The input area may contain any set of input fields, including text fields, dropdown menus, checkboxes, radio buttons etc.A collection of related fields can be grouped into a section. For example, fields like Email and Phone can be found under a section called Contact Information.

• The action area usually consists of at least two buttons: a submit button (Save, or Create, or Update etc.) and Cancel.

...

• Field labels will appear on top of the input field (for example, above a text field or a set of radio buttons).

• Where relevant, a red mandatory indicator (*) will show next to the label.

• Where relevant, a help icon will appear next to the label (aligned to the right side of the field, if possible).

• A collection of related fields can be grouped into a section. For example, fields like Email and Phone can be found under a section called Contact Information.

• Two or more fields may be dependent. In this case:

  • Any dependent field will appear below the original (independent) field.

  • selecting a value for a dependent field will be possible only if there is a value in the original (independent) field.

The Action Area

• The action area will always be visible:

  • In case the form takes up the entire workspace, the action area will appear at the top of the page (see examples below).

  • In any other case, the action area it will appear below the form:

    • In dialog popups, popovers,wizards,filter panes, details panes and cards, the action area will appear at the bottom of the container.

    • In workspaces:

      • If the form does not exceed the height of its container, the action area will appear directly below the last field of the form.

      • If the form exceeds the height of its container, the action area will stick to the bottom of the container, allowing users to scroll the form above it.

      • Add example

• Primary buttons will be aligned to the right. Additional buttons, such as Clear or Reset will be aligned to the left.

Image Added

States

• Forms can have 3 states:

  • Idle - this is the default state when entering a form. In this case, exiting the form will not save it.

  • Dirty state - the state of a form after making changes but before clicking the Save button. In this case, exiting the form will trigger an error message (see below).

  • Saved - the state of a form after clicking the Save button.

...

• Creating or updating entities (e.g., : users, roles, channels).

• Configuration pages (e.g., Services services level indicators, storage retention periods).

Don’t use:

• When?

General

• In case of large number of fields, group related fields together, providing a clear title to each group.

• Make sure there is a natural tab order between fields.

• Make sure that label texts are not selectable.

Examples

Update screen

Accessibility compliance

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

text highlight when using a keyboard + using arrows when in edit mode (left, up or home to set the insertion point at the beginning; right, down or end to set it at the end).

Design

...