refactor(FormLabel): convert FormLabel to TypeScript

carbon-design-system · Aug 23, 2023 · 095f94e · 095f94e
1 parent 5a99bf3
commit 095f94e
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 1 deletion.
diff --git a/...act/src/components/FormLabel/FormLabel.js → ...ct/src/components/FormLabel/FormLabel.tsx b/...act/src/components/FormLabel/FormLabel.js → ...ct/src/components/FormLabel/FormLabel.tsx
@@ -10,7 +10,30 @@ import React from 'react';
 import cx from 'classnames';
 import { usePrefix } from '../../internal/usePrefix';
 
-function FormLabel({ className: customClassName, children, id, ...rest }) {
+export interface FormLabelProps
+  extends Omit<React.LabelHTMLAttributes<HTMLLabelElement>, 'htmlFor'> {
+  /**
+   * Specify the content of the form label
+   */
+  children?: React.ReactNode;
+
+  /**
+   * Provide a custom className to be applied to the containing <label> node
+   */
+  className?: string;
+
+  /**
+   * Provide a unique id for the given <FormLabel>
+   */
+  id?: string;
+}
+
+function FormLabel({
+  className: customClassName,
+  children,
+  id,
+  ...rest
+}: FormLabelProps) {
   const prefix = usePrefix();
   const className = cx(
     `${prefix}--label`,

diff --git a/...s/react/src/components/FormLabel/index.js → ...s/react/src/components/FormLabel/index.ts b/...s/react/src/components/FormLabel/index.js → ...s/react/src/components/FormLabel/index.ts