fix: Deprecate options.tooltip

great-expectations · Jun 25, 2024 · 6fae156 · 6fae156
1 parent c43b5f2
commit 6fae156
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 37 deletions.
diff --git a/src/controls/TextControl.test.tsx b/src/controls/TextControl.test.tsx
@@ -140,8 +140,24 @@ test("renders tooltips", async () => {
         scope: "#/properties/name",
         label: "Name",
         options: {
-          tooltip:
-            "Choose <a href='https://wheelofnames.com/' target='_blank' rel='noopener noreferrer'>a random name</a>.",
+          formItemProps: {
+            tooltip: {
+              title: (
+                <p>
+                  Choose{" "}
+                  <a
+                    href="https://wheelofnames.com/"
+                    target="_blank"
+                    rel="noopener noreferrer"
+                  >
+                    a random name
+                  </a>
+                  .
+                </p>
+              ),
+              placement: "right",
+            },
+          },
         },
       },
     ],

diff --git a/src/stories/controls/TextControl.stories.tsx b/src/stories/controls/TextControl.stories.tsx
@@ -139,7 +139,19 @@ export const FormItemTooltip: Story = {
           label: "Name",
           formItemProps: {
             tooltip: {
-              title: "It's what you call yourself",
+              title: (
+                <p>
+                  Choose{" "}
+                  <a
+                    href="https://wheelofnames.com/"
+                    target="_blank"
+                    rel="noopener noreferrer"
+                  >
+                    a random name
+                  </a>
+                  .
+                </p>
+              ),
               placement: "right",
             },
           },
@@ -148,36 +160,3 @@ export const FormItemTooltip: Story = {
     } satisfies UISchema<typeof schema>,
   },
 }
-
-export const OptionsTooltip: Story = {
-  parameters: { controls: { expanded: true } },
-  tags: ["autodocs"],
-  args: {
-    jsonSchema: schema,
-    uiSchema: {
-      type: "VerticalLayout",
-      elements: [
-        {
-          type: "Control",
-          scope: "#/properties/name",
-          label: "Name",
-          options: {
-            tooltip: (
-              <p>
-                Choose{" "}
-                <a
-                  href="https://wheelofnames.com/"
-                  target="_blank"
-                  rel="noopener noreferrer"
-                >
-                  a random name
-                </a>
-                .
-              </p>
-            ),
-          },
-        },
-      ],
-    } satisfies UISchema<typeof schema>,
-  },
-}
diff --git a/src/ui-schema.ts b/src/ui-schema.ts
@@ -155,7 +155,10 @@ export type AnyOfControlOptions = OneOfControlOptions
 export type TextControlType = "multiline" | "password" | "singleline"
 
 export type TextControlOptions = {
-  tooltip?: React.ReactNode
+  /**
+  * @deprecated Please use formItemProps.tooltip instead
+  */
+  tooltip?: string
   placeholderText?: string
   required?: boolean
   rules?: AntDRule[]