chore: deprecate ControlledPasswordInput

carbon-design-system · Apr 22, 2021 · 9e1d205 · 9e1d205
1 parent 6e08ebd
commit 9e1d205
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 218 deletions.
diff --git a/packages/react/src/components/TextInput/ControlledPasswordInput-test.js b/packages/react/src/components/TextInput/ControlledPasswordInput-test.js
diff --git a/packages/react/src/components/TextInput/ControlledPasswordInput.js b/packages/react/src/components/TextInput/ControlledPasswordInput.js
@@ -4,9 +4,12 @@ import PropTypes from 'prop-types';
 import { settings } from 'carbon-components';
 import { View16, ViewOff16, WarningFilled16 } from '@carbon/icons-react';
 import { textInputProps } from './util';
+import { warning } from '../../internal/warning';
 
 const { prefix } = settings;
 
+let didWarnAboutDeprecation = false;
+
 const ControlledPasswordInput = React.forwardRef(
   function ControlledPasswordInput(
     {
@@ -34,6 +37,14 @@ const ControlledPasswordInput = React.forwardRef(
     },
     ref
   ) {
+    if (__DEV__) {
+      warning(
+        didWarnAboutDeprecation,
+        '`<TextInput.ControlledPasswordInput>` has been deprecated in favor of `<TextInput.PasswordInput />` and will be removed in the next major release of `carbon-components-react`'
+      );
+      didWarnAboutDeprecation = true;
+    }
+
     const errorId = id + '-error-msg';
     const textInputClasses = classNames(
       `${prefix}--text-input`,

diff --git a/packages/react/src/components/TextInput/TextInput-story.js b/packages/react/src/components/TextInput/TextInput-story.js
@@ -34,7 +34,7 @@ const ControlledPasswordInputApp = React.forwardRef(
     };
     return (
       <>
-        <TextInput.ControlledPasswordInput
+        <TextInput.PasswordInput
           type={type}
           togglePasswordVisibility={togglePasswordVisibility}
           ref={ref}
@@ -115,7 +115,7 @@ export default {
     },
     subcomponents: {
       TextInputSkeleton,
-      'TextInput.ControlledPasswordInput': TextInput.ControlledPasswordInput,
+      'TextInput.PasswordInput': TextInput.PasswordInput,
     },
   },
 };