kolibri-design-system icon indicating copy to clipboard operation
kolibri-design-system copied to clipboard
verified publisher icon learningequality

`KSortableTable` Component

Open marcellamaki opened this issue 3 years ago • 1 comments

Overview

The KSortableTable Component is an update to work begun with CoreTable and SortableHeader to create a KDS Component that will

  1. Have an easy-to-use, standard sortable table experience
  2. Work across Kolibri and KDP
  3. Meet best practices for screen-reader accessibility

Impact and Timeline

The feature is in support of design updates for 0.16, for the "change facility" feature where a sortable table is required. By addressing this problem one time in KDS, we will be able to use this component across our products.

This is a Q2 project that should be completed well in advance of 0.16, although it will be deployed with that release.

Working Assumptions

  • CoreTable and SortableHeader will be useful references
  • This component will be useful across products, and will be easily reusable

Out of Scope

  • This component does not need to handle filtering or searching
  • This component does not need to manage pagination

Acceptance Criteria

The core purpose of making this a KDS component is for accessibility. Therefore, accessibility best practices will be the major part of the acceptance criteria. The other major goal is that the use of this component should not leave too much to the developer. The core pieces of accessibility criteria should be the default behavior (i.e. not requiring extra configuration) and not easily modifiable.

MVP

  • Full compliance to accessibility criteria is the baseline for our MVP.
  • Documentation for the new component added to KDS site

Additional notes

  • Specs of the visual design of the table (colors, fonts, spacing, etc.) may be changed as needed in support of accessibility best practices, but any changes should be done in consultation with Jessica and Radina. Changes to the spec that are not made in support of accessibility are a no.
  • Implementation of this component in Kolibri is out of scope of this epic -- this is just about the creation of the component

Resources

Figma

External resources on Accessible Sortable Tables: USWDS: Sortable Tables Inclusive Components: Sortable Tables Multi-column sortable tables

marcellamaki avatar May 06 '22 13:05 marcellamaki

May be related https://github.com/learningequality/kolibri-design-system/issues/220

MisRob avatar Aug 31 '22 09:08 MisRob

Closed by GSOC KTable project

MisRob avatar Oct 16 '24 08:10 MisRob