Consistent prop name for text labels across components

[indirectlylit]

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 (icon button accepts both a tooltip and an aria label #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

[nucleogenesis]

@nucleogenesis will look into the API and compare/contrast them to clarify the issue a bit

[nucleogenesis]

I hacked at this a bit today and these are the relevant props and the components that have them. I used the docs/jsdoc.js file which is the result of our utils/extractApi.js script to get an object w/ all props that are String type and list the components that use them:

Note, there are many props not shown here, but these are the ones relevant to this issue IMO (full list gist here):

{
    "text": [
        "KButton",
        "KExternalLink",
        "KRouterLink",
        "KOptionalText",
        "KTextTruncator",
        "KTooltip"
    ],
    "label": [
        "KCheckbox",
        "KLabeledIcon",
        "KRadioButton",
        "KSwitch",
        "KSelect",
        "KTextbox"
    ],
    "name": [
        "KSwitch"
    ],
    "title": [
        "KCard",
        "KModal",
        "UiToolbar",
        "KDateRange"
    ],
    "ariaLabel": [
        "KIconButton",
        "KTabs",
        "KTabsList"
    ],
    "ariaLabelledBy": [
        "KSwitch",
        "KTabs",
        "KTabsList"
    ],
    "tooltip": [
        "KIconButton"
    ]
}