Versions Compared

Key

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

Lead: Liav Nadler  

Status
colourYellow
titleongoing
Related Pages: Data Tables

Table of Contents

Description

An inline editable table is a data table type of Data Table in which the user can edit data inside any row, without the need to navigate to a separate page, a panel or a popup.Image Removed

...

Basic Flow

An editable table is similar to a

...

standard Data Table, with

...

these exceptions:

  • Hovering a row will show an edit icon.

  • Clicking the edit icon

    in any row

    :

    • Selects

      that

      the entire row (if not already selected)

       

      .

    • Changes all relevant cells

      of that row

      to input fields

      , allowing the user to enter text in text fields or select values in dropdown menus
    • Replaces the edit icon with two icons: confirmation (V) and cancellation (X) 
    They user may enter
  • In edit mode, the user can enter values or update any input field, in any order

  • The first input field will be selected by default
  • The user can move the focus to the next or previous field using Tab / Shift+Tab
  • Clicking Enter when the focus is on a text field changes all input fields back to text, with the updated values
  • When done the user can click on one of the two icons:
    • Clicking the confirmation icon changes all input fields back to text, with the updated values
    • Clicking the cancellation icon changes all input fields back to text, with the previous values

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 /wiki/spaces/UX/pages/308969693 >>

Screen reader support 

<<Make sure the components support screen reader for content or behaviour where needed - see /wiki/spaces/UX/pages/308248620 >>

Contrast & size compliance

<<Visual designers must comply with the minimal of /wiki/spaces/UX/pages/301498483 for each component>>

  • .

  • When finished, the user has two options:

    • Clicking Apply switches the row back to its original state, with the updated set of values.

    • Clicking Cancel (or Esc) switches the row back to its original state, with the previous set of values (before making any changes).

Placement and Positioning

The width of the actions column should leave enough space for all options which will appear on editing, e.g. Apply and Cancel text buttons.

Validations and Errors

  • Long inputs in text fields will be treated as regular Text Fields, unless otherwise specified.

  • In edit mode, clicking on any element on the page after changing a field will show a popup message, warning about the potential data loss. In this case:

    • If the user chooses to keep editing, the popup will close, and the page will auto-scroll to the relevant row, if needed.

    • If the user chooses to close and discard changes, the row will switch back to normal mode, with the previous set of values.

  • In case the table is part of a form with its own Save and Cancel buttons and one of the rows is in edit mode:

    • Clicking the Save button will apply all changes that were made to that row (as if the user also clicked the Apply button).

    • Clicking the Cancel button will revert all the fields in that row to their previous values.

Best Practices

Use:

  • when the table is relatively simple (up to 8 columns).

Don’t use:

  • where selecting a row is the first step of a complex flow.

  • where the table contains more than 8 columns.

  • where one or more of the fields can hold large amounts of text.

Accessibility compliance

Focus management

In edit mode:

  • By default, the first input field will be in focus.

  • See thefocus management sectionin the main data tables page for more information.

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

Design

Zeplin link

Screen thumbnail

<<Short Zeplin link. You
Use this
Image Removed>>

<<Screen with 200 width>>

Code

...

Code

...