Add example of using container in ControlledBubbleMenu

sjdemartini · Jun 23, 2023 · 3f3b395 · 3f3b395
1 parent 3dd99a3
commit 3f3b395
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/src/ControlledBubbleMenu.tsx b/src/ControlledBubbleMenu.tsx
@@ -33,6 +33,20 @@ export type ControlledBubbleMenuProps = {
    * (like the `ref` of a MUI <Dialog />), for instance, so that this bubble
    * menu can still appear on top of that, without needing to use messy z-index
    * overrides.
+   *
+   * Example:
+   *
+   * <Dialog open={open} ref={dialogRef}>
+   *   <RichTextEditor ...>
+   *     {() => (
+   *       <>
+   *         <MyControlledBubbleMenu container={dialogRef.current} />
+   *         <LinkBubbleMenu container={dialogRef.current} />
+   *         <TableBubbleMenu container={dialogRef.current} />
+   *       </>
+   *     )}
+   *   </RichTextEditor>
+   * </Dialog>
    */
   container?: PopperProps["container"];
   /**