Label prop type changed to string (#2698)

* Prop type changed * Changelog & Upgrade Guide * Upgrade Guide updated * Typo fixed * Upgrade Guide update. * Form field update Co-authored-by: Pranav Agarwal <agarwal.pranav300@gmail.com> Co-authored-by: Manuel,Ryan <Ryan.Manuel@Cerner.com>
cerner · Mar 27, 2020 · 2db9369 · 2db9369
1 parent 66e2501
commit 2db9369
Show file tree

Hide file tree

Showing 25 changed files with 94 additions and 13 deletions.
diff --git a/packages/terra-form-checkbox/CHANGELOG.md b/packages/terra-form-checkbox/CHANGELOG.md
@@ -3,6 +3,8 @@ ChangeLog
 
 Unreleased
 ----------
+### Breaking Changes
+* `labelText` and `legend` props' type changed from node to string.
 
 3.34.0 - (March 10, 2020)
 ------------------

diff --git a/packages/terra-form-checkbox/src/Checkbox.jsx b/packages/terra-form-checkbox/src/Checkbox.jsx
@@ -39,7 +39,7 @@ const propTypes = {
   /**
     * Text of the label.
     */
-  labelText: PropTypes.node.isRequired,
+  labelText: PropTypes.string.isRequired,
   /**
     * Additional attributes for the text object.
     */

diff --git a/packages/terra-form-checkbox/src/CheckboxField.jsx b/packages/terra-form-checkbox/src/CheckboxField.jsx
@@ -40,7 +40,7 @@ const propTypes = {
   /**
    * The legend of the form control children.
    */
-  legend: PropTypes.node.isRequired,
+  legend: PropTypes.string.isRequired,
   /**
    * Attributes to attach to the legend.
    */

diff --git a/...terra-form-checkbox/src/terra-dev-site/doc/form-checkbox/UpgradeGuide.3.doc.mdx b/...terra-form-checkbox/src/terra-dev-site/doc/form-checkbox/UpgradeGuide.3.doc.mdx
@@ -4,6 +4,18 @@ import { Badge } from 'terra-form-checkbox/package.json?dev-site-package';
 
 # Terra Form Checkbox Upgrade Guide
 
+## Changes from version 3 to version 4
+
+### Props
+
+#### Updated
+* Form Fields allowed the `label` to be a node, which potentially breaks the display when injecting other non-inline-only text elements (terra-text) or has the potential to completely break accessibility if something non-text based would be passed in.
+* `labelText` prop's type changed from node to string.
+* `legend` prop's type changed from node to string.
+
+##### Steps to Update
+ To upgrade from 3.0 to 4.0 each existing Checkbox must be reviewed and updated to ensure only a string is being passed to the `labelText` and `legend ` props. Solutions passing node data types need to be reworked to provide only a string.
+
 ## Changes from version 2 to version 3
 
 ### Changes to CSS Custom Properties

diff --git a/packages/terra-form-field/CHANGELOG.md b/packages/terra-form-field/CHANGELOG.md
@@ -3,6 +3,8 @@ ChangeLog
 
 Unreleased
 ----------
+### Breaking Changes
+* `label` prop's type changed from node to string.
 
 3.34.0 - (March 10, 2020)
 ------------------

diff --git a/packages/terra-form-field/src/Field.jsx b/packages/terra-form-field/src/Field.jsx
@@ -47,7 +47,7 @@ const propTypes = {
   /**
    * The label of the form control children.
    */
-  label: PropTypes.node.isRequired,
+  label: PropTypes.string.isRequired,
   /**
    * Attributes to attach to the label.
    */

diff --git a/packages/terra-form-field/src/terra-dev-site/doc/form-field/UpgradeGuide.2.doc.mdx b/packages/terra-form-field/src/terra-dev-site/doc/form-field/UpgradeGuide.2.doc.mdx
@@ -4,6 +4,17 @@ import { Badge } from 'terra-form-field/package.json?dev-site-package';
 
 # Terra Form Field Upgrade Guide
 
+## Changes from version 3 to version 4
+
+### Props
+
+#### Updated
+* Form Fields allowed the `label` to be a node, which potentially breaks the display when injecting other non-inline-only text elements (terra-text) or has the potential to completely break accessibility if something non-text based would be passed in.
+* `label` prop's type changed from node to string.
+
+##### Steps to Upgrade
+To upgrade from 3.0 to 4.0 each existing Field must be reviewed and updated to ensure only a string is being passed to the `label` prop. Solutions passing node data types need to be reworked to provide only a string.
+
 ## Changes from 2.0 to 3.0
 
 ### Changes to CSS Custom Properties

diff --git a/packages/terra-form-input/CHANGELOG.md b/packages/terra-form-input/CHANGELOG.md
@@ -3,6 +3,8 @@ ChangeLog
 
 Unreleased
 ----------
+### Breaking Changes
+* `label` prop's type changed from node to string.
 
 2.36.0 - (March 10, 2020)
 ------------------

diff --git a/packages/terra-form-input/src/InputField.jsx b/packages/terra-form-input/src/InputField.jsx
@@ -12,7 +12,7 @@ const propTypes = {
   /**
    * The label of the form control children.
    */
-  label: PropTypes.node.isRequired,
+  label: PropTypes.string.isRequired,
   /**
    * The defaultValue of the input field. Use this to create an uncontrolled input.
    */

diff --git a/packages/terra-form-input/src/terra-dev-site/doc/form-input/UpgradeGuide.3.doc.mdx b/packages/terra-form-input/src/terra-dev-site/doc/form-input/UpgradeGuide.3.doc.mdx
@@ -4,6 +4,17 @@ import { Badge } from 'terra-form-input/package.json?dev-site-package';
 
 # Terra Form Input Upgrade Guide
 
+## Changes from version 2 to version 3
+
+### Props
+
+#### Updated
+* Form Fields allowed the `label` to be a node, which potentially breaks the display when injecting other non-inline-only text elements (terra-text) or has the potential to completely break accessibility if something non-text based would be passed in.
+* `label` prop's type changed from node to string.
+
+##### Steps to Upgrade
+To upgrade from 2.0 to 3.0 each existing Input must be reviewed and updated to ensure only a string is being passed to the `label` prop. Solutions passing node data types need to be reworked to provide only a string.
+
 ## Changes from version 1 to version 2
 
 ### Changes to CSS Custom Properties

diff --git a/packages/terra-form-radio/CHANGELOG.md b/packages/terra-form-radio/CHANGELOG.md
@@ -3,6 +3,8 @@ ChangeLog
 
 Unreleased
 ----------
+### Breaking Changes
+* `labelText` and `legend` props' type changed from node to string.
 
 3.39.0 - (March 10, 2020)
 ------------------

diff --git a/packages/terra-form-radio/src/Radio.jsx b/packages/terra-form-radio/src/Radio.jsx
@@ -39,7 +39,7 @@ const propTypes = {
   /**
     * Text of the label.
     */
-  labelText: PropTypes.node.isRequired,
+  labelText: PropTypes.string.isRequired,
   /**
     * Additional attributes for the text object.
     */

diff --git a/packages/terra-form-radio/src/RadioField.jsx b/packages/terra-form-radio/src/RadioField.jsx
@@ -40,7 +40,7 @@ const propTypes = {
   /**
    * The legend of the form control children.
    */
-  legend: PropTypes.node.isRequired,
+  legend: PropTypes.string.isRequired,
   /**
    * Attributes to attach to the legend.
    */

diff --git a/packages/terra-form-radio/src/terra-dev-site/doc/form-radio/UpgradeGuide.3.doc.mdx b/packages/terra-form-radio/src/terra-dev-site/doc/form-radio/UpgradeGuide.3.doc.mdx
@@ -4,6 +4,18 @@ import { Badge } from 'terra-form-radio/package.json?dev-site-package';
 
 # Terra Form Radio Upgrade Guide
 
+## Changes from version 3 to version 4
+
+### Props
+
+#### Updated
+* Form Fields allowed the `label` to be a node, which potentially breaks the display when injecting other non-inline-only text elements (terra-text) or has the potential to completely break accessibility if something non-text based would be passed in.
+* `labelText` prop's type changed from node to string.
+* `legend` prop's type changed from node to string.
+
+##### Steps to Upgrade
+To upgrade from 3.0 to 4.0 each existing Radio must be reviewed and updated to ensure only a string is being passed to the `labelText` and `legend ` props. Solutions passing node data types need to be reworked to provide only a string.
+
 ## Changes from version 2 to version 3
 
 ### Changes to CSS Custom Properties

diff --git a/packages/terra-form-select/CHANGELOG.md b/packages/terra-form-select/CHANGELOG.md
@@ -3,6 +3,9 @@ ChangeLog
 
 Unreleased
 ----------
+### Breaking Changes
+* `label` prop's type changed from node to string.
+
 ### Changed
 * Fixed `onBlur` event for mobile to not be triggered when selecting an option
 

diff --git a/packages/terra-form-select/src/ComboboxField.jsx b/packages/terra-form-select/src/ComboboxField.jsx
@@ -17,7 +17,7 @@ const propTypes = {
   /**
    * The field label.
    */
-  label: PropTypes.node.isRequired,
+  label: PropTypes.string.isRequired,
   /**
    * The default value of the select. Can be a string, number, or array of strings/numbers.
    */

diff --git a/packages/terra-form-select/src/MultiSelectField.jsx b/packages/terra-form-select/src/MultiSelectField.jsx
@@ -14,7 +14,7 @@ const propTypes = {
   /**
    * The field label.
    */
-  label: PropTypes.node.isRequired,
+  label: PropTypes.string.isRequired,
   /**
    * The default value of the select. Can be a string, number, or array of strings/numbers.
    */

diff --git a/packages/terra-form-select/src/SearchSelectField.jsx b/packages/terra-form-select/src/SearchSelectField.jsx
@@ -17,7 +17,7 @@ const propTypes = {
   /**
    * The field label.
    */
-  label: PropTypes.node.isRequired,
+  label: PropTypes.string.isRequired,
   /**
    * The default value of the select. Can be a string, number, or array of strings/numbers.
    */

diff --git a/packages/terra-form-select/src/SelectField.jsx b/packages/terra-form-select/src/SelectField.jsx
@@ -18,7 +18,7 @@ const propTypes = {
   /**
    * The field label.
    */
-  label: PropTypes.node.isRequired,
+  label: PropTypes.string.isRequired,
   /**
    * The default value of the select. Can be a string, number, or array of strings/numbers.
    */

diff --git a/packages/terra-form-select/src/SingleSelectField.jsx b/packages/terra-form-select/src/SingleSelectField.jsx
@@ -17,7 +17,7 @@ const propTypes = {
   /**
    * The field label.
    */
-  label: PropTypes.node.isRequired,
+  label: PropTypes.string.isRequired,
   /**
    * The default value of the select. Can be a string, number, or array of strings/numbers.
    */

diff --git a/packages/terra-form-select/src/TagSelectField.jsx b/packages/terra-form-select/src/TagSelectField.jsx
@@ -14,7 +14,7 @@ const propTypes = {
   /**
    * The field label.
    */
-  label: PropTypes.node.isRequired,
+  label: PropTypes.string.isRequired,
   /**
    * The default value of the select. Can be a string, number, or array of strings/numbers.
    */

diff --git a/...es/terra-form-select/src/terra-dev-site/doc/form-select/UpgradeGuide.13.doc.mdx b/...es/terra-form-select/src/terra-dev-site/doc/form-select/UpgradeGuide.13.doc.mdx
@@ -4,6 +4,17 @@ import { Badge } from 'terra-form-select/package.json?dev-site-package';
 
 # Terra Form Select Upgrade Guide
 
+## Changes from version 5 to version 6
+
+### Props
+
+#### Updated
+* Form Fields allowed the `label` to be a node, which potentially breaks the display when injecting other non-inline-only text elements (terra-text) or has the potential to completely break accessibility if something non-text based would be passed in.
+* `label` prop's type changed from node to string.
+
+##### Steps to Upgrade
+To upgrade from 5.0 to 6.0 each existing Select must be reviewed and updated to ensure only a string is being passed to the `label` props. Solutions passing node data types need to be reworked to provide only a string.
+
 ## Changes from version 4 to version 5
 
 ### Changes to CSS Custom Properties

diff --git a/packages/terra-form-textarea/CHANGELOG.md b/packages/terra-form-textarea/CHANGELOG.md
@@ -3,6 +3,8 @@ ChangeLog
 
 Unreleased
 ----------
+### Breaking Changes
+* `label` prop's type changed from node to string.
 
 3.38.0 - (March 10, 2020)
 ------------------

diff --git a/packages/terra-form-textarea/src/TextareaField.jsx b/packages/terra-form-textarea/src/TextareaField.jsx
@@ -12,7 +12,7 @@ const propTypes = {
   /**
    * The label of the form control children.
    */
-  label: PropTypes.node.isRequired,
+  label: PropTypes.string.isRequired,
   /**
    * The defaultValue of the input field. Use this to create an uncontrolled input.
    */

diff --git a/...terra-form-textarea/src/terra-dev-site/doc/form-textarea/UpgradeGuide.3.doc.mdx b/...terra-form-textarea/src/terra-dev-site/doc/form-textarea/UpgradeGuide.3.doc.mdx
@@ -4,6 +4,17 @@ import { Badge } from 'terra-form-textarea/package.json?dev-site-package';
 
 # Terra Form Textarea Upgrade Guide
 
+## Changes from version 3 to version 4
+
+### Props
+
+#### Updated
+* Form Fields allowed the `label` to be a node, which potentially breaks the display when injecting other non-inline-only text elements (terra-text) or has the potential to completely break accessibility if something non-text based would be passed in.
+* `label` prop's type changed from node to string.
+
+##### Steps to Upgrade
+To upgrade from 3.0 to 4.0 each existing Textarea must be reviewed and updated to ensure only a string is being passed to the `label` props. Solutions passing node data types need to be reworked to provide only a string.
+
 ## Changes from version 2 to version 3
 
 ### Changes to CSS Custom Properties