@dhasdk/simple-ui 1.0.64 → 1.0.65

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -53,6 +53,10 @@ Tooltip
53
53
 
54
54
  ## Changelog
55
55
 
56
+ 1.0.65 - changed **label** on **`Input`** component to a **`ReactNode`** type. Also updated **aria-label**
57
+ handling logic to compensate (dev can enter **aria-label** manually, if not present and label is of
58
+ type string, will use **label** as the **aria-label**).
59
+
56
60
  1.0.64 - changed **optionsLabel** prop in **`Select`** to a ReactNode from string value
57
61
 
58
62
  1.0.63 - added **selected** prop to the **`Select`** component
@@ -1032,12 +1036,14 @@ A reference can also be created and passed to the input component, and the compo
1032
1036
  | dataTestId | string | Yes | undefined | A **'data-testid'** value that is applied to the input element for testing purposes |
1033
1037
  | dataTestIdLabel | string | Yes | undefined | A **'data-testid'** value that is applied to the div element that contains the Label value for testing purposes |
1034
1038
  | insetLabel | boolean | Yes | false | indicates whether the label is inset into the border or resides above the input component |
1035
- | label | string | Yes | '' | string value of label, blank for no label |
1039
+ | label | ReactNode | Yes | '' | Can be a String or ReactNode, allows formatting inside the label. The
1040
+ **`aria-label`** value can be specified separately, or taken from **label** if of type string. aria-label is
1041
+ undefined otherwise. |
1036
1042
  | labelBaseColor | string | Yes | | Use if the page or input color is not white, this will help to blend the label background to the surrounding area, color is a string hex value, i.e. **#fefefe** |
1037
1043
  | error | boolean | Yes | false | boolean prop indicating if the current input is in an error state. if true, applies visual error formatting to the input component. |
1038
1044
  | mask | string | Yes | undefined | a text string used to define an input mask. using the provided mask, input will format the users input into the formatted mask. In the case that the user adds invalid input, it is ignored. Non letter/number characters are also automatically entered if a valid following character type is added instead. # represents an individual number character, and @ represents a letter. All other values are themselves. |
1039
1045
  | placeHolder | string | Yes | Yes | | sets the placeholder text inside the input element |
1040
- | ...props | string | Yes | | takes additional props that are not specifically defined in the component, i.e. aria-label |
1046
+ | ...props | string | Yes | | takes additional props that are not specifically defined in the component, i.e. aria-label. Note, if **aria-label** is not specically set, will be derived from **label** if of type string |
1041
1047
  | required | boolean | Yes | | if specified, a red asterisk is prepended to the label, and the required attribute is set to true |
1042
1048
  | textShadow | boolean | Yes | false | indicates whether a drop shadow should be applied or not to the label text, and if used, utilizes the **labelBaseColor** above. |
1043
1049
  | variant | string | Yes | | The predefined variant of Badge to display. Current options are 'default', 'MedCard', 'Outline', and 'nonHover' |