fix(react): deprecate troublesome enums

wso2 · Oct 11, 2024 · a63a8c1 · a63a8c1
1 parent 262b1c9
commit a63a8c1
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/packages/react/src/components/IconButton/IconButton.tsx b/packages/react/src/components/IconButton/IconButton.tsx
@@ -26,6 +26,10 @@ import type {WithWrapperProps} from '../../models/component';
 import composeComponentDisplayName from '../../utils/compose-component-display-name';
 import './icon-button.scss';
 
+/**
+ * @deprecated Use the string literal i.e. "contained" or "text" instead.
+ * This will be removed in the next major release (v2.0.0).
+ */
 export enum IconButtonVariants {
   CONTAINED = 'contained',
   TEXT = 'text',
@@ -43,7 +47,7 @@ export type IconButtonProps<
   /**
    * The variant of the icon button.
    */
-  variant?: IconButtonVariants;
+  variant?: IconButtonVariants | 'contained' | 'text';
 } & Omit<MuiIconButtonProps<D, P>, 'component'>;
 
 const COMPONENT_NAME: string = 'IconButton';

diff --git a/packages/react/src/components/TextField/TextField.tsx b/packages/react/src/components/TextField/TextField.tsx
@@ -36,6 +36,10 @@ import ListItemText from '../ListItemText';
 import Tooltip from '../Tooltip';
 import './text-field.scss';
 
+/**
+ * @deprecated Use the string literal i.e. "password" or "text" instead.
+ * This will be removed in the next major release (v2.0.0).
+ */
 export enum TextFieldInputTypes {
   INPUT_PASSWORD = 'password',
   INPUT_TEXT = 'text',
@@ -70,7 +74,7 @@ const PasswordField: ForwardRefExoticComponent<TextFieldProps> & WithWrapperProp
     return (
       <MuiTextField
         ref={ref}
-        type={showPassword ? TextFieldInputTypes.INPUT_TEXT : TextFieldInputTypes.INPUT_PASSWORD}
+        type={showPassword ? 'text' : 'password'}
         InputProps={{
           endAdornment: (
             <InputAdornment position="end">