Update Tooltip.types.ts

mongodb · Apr 16, 2024 · e49bb01 · e49bb01
1 parent cb9f1ee
commit e49bb01
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/packages/tooltip/src/Tooltip/Tooltip.types.ts b/packages/tooltip/src/Tooltip/Tooltip.types.ts
@@ -54,6 +54,11 @@ export type TooltipProps = Omit<
     align?: Align;
     /**
      * A slot for the element used to trigger the `Tooltip`.
+     *
+     * Note: The component passed as `trigger` _must_ accept and render `children`,
+     * even if the general use of the component does not require children.
+     * The `tooltip` content is rendered (via `Popover`) as a child of the trigger,
+     * and if the trigger does not render any children, then the trigger will not be rendered.
      */
     trigger?: React.ReactElement | Function;