From dd22e01394c6086d450758e0dfae10e3dd6479fc Mon Sep 17 00:00:00 2001 From: Titani Date: Mon, 23 Oct 2023 15:16:46 -0400 Subject: [PATCH] updates from review --- .../src/components/TextInput/TextInput.tsx | 14 ++++++++------ .../src/components/TextInput/examples/TextInput.md | 2 +- 2 files changed, 9 insertions(+), 7 deletions(-) diff --git a/packages/react-core/src/components/TextInput/TextInput.tsx b/packages/react-core/src/components/TextInput/TextInput.tsx index 9628f193391..282928b5c07 100644 --- a/packages/react-core/src/components/TextInput/TextInput.tsx +++ b/packages/react-core/src/components/TextInput/TextInput.tsx @@ -26,8 +26,10 @@ export enum TextInputReadOnlyVariant { plain = 'plain' } -interface TextinputExpandedObj { +export interface TextInputExpandedObj { + /** Flag to apply expanded styling. */ isExpanded: boolean; + /** Id of the element that the text input is controlling expansion of. */ ariaControls: string; } @@ -38,10 +40,10 @@ export interface TextInputProps className?: string; /** Flag to show if the text input is disabled. */ isDisabled?: boolean; - /** @deprecated Flag to apply expanded styling */ + /** @deprecated Flag to apply expanded styling. expandedProps should now be used instead. */ isExpanded?: boolean; - /** Prop to apply expanded styling to the text input and link it toe the element it is controlling. This should be used when the input controls a menu and tha menu is expanded. */ - expandedProps?: TextinputExpandedObj; + /** Prop to apply expanded styling to the text input and link it to the element it is controlling. This should be used when the input controls a menu and that menu is expandable. */ + expandedProps?: TextInputExpandedObj; /** Sets the input as readonly and determines the readonly styling. */ readOnlyVariant?: 'plain' | 'default'; /** Flag indicating whether the input is required */ @@ -201,7 +203,7 @@ export class TextInputBase extends React.Component