kolibri-design-system icon indicating copy to clipboard operation
kolibri-design-system copied to clipboard

Published 20 hours ago • verified publisher icon learningequality

Consistent prop name for text labels across components

Open indirectlylit opened this issue 3 years ago • 1 comments

Desired behavior

We use a consistent prop name – probably text – for anywhere a component has a String-type prop for some sort of label text. If the component has multiple string props, they should be variations: for example the KRadioButton might have both text and descriptionText.

Current behavior

We currently have a wide range of inconsistent prop names across the library, e.g.

  • text
  • label
  • tooltip and ariaLabel (https://github.com/learningequality/kolibri-design-system/issues/168)

The Value Add

This will help engineers learn the KDS API more easily be permitting knowledge transfer between components

Possible Tradeoffs

API breakage will require a major version bump and changes to Kolibri and Studio

indirectlylit avatar Feb 27 '21 20:02 indirectlylit