From cb58eace8967372697b7e0456598afd780b886ae Mon Sep 17 00:00:00 2001
From: Arno V <versini@gmail.com>
Date: Mon, 1 Apr 2024 09:17:01 -0400
Subject: [PATCH] feat(ui-form): adding support for labelHidden prop (#457)

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit


- **New Features**
- Added a `labelHidden` property to TextInput and TextInputMask
components to toggle label visibility while ensuring accessibility.
- **Refactor**
- Removed unused code related to button and icon components in
TextInputMask.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
---
 .../src/Form/TextInput.stories.tsx            |  1 +
 .../src/Form/TextInputMask.stories.tsx        |  1 +
 .../src/components/TextInput/TextInput.tsx    |  3 ++-
 .../components/TextInput/TextInputMask.tsx    | 14 ++------------
 .../components/TextInput/TextInputTypes.d.ts  |  4 ++++
 .../TextInput/__tests__/TextInput.test.tsx    | 14 ++++++++++++++
 .../__tests__/TextInputMask.test.tsx          | 19 +++++++++++++++++++
 7 files changed, 43 insertions(+), 13 deletions(-)

diff --git a/packages/documentation/src/Form/TextInput.stories.tsx b/packages/documentation/src/Form/TextInput.stories.tsx
index 4cad27ec..c112ddd1 100644
--- a/packages/documentation/src/Form/TextInput.stories.tsx
+++ b/packages/documentation/src/Form/TextInput.stories.tsx
@@ -20,6 +20,7 @@ export default {
 		inputClassName: "",
 		className: "",
 		mode: "system",
+		labelHidden: false,
 	},
 	argTypes: {
 		mode: {
diff --git a/packages/documentation/src/Form/TextInputMask.stories.tsx b/packages/documentation/src/Form/TextInputMask.stories.tsx
index 83062b2c..52189183 100644
--- a/packages/documentation/src/Form/TextInputMask.stories.tsx
+++ b/packages/documentation/src/Form/TextInputMask.stories.tsx
@@ -21,6 +21,7 @@ export default {
 		error: false,
 		inputClassName: "",
 		className: "",
+		labelHidden: false,
 	},
 	argTypes: {
 		focusMode: {
diff --git a/packages/ui-form/src/components/TextInput/TextInput.tsx b/packages/ui-form/src/components/TextInput/TextInput.tsx
index 8d054c1e..95b0dd99 100644
--- a/packages/ui-form/src/components/TextInput/TextInput.tsx
+++ b/packages/ui-form/src/components/TextInput/TextInput.tsx
@@ -23,6 +23,7 @@ export const TextInput = React.forwardRef<HTMLInputElement, TextInputProps>(
 			noBorder = false,
 
 			labelId,
+			labelHidden = false,
 			type = "text",
 
 			helperText = "",
@@ -79,7 +80,7 @@ export const TextInput = React.forwardRef<HTMLInputElement, TextInputProps>(
 						!raw && { style: { paddingRight: inputPaddingRight } })}
 					{...extraProps}
 				/>
-				{!raw && (
+				{!raw && !labelHidden && (
 					<label
 						aria-hidden={true}
 						htmlFor={inputId}
diff --git a/packages/ui-form/src/components/TextInput/TextInputMask.tsx b/packages/ui-form/src/components/TextInput/TextInputMask.tsx
index cfb7c8cd..a75fc34a 100644
--- a/packages/ui-form/src/components/TextInput/TextInputMask.tsx
+++ b/packages/ui-form/src/components/TextInput/TextInputMask.tsx
@@ -1,9 +1,7 @@
 import { useMergeRefs } from "@versini/ui-hooks";
-// import { IconHide, IconShow } from "@versini/ui-icons";
 import { LiveRegion } from "@versini/ui-private";
 import React, { useEffect, useRef, useState } from "react";
 
-// import { ButtonIcon } from "..";
 import { TextInput } from "./TextInput";
 import type { TextInputMaskProps } from "./TextInputTypes";
 
@@ -26,6 +24,7 @@ export const TextInputMask = React.forwardRef<
 			name,
 			disabled,
 			label,
+			labelHidden,
 			onMaskChange,
 
 			onChange,
@@ -164,6 +163,7 @@ export const TextInputMask = React.forwardRef<
 					ref={mergedInputRef}
 					name={name}
 					label={label}
+					labelHidden={labelHidden}
 					type={masked ? "password" : "text"}
 					disabled={disabled}
 					spacing={spacing}
@@ -178,16 +178,6 @@ export const TextInputMask = React.forwardRef<
 
 						disabled: disabled,
 					})}
-					// rightElement={
-					// 	<ButtonIcon
-					// 		label={buttonLabel}
-					// 		onClick={handleShowMaskButtonClick}
-					// 		onBlur={handleTextInputMaskBlur}
-					// 		disabled={disabled}
-					// 	>
-					// 		{masked ? <IconShow /> : <IconHide />}
-					// 	</ButtonIcon>
-					// }
 					{...otherProps}
 				/>
 
diff --git a/packages/ui-form/src/components/TextInput/TextInputTypes.d.ts b/packages/ui-form/src/components/TextInput/TextInputTypes.d.ts
index b32d2f37..928034f6 100644
--- a/packages/ui-form/src/components/TextInput/TextInputTypes.d.ts
+++ b/packages/ui-form/src/components/TextInput/TextInputTypes.d.ts
@@ -27,6 +27,10 @@ export type CommonTextInputProps = {
 	 * CSS class(es) to add to the actual textarea element.
 	 */
 	inputClassName?: string;
+	/**
+	 * Hides the label visually but retain accessible relationship with the TextInput.
+	 */
+	labelHidden?: boolean;
 	/**
 	 * Id to use for the TextInput label.
 	 */
diff --git a/packages/ui-form/src/components/TextInput/__tests__/TextInput.test.tsx b/packages/ui-form/src/components/TextInput/__tests__/TextInput.test.tsx
index 550b2511..54897e10 100644
--- a/packages/ui-form/src/components/TextInput/__tests__/TextInput.test.tsx
+++ b/packages/ui-form/src/components/TextInput/__tests__/TextInput.test.tsx
@@ -130,6 +130,20 @@ describe("TextInput modifiers", () => {
 		expect(input.className).toContain("border-transparent");
 	});
 
+	it("should render a text input with a hidden label", async () => {
+		render(
+			<TextInput
+				label="hello world"
+				name="toto"
+				labelHidden
+				data-testid="txtnpt-1"
+			/>,
+		);
+		const label = await screen.findAllByText("hello world");
+		screen.debug(label);
+		expect(label.length).toBe(1);
+	});
+
 	it("should render a raw text input with no styling", async () => {
 		render(<TextInput label="toto" name="toto" raw data-testid="txtnpt-1" />);
 		const input = await screen.findByTestId("txtnpt-1");
diff --git a/packages/ui-form/src/components/TextInput/__tests__/TextInputMask.test.tsx b/packages/ui-form/src/components/TextInput/__tests__/TextInputMask.test.tsx
index dc7ad0e7..7e5f4c77 100644
--- a/packages/ui-form/src/components/TextInput/__tests__/TextInputMask.test.tsx
+++ b/packages/ui-form/src/components/TextInput/__tests__/TextInputMask.test.tsx
@@ -102,6 +102,25 @@ describe("TextInputMask modifiers", () => {
 		expect(input.className).toContain("border-transparent");
 	});
 
+	it("should render a text input with a hidden label", async () => {
+		render(
+			<TextInputMask
+				label="hello world"
+				name="toto"
+				labelHidden
+				data-testid="txtnpt-1"
+				rightElement={
+					<ButtonIcon>
+						<IconHide />
+					</ButtonIcon>
+				}
+			/>,
+		);
+		const label = await screen.findAllByText("hello world");
+		screen.debug(label);
+		expect(label.length).toBe(1);
+	});
+
 	it("should render a raw text input with no styling", async () => {
 		render(
 			<TextInputMask