feat: Deprecate InputIconContainer

Workday · Sep 7, 2023 · 20b164e · 20b164e
1 parent b0ece1d
commit 20b164e
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/modules/docs/mdx/10.0-UPGRADE_GUIDE.mdx b/modules/docs/mdx/10.0-UPGRADE_GUIDE.mdx
@@ -12,6 +12,7 @@ any questions.
 - [Removals](#removals)
   - [Menu (Preview)](#menu-preview)
 - [Deprecations](#deprecations)
+  - [InputIconContainer](#input-icon-container)
 - [Token Updates](#token-updates)
   - [Space and Depth](#space-and-depth)
 - [Component Updates](#component-updates)
@@ -70,6 +71,12 @@ Preview and the `Menu` in Main.
 
 ## Deprecations
 
+### Input Icon Container
+
+We've deprecated `InputIconContainer` from `TextInput` component, because it doesn't handle
+bidirectionality or icons at the start of an input. `InputGroup` should be used instead of
+deprecated `InputIconContainer`.
+
 ## Token Updates
 
 ### Space and Depth

diff --git a/modules/react/text-input/lib/InputIconContainer.tsx b/modules/react/text-input/lib/InputIconContainer.tsx
@@ -19,6 +19,10 @@ const IconContainer = styled('div')({
   right: space.xxs,
 });
 
+/**
+ * @deprecated
+ */
+
 export const InputIconContainer: React.FunctionComponent<React.PropsWithChildren<
   InputIconContainerProps
 >> = ({grow, children, icon}) => (