feat(odyssey-react-mui): update prop description

okta · Sep 9, 2024 · 220670e · 220670e
1 parent d6f094a
commit 220670e
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/packages/odyssey-react-mui/src/FieldComponentProps.ts b/packages/odyssey-react-mui/src/FieldComponentProps.ts
@@ -55,11 +55,17 @@ export type FieldComponentProps = {
   name?: string;
 } & (
   | {
+      /**
+       * If `hasVisibleLabel` is `false` it will also hide any `hint` text and `HintLinkComponent` that is passed in
+       */
       hasVisibleLabel?: false;
       hint: never;
       HintLinkComponent: never;
     }
   | {
+      /**
+       * defaults to `true` if `false` along with hiding the label it will also hide any `hint` text and `HintLinkComponent` that is passed in
+       */
       hasVisibleLabel?: true;
       /**
        * The helper text content.