feat(menu): Better floating action button default behavior

mlaursen · mlaursen · commit 0cdeff72ac8c · 2022-01-30T16:55:31.000-07:00
diff --git a/packages/documentation/src/components/Demos/Menu/FloatingActionButtonMenus.md b/packages/documentation/src/components/Demos/Menu/FloatingActionButtonMenus.md
@@ -0,0 +1,2 @@
+Since the `DropdownMenu` supports all the props for a `Button`, you can render a
+`DropdownMenu` as a floating action button if needed.
diff --git a/packages/documentation/src/components/Demos/Menu/FloatingActionButtonMenus.tsx b/packages/documentation/src/components/Demos/Menu/FloatingActionButtonMenus.tsx
@@ -0,0 +1,28 @@
+import type { ReactElement } from "react";
+import { FABPosition } from "@react-md/button";
+import { MoreVertSVGIcon } from "@react-md/material-icons";
+
+import SimpleExample from "./SimpleExample";
+
+const positions: FABPosition[] = [
+  "top-left",
+  "top-right",
+  "bottom-left",
+  "bottom-right",
+];
+
+export default function FloatingActionButtonMenus(): ReactElement {
+  return (
+    <>
+      {positions.map((position) => (
+        <SimpleExample
+          id={`fab-menu-${position}`}
+          key={position}
+          aria-label="Options..."
+          floating={position}
+          buttonChildren={<MoreVertSVGIcon />}
+        />
+      ))}
+    </>
+  );
+}
diff --git a/packages/documentation/src/components/Demos/Menu/SimpleExample.tsx b/packages/documentation/src/components/Demos/Menu/SimpleExample.tsx
@@ -2,14 +2,17 @@ import type { ReactElement } from "react";
 import { HomeSVGIcon, InfoOutlineSVGIcon } from "@react-md/material-icons";
 import {
   DropdownMenu,
+  DropdownMenuProps,
   MenuItem,
   MenuItemLink,
   MenuItemSeparator,
 } from "@react-md/menu";
 
-export default function SimpleExamples(): ReactElement {
+export default function SimpleExample(
+  props: Partial<DropdownMenuProps>
+): ReactElement {
   return (
-    <DropdownMenu id="dropdown-menu-1" buttonChildren="Options...">
+    <DropdownMenu id="dropdown-menu-1" buttonChildren="Options..." {...props}>
       <MenuItem>Item 1</MenuItem>
       <MenuItem>Item 2</MenuItem>
       <MenuItem leftAddon={<HomeSVGIcon />}>Item 3 </MenuItem>
diff --git a/packages/documentation/src/components/Demos/Menu/index.tsx b/packages/documentation/src/components/Demos/Menu/index.tsx
@@ -5,13 +5,17 @@ import {
 } from "@react-md/menu";
 import { IconProvider } from "@react-md/icon";
 
+import { DemoConfig } from "../types";
 import DemoPage from "../DemoPage";
 
 import README from "./README.md";
 
 import SimpleExample from "./SimpleExample";
 import simpleExample from "./SimpleExample.md";
 
+import FloatingActionButtonMenus from "./FloatingActionButtonMenus";
+import floatingActionButtonMenus from "./FloatingActionButtonMenus.md";
+
 import ConfigurableDropdownMenu from "./ConfigurableDropdownMenu";
 import configurableDropdownMenu from "./ConfigurableDropdownMenu.md";
 
@@ -30,12 +34,18 @@ import menusWithFormComponents from "./MenusWithFormComponents.md";
 import HoverableMenus from "./HoverableMenus";
 import hoverableMenus from "./HoverableMenus.md";
 
-const demos = [
+const demos: DemoConfig[] = [
   {
     name: "Simple Example",
     description: simpleExample,
     children: <SimpleExample />,
   },
+  {
+    name: "Floating Action Button Menus",
+    description: floatingActionButtonMenus,
+    children: <FloatingActionButtonMenus />,
+    emulated: true,
+  },
   {
     name: "Configurable Dropdown Menu",
     description: configurableDropdownMenu,
diff --git a/packages/menu/src/DropdownMenu.tsx b/packages/menu/src/DropdownMenu.tsx
@@ -1,4 +1,5 @@
 import { ReactElement, RefObject, useState } from "react";
+import { FABPosition } from "@react-md/button";
 import { useUserInteractionMode } from "@react-md/utils";
 
 import { useMenuBarContext } from "./MenuBarProvider";
@@ -165,6 +166,11 @@ export function DropdownMenu({
     };
   }
 
+  let floating: FABPosition = null;
+  if (!menuitem) {
+    ({ floating = null } = props as DropdownMenuButtonProps);
+  }
+
   const [visible, setVisible] = useState(false);
   const { menuRef, menuProps, toggleRef, toggleProps } = useMenu<
     HTMLButtonElement | HTMLLIElement
@@ -181,6 +187,7 @@ export function DropdownMenu({
     onToggleMouseLeave: onMouseLeave,
     onMenuClick: propMenuProps?.onClick,
     onMenuKeyDown: propMenuProps?.onKeyDown,
+    floating,
     onEnter,
     onEntering,
     onEntered,
diff --git a/packages/menu/src/MenuButton.tsx b/packages/menu/src/MenuButton.tsx
@@ -31,9 +31,10 @@ export const MenuButton = forwardRef<HTMLButtonElement, MenuButtonProps>(
       iconAfter = true,
       iconRotatorProps,
       textIconSpacingProps,
-      theme = "clear",
-      themeType = "flat",
-      buttonType = "text",
+      floating,
+      theme = floating ? "secondary" : "clear",
+      themeType = floating ? "contained" : "flat",
+      buttonType = floating ? "icon" : "text",
       disableDropdownIcon = buttonType === "icon",
       children,
       visible,
@@ -58,6 +59,7 @@ export const MenuButton = forwardRef<HTMLButtonElement, MenuButtonProps>(
         theme={theme}
         themeType={themeType}
         buttonType={buttonType}
+        floating={floating}
       >
         <TextIconSpacing
           icon={icon}
diff --git a/packages/menu/src/__tests__/utils.ts b/packages/menu/src/__tests__/utils.ts
@@ -1,37 +1,109 @@
 import {
   BELOW_CENTER_ANCHOR,
   BELOW_INNER_LEFT_ANCHOR,
+  BOTTOM_INNER_LEFT_ANCHOR,
+  BOTTOM_INNER_RIGHT_ANCHOR,
   CENTER_RIGHT_ANCHOR,
+  TOP_INNER_LEFT_ANCHOR,
   TOP_INNER_RIGHT_ANCHOR,
   TOP_RIGHT_ANCHOR,
 } from "@react-md/utils";
+
 import { getDefaultAnchor } from "../utils";
 
 describe("getDefaultAnchor", () => {
   it("should return a default anchor based on the menubar, menuitem, and horizontal flags", () => {
     expect(
-      getDefaultAnchor({ menubar: true, menuitem: false, horizontal: false })
+      getDefaultAnchor({
+        menubar: false,
+        menuitem: false,
+        floating: "bottom-left",
+        horizontal: false,
+      })
+    ).toBe(BOTTOM_INNER_LEFT_ANCHOR);
+    expect(
+      getDefaultAnchor({
+        menubar: false,
+        menuitem: false,
+        floating: "bottom-right",
+        horizontal: false,
+      })
+    ).toBe(BOTTOM_INNER_RIGHT_ANCHOR);
+    expect(
+      getDefaultAnchor({
+        menubar: false,
+        menuitem: false,
+        floating: "top-left",
+        horizontal: false,
+      })
+    ).toBe(TOP_INNER_LEFT_ANCHOR);
+    expect(
+      getDefaultAnchor({
+        menubar: false,
+        menuitem: false,
+        floating: "top-right",
+        horizontal: false,
+      })
+    ).toBe(TOP_INNER_RIGHT_ANCHOR);
+
+    expect(
+      getDefaultAnchor({
+        menubar: true,
+        menuitem: false,
+        floating: null,
+        horizontal: false,
+      })
     ).toBe(BELOW_INNER_LEFT_ANCHOR);
     expect(
-      getDefaultAnchor({ menubar: true, menuitem: false, horizontal: true })
+      getDefaultAnchor({
+        menubar: true,
+        menuitem: false,
+        floating: null,
+        horizontal: true,
+      })
     ).toBe(BELOW_INNER_LEFT_ANCHOR);
     expect(
-      getDefaultAnchor({ menubar: true, menuitem: true, horizontal: false })
+      getDefaultAnchor({
+        menubar: true,
+        menuitem: true,
+        floating: null,
+        horizontal: false,
+      })
     ).toBe(CENTER_RIGHT_ANCHOR);
     expect(
-      getDefaultAnchor({ menubar: true, menuitem: true, horizontal: true })
+      getDefaultAnchor({
+        menubar: true,
+        menuitem: true,
+        floating: null,
+        horizontal: true,
+      })
     ).toBe(CENTER_RIGHT_ANCHOR);
 
     expect(
-      getDefaultAnchor({ menubar: false, menuitem: false, horizontal: true })
+      getDefaultAnchor({
+        menubar: false,
+        menuitem: false,
+        floating: null,
+        horizontal: true,
+      })
     ).toBe(BELOW_CENTER_ANCHOR);
 
     expect(
-      getDefaultAnchor({ menubar: false, menuitem: true, horizontal: false })
+      getDefaultAnchor({
+        menubar: false,
+        menuitem: true,
+        floating: null,
+        horizontal: false,
+      })
     ).toBe(TOP_RIGHT_ANCHOR);
 
     expect(
-      getDefaultAnchor({ menubar: false, menuitem: false, horizontal: false })
+      getDefaultAnchor({
+        menubar: false,
+        menuitem: false,
+        floating: null,
+        horizontal: false,
+      })
     ).toBe(TOP_INNER_RIGHT_ANCHOR);
   });
 });
diff --git a/packages/menu/src/useMenu.ts b/packages/menu/src/useMenu.ts
@@ -5,6 +5,7 @@ import {
   useEffect,
   useRef,
 } from "react";
+import { FABPosition } from "@react-md/button";
 import { useFixedPositioning } from "@react-md/transition";
 import { containsElement, useScrollLock } from "@react-md/utils";
 
@@ -27,6 +28,14 @@ export interface MenuHookOptions<ToggleEl extends HTMLElement>
    */
   disabled?: boolean;
 
+  /**
+   * This is just used to update the default anchor behavior.
+   *
+   * @see {@link FABPosition}
+   * @defaultValue `null`
+   */
+  floating?: FABPosition;
+
   /**
    * An optional click handler to merge with the
    * {@link MenuHookReturnValue.onClick} behavior.
@@ -161,6 +170,7 @@ export function useMenu<ToggleEl extends HTMLElement>(
     menuLabel,
     visible,
     setVisible,
+    floating = null,
     onMenuClick = noop,
     onMenuKeyDown = noop,
     onToggleClick = noop,
@@ -199,7 +209,7 @@ export function useMenu<ToggleEl extends HTMLElement>(
   // interacting with the menu
   const cancelExitFocus = useRef(false);
   const anchor =
-    propAnchor ?? getDefaultAnchor({ menubar, menuitem, horizontal });
+    propAnchor ?? getDefaultAnchor({ menubar, menuitem, floating, horizontal });
   const menuNodeRef = useRef<HTMLDivElement>(null);
   const toggleRef = useRef<ToggleEl | null>(null);
   const {
diff --git a/packages/menu/src/utils.ts b/packages/menu/src/utils.ts
@@ -1,8 +1,12 @@
+import { FABPosition } from "@react-md/button";
 import {
   BELOW_CENTER_ANCHOR,
   BELOW_INNER_LEFT_ANCHOR,
+  BOTTOM_INNER_LEFT_ANCHOR,
+  BOTTOM_INNER_RIGHT_ANCHOR,
   CENTER_RIGHT_ANCHOR,
   PositionAnchor,
+  TOP_INNER_LEFT_ANCHOR,
   TOP_INNER_RIGHT_ANCHOR,
   TOP_RIGHT_ANCHOR,
 } from "@react-md/utils";
@@ -22,6 +26,7 @@ export const noop = (): void => {
 interface DefaultAnchorOptions {
   menubar: boolean;
   menuitem: boolean;
+  floating: FABPosition;
   horizontal: boolean;
 }
 
@@ -32,8 +37,20 @@ interface DefaultAnchorOptions {
 export const getDefaultAnchor = ({
   menubar,
   menuitem,
+  floating,
   horizontal,
 }: DefaultAnchorOptions): PositionAnchor => {
+  switch (floating) {
+    case "bottom-left":
+      return BOTTOM_INNER_LEFT_ANCHOR;
+    case "bottom-right":
+      return BOTTOM_INNER_RIGHT_ANCHOR;
+    case "top-left":
+      return TOP_INNER_LEFT_ANCHOR;
+    case "top-right":
+      return TOP_INNER_RIGHT_ANCHOR;
+  }
+
   if (menubar) {
     return menuitem ? CENTER_RIGHT_ANCHOR : BELOW_INNER_LEFT_ANCHOR;
   }

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	+Since the `DropdownMenu` supports all the props for a `Button`, you can render a
	`2`	+`DropdownMenu` as a floating action button if needed.