panelui-native 0.28.1 → 0.30.0

package/lib/module/components/menu/index.js

@@ -0,0 +1,714 @@
+"use strict";
+
+/**
+ * Menu — the list of things you can do to something.
+ *
+ * It is not a Select, and the difference is what the rows *are*. A select's
+ * rows are values: picking one answers a question the form asked, and the
+ * trigger then shows the answer. A menu's rows are verbs — rename, duplicate,
+ * delete — and the trigger goes on saying the same thing afterwards, because
+ * nothing about it was chosen. Anything built out of a popover and a column of
+ * pressables ends up re-deriving that distinction by hand, and re-deriving the
+ * roles, the dismiss-on-select rule and the destructive colour with it.
+ *
+ * ```tsx
+ * <Menu>
+ *   <Menu.Trigger>
+ *     <Button variant="outline">Options</Button>
+ *   </Menu.Trigger>
+ *   <Menu.Content align="start">
+ *     <Menu.Item icon={<PencilIcon size={16} />}>Rename</Menu.Item>
+ *     <Menu.Separator />
+ *     <Menu.Item variant="destructive" icon={<TrashIcon size={16} />}>
+ *       Delete
+ *     </Menu.Item>
+ *   </Menu.Content>
+ * </Menu>
+ * ```
+ *
+ * The panel is a `Popover` underneath, so the menu inherits its measuring,
+ * flipping and edge-clamping rather than owning a second copy of them — a menu
+ * near the bottom of the screen opens upwards for the same reason a popover
+ * does, and `presentation="bottom-sheet"` moves the same rows into a sheet.
+ *
+ * Submenus expand in place rather than flying out sideways. A flyout needs a
+ * pointer to travel from the parent row to the child panel without crossing
+ * anything that would close it; a finger has no such path, and a second panel
+ * hanging off the first is usually the thing that pushes a menu off the edge
+ * of a phone. Opening downwards into the panel keeps every row under the
+ * thumb that opened it.
+ */
+import { Children, createContext, isValidElement, useCallback, useContext, useEffect, useMemo, useState } from 'react';
+import { Pressable, View } from 'react-native';
+import Animated, { useAnimatedStyle, useReducedMotion, useSharedValue, withTiming } from 'react-native-reanimated';
+import { tv } from 'tailwind-variants';
+import { useCSSVariable } from 'uniwind';
+import { CheckIcon, ChevronRightIcon } from "../../icons/index.js";
+import { Text, textChildren } from "../../primitives/text.js";
+import { useDirectionSign } from "../../hooks/use-direction.js";
+import { selectionTick } from "../../utils/haptics.js";
+import { cn } from "../../utils/cn.js";
+import { Popover } from "../popover/index.js";
+
+/** Side of the column every indicator is drawn in. */
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+const INDICATOR_SIZE = 18;
+
+/**
+ * A theme token as a colour an icon will accept.
+ *
+ * `useCSSVariable` answers with whatever the token holds, which for a length
+ * or a number is not a colour at all — so anything that is not a string is
+ * dropped and the icon falls back to what it inherits.
+ */
+function useTint(variable) {
+  const raw = useCSSVariable(variable);
+  return typeof raw === 'string' ? raw : undefined;
+}
+
+/** How long a row takes to light up under a finger, and to let go again. */
+const PRESS_IN_DURATION = 90;
+const PRESS_OUT_DURATION = 160;
+
+/** How far a pressed row shrinks. Enough to feel, not enough to see move. */
+const PRESS_SCALE = 0.98;
+const menuVariants = tv({
+  slots: {
+    /*
+     * No background here: the panel's surface is a layer of its own, drawn by
+     * `Menu.Background` behind the rows, so that a caller can replace it with
+     * a gradient or a blur without also having to redraw the rows.
+     */
+    content: 'gap-0.5 rounded-3xl p-1.5',
+    background: 'absolute inset-0 rounded-3xl bg-overlay',
+    label: 'px-3 pb-1 pt-2',
+    item: 'w-full flex-row items-center gap-2.5 rounded-2xl px-2.5 py-2.5',
+    itemLabel: 'text-base font-medium text-overlay-foreground',
+    itemDescription: 'text-sm',
+    shortcut: 'text-xs tracking-widest',
+    separator: 'my-1 h-px bg-border',
+    indicator: 'items-center justify-center'
+  },
+  variants: {
+    variant: {
+      // The pressed fill is animated rather than switched, so it is not a
+      // class here — only what the animation cannot carry.
+      default: {},
+      /*
+       * The row is tinted rather than only recoloured. A red word on an
+       * otherwise ordinary row is easy to read past at a glance, and this is
+       * the one row in the menu where reading past it is expensive.
+       */
+      destructive: {
+        itemLabel: 'text-destructive'
+      }
+    },
+    disabled: {
+      true: {
+        item: 'opacity-[0.45]'
+      }
+    },
+    /** Reserves the indicator column on a row that has no indicator of its own. */
+    inset: {
+      true: {
+        item: 'ps-[38px]',
+        label: 'ps-[38px]'
+      }
+    }
+  },
+  defaultVariants: {
+    variant: 'default',
+    disabled: false,
+    inset: false
+  }
+});
+const AnimatedPressable = Animated.createAnimatedComponent(Pressable);
+
+/**
+ * The pressed state of a row, animated rather than switched.
+ *
+ * `active:` swaps a class wholesale, which lands the fill in one frame and
+ * takes it away in one frame — on a row the size of a menu item that reads as
+ * a flash rather than as a press. Interpolating a shared value fades it in and
+ * back out on the UI thread, and carries a shrink along with it that a class
+ * cannot express at all.
+ */
+function useMenuPress(variant) {
+  const reduced = useReducedMotion();
+  const pressed = useSharedValue(0);
+  const accent = useTint('--color-accent');
+  const destructive = useTint('--color-destructive-subtle');
+  const fill = variant === 'destructive' ? destructive : accent;
+
+  /*
+   * The fill is a layer with an animated opacity rather than an animated
+   * `backgroundColor`, because crossing *from* transparent needs a colour to
+   * cross from and the row has none of its own — what is behind it is whatever
+   * the panel's background layer happens to be. Fading the row itself would
+   * take the label with it, so only the fill fades.
+   */
+  const fillStyle = useAnimatedStyle(() => ({
+    opacity: pressed.value
+  }));
+  const rowStyle = useAnimatedStyle(() => ({
+    transform: [{
+      scale: 1 - (1 - PRESS_SCALE) * pressed.value
+    }]
+  }));
+  return {
+    rowStyle,
+    fillStyle,
+    fill,
+    onPressIn: () => {
+      pressed.value = reduced ? 1 : withTiming(1, {
+        duration: PRESS_IN_DURATION
+      });
+    },
+    onPressOut: () => {
+      pressed.value = reduced ? 0 : withTiming(0, {
+        duration: PRESS_OUT_DURATION
+      });
+    }
+  };
+}
+const MenuContext = /*#__PURE__*/createContext(null);
+function useMenu(component) {
+  const context = useContext(MenuContext);
+  if (!context) {
+    throw new Error(`${component} must be used within a <Menu>`);
+  }
+  return context;
+}
+function MenuRoot({
+  children,
+  open,
+  onOpenChange,
+  defaultOpen,
+  haptics = false,
+  ...props
+}) {
+  const [internalOpen, setInternalOpen] = useState(defaultOpen ?? false);
+  const isControlled = open !== undefined;
+
+  /*
+   * The open state is mirrored here as well as inside the popover, because a
+   * row has to be able to dismiss the panel it is sitting in and the popover
+   * only publishes that through `Popover.Close` — which wraps a child and so
+   * cannot be handed to a row that already owns its own press handler.
+   */
+  const setOpen = useCallback(next => {
+    if (!isControlled) setInternalOpen(next);
+    onOpenChange?.(next);
+  }, [isControlled, onOpenChange]);
+  const context = useMemo(() => ({
+    close: () => setOpen(false),
+    haptics
+  }), [setOpen, haptics]);
+  return /*#__PURE__*/_jsx(MenuContext.Provider, {
+    value: context,
+    children: /*#__PURE__*/_jsx(Popover, {
+      open: isControlled ? open : internalOpen,
+      onOpenChange: setOpen,
+      ...props,
+      children: children
+    })
+  });
+}
+/** Wraps a single child and opens the menu on press. Also what gets measured. */
+function MenuTrigger({
+  children
+}) {
+  return /*#__PURE__*/_jsx(Popover.Trigger, {
+    children: children
+  });
+}
+/**
+ * The panel, and the thing screen readers announce as a menu.
+ *
+ * Its padding is the row gutter rather than the popover's content padding —
+ * rows run to the panel's inner edge so that a pressed row's highlight reads
+ * as part of the panel instead of a floating chip inside it.
+ *
+ * The surface is a layer rather than a background on the panel itself, so that
+ * a caller can put something *behind* the rows. Pass a `Menu.Background` of
+ * your own with a gradient, an image or a blur inside it and it replaces the
+ * default one; pass nothing and the default is drawn for you.
+ */
+function MenuContent({
+  className,
+  children,
+  scrollable = true,
+  ...props
+}) {
+  const {
+    content
+  } = menuVariants();
+  const context = useMenu('Menu.Content');
+
+  /*
+   * A caller's own background replaces the default rather than stacking on top
+   * of it, and it is lifted out of the children so that it lands outside the
+   * scroller — a surface inside one scrolls away with the rows sitting on it.
+   */
+  const items = [];
+  let background = null;
+  for (const child of Children.toArray(children)) {
+    if (/*#__PURE__*/isValidElement(child) && child.type === MenuBackground) {
+      background = child;
+    } else {
+      items.push(child);
+    }
+  }
+  return /*#__PURE__*/_jsx(Popover.Content, {
+    accessibilityRole: "menu",
+    scrollable: scrollable,
+    unstyled: true,
+    background: background ?? /*#__PURE__*/_jsx(MenuBackground, {}),
+    className: cn(content(), 'shadow-lg', className),
+    ...props,
+    children: /*#__PURE__*/_jsx(MenuContext.Provider, {
+      value: context,
+      children: textChildren(items)
+    })
+  });
+}
+/**
+ * The panel's surface, drawn behind every row.
+ *
+ * It exists as a part rather than as a background on the panel because a
+ * background cannot be got behind. A menu that wants to be frosted, tinted or
+ * gradient-filled needs something under the rows and over nothing, and
+ * `overflow-hidden` on the panel is what keeps whatever that is inside the
+ * corner radius.
+ */
+function MenuBackground({
+  className,
+  children,
+  ...props
+}) {
+  const {
+    background
+  } = menuVariants();
+  return /*#__PURE__*/_jsx(View, {
+    accessibilityElementsHidden: true,
+    importantForAccessibility: "no-hide-descendants",
+    pointerEvents: "none",
+    className: cn(background(), className),
+    ...props,
+    children: children
+  });
+}
+/** Non-interactive heading over a run of rows. */
+function MenuLabel({
+  className,
+  inset,
+  children,
+  ...props
+}) {
+  const {
+    label
+  } = menuVariants({
+    inset
+  });
+  return /*#__PURE__*/_jsx(View, {
+    accessibilityRole: "header",
+    className: cn(label(), className),
+    ...props,
+    children: textChildren(children, text => /*#__PURE__*/_jsx(Text, {
+      size: "xs",
+      weight: "medium",
+      muted: true,
+      className: "uppercase tracking-wide",
+      children: text
+    }))
+  });
+}
+/** Hairline between two runs of rows. */
+function MenuSeparator({
+  className,
+  ...props
+}) {
+  const {
+    separator
+  } = menuVariants();
+  return /*#__PURE__*/_jsx(View, {
+    accessibilityElementsHidden: true,
+    importantForAccessibility: "no-hide-descendants",
+    className: cn(separator(), className),
+    ...props
+  });
+}
+/**
+ * One row of the menu.
+ *
+ * `onSelect` rather than `onPress` is the handler that closes the panel:
+ * `onPress` is still forwarded and still fires, so a row can keep whatever
+ * press behaviour it had, but the dismissal is tied to the semantic event so
+ * that a row which is disabled or which opts out via `closeOnSelect` behaves
+ * the same either way.
+ */
+function MenuItem({
+  className,
+  children,
+  icon,
+  description,
+  shortcut,
+  trailing,
+  variant = 'default',
+  inset,
+  disabled = false,
+  closeOnSelect = true,
+  onSelect,
+  onPress,
+  ...props
+}) {
+  const {
+    close,
+    haptics
+  } = useMenu('Menu.Item');
+  const slots = menuVariants({
+    variant,
+    disabled,
+    inset: inset && !icon
+  });
+  const press = useMenuPress(variant);
+  const handlePress = (...args) => {
+    if (disabled) return;
+    if (haptics) selectionTick();
+    onPress?.(...args);
+    onSelect?.();
+    if (closeOnSelect) close();
+  };
+  return /*#__PURE__*/_jsxs(AnimatedPressable, {
+    accessibilityRole: "menuitem",
+    accessibilityState: {
+      disabled
+    },
+    disabled: disabled,
+    onPress: handlePress,
+    onPressIn: press.onPressIn,
+    onPressOut: press.onPressOut,
+    style: press.rowStyle,
+    className: cn(slots.item(), 'overflow-hidden', className),
+    ...props,
+    children: [/*#__PURE__*/_jsx(Animated.View, {
+      pointerEvents: "none",
+      className: "absolute inset-0",
+      style: [press.fillStyle, {
+        backgroundColor: press.fill
+      }]
+    }), icon ? /*#__PURE__*/_jsx(MenuIndicatorSlot, {
+      children: icon
+    }) : null, /*#__PURE__*/_jsxs(View, {
+      className: "flex-1",
+      children: [textChildren(children, text => /*#__PURE__*/_jsx(Text, {
+        className: slots.itemLabel(),
+        children: text
+      })), description ? /*#__PURE__*/_jsx(Text, {
+        size: "xs",
+        muted: true,
+        className: slots.itemDescription(),
+        children: description
+      }) : null]
+    }), shortcut ? /*#__PURE__*/_jsx(Text, {
+      size: "xs",
+      muted: true,
+      className: slots.shortcut(),
+      children: shortcut
+    }) : null, trailing]
+  });
+}
+
+/**
+ * Fixed-width column the leading glyph sits in.
+ *
+ * Fixed rather than sized to its contents so that a checkmark appearing and
+ * disappearing does not shift the label beside it, and so that rows with and
+ * without a glyph line their labels up in the same panel.
+ */
+function MenuIndicatorSlot({
+  children
+}) {
+  const {
+    indicator
+  } = menuVariants();
+  return /*#__PURE__*/_jsx(View, {
+    className: indicator(),
+    style: {
+      width: INDICATOR_SIZE,
+      height: INDICATOR_SIZE
+    },
+    children: children
+  });
+}
+
+/**
+ * Placeholder that keeps the indicator column open on an unmarked row.
+ *
+ * `Menu.Item` draws no column at all when it has no icon, which is right for a
+ * row that will never have one — but wrong for a row whose mark appears and
+ * disappears as it is toggled.
+ */
+function MenuIndicatorSpacer() {
+  return /*#__PURE__*/_jsx(View, {});
+}
+/**
+ * A row that carries a state instead of running an action.
+ *
+ * It keeps the menu open by default, which is the opposite of `Menu.Item` and
+ * deliberately so: a set of toggles is nearly always set more than one at a
+ * time, and closing after each one turns three taps into six.
+ */
+function MenuCheckboxItem({
+  checked = false,
+  onCheckedChange,
+  onSelect,
+  closeOnSelect = false,
+  ...props
+}) {
+  const tint = useTint('--color-popover-foreground');
+  return /*#__PURE__*/_jsx(MenuItem, {
+    accessibilityRole: "menuitem",
+    accessibilityState: {
+      checked,
+      disabled: props.disabled ?? false
+    },
+    closeOnSelect: closeOnSelect
+    // An empty column rather than no column: the mark comes and goes as the
+    // row is toggled, and a row whose label steps sideways each time reads
+    // as a different row rather than the same one in a new state.
+    ,
+    icon: checked ? /*#__PURE__*/_jsx(CheckIcon, {
+      size: 16,
+      color: tint
+    }) : /*#__PURE__*/_jsx(MenuIndicatorSpacer, {}),
+    onSelect: () => {
+      onCheckedChange?.(!checked);
+      onSelect?.();
+    },
+    ...props
+  });
+}
+const MenuRadioContext = /*#__PURE__*/createContext(null);
+/** A run of rows of which exactly one is chosen. */
+function MenuRadioGroup({
+  value,
+  onValueChange,
+  className,
+  children,
+  ...props
+}) {
+  const context = useMemo(() => ({
+    value,
+    select: next => onValueChange?.(next)
+  }), [value, onValueChange]);
+  return /*#__PURE__*/_jsx(MenuRadioContext.Provider, {
+    value: context,
+    children: /*#__PURE__*/_jsx(View, {
+      accessibilityRole: "radiogroup",
+      className: className,
+      ...props,
+      children: children
+    })
+  });
+}
+/** One option inside a `Menu.RadioGroup`. */
+function MenuRadioItem({
+  value,
+  indicator = 'check',
+  onSelect,
+  closeOnSelect = true,
+  ...props
+}) {
+  const group = useContext(MenuRadioContext);
+  if (!group) {
+    throw new Error('Menu.RadioItem must be used within a <Menu.RadioGroup>');
+  }
+  const tint = useTint('--color-popover-foreground');
+  const selected = group.value === value;
+  return /*#__PURE__*/_jsx(MenuItem, {
+    accessibilityRole: "menuitem",
+    accessibilityState: {
+      selected,
+      disabled: props.disabled ?? false
+    },
+    closeOnSelect: closeOnSelect,
+    icon: selected ? indicator === 'dot' ? /*#__PURE__*/_jsx(View, {
+      className: "h-2 w-2 rounded-full bg-popover-foreground"
+    }) : /*#__PURE__*/_jsx(CheckIcon, {
+      size: 16,
+      color: tint
+    }) :
+    /*#__PURE__*/
+    // Held open, so the options stay in one column as the choice moves
+    // between them.
+    _jsx(MenuIndicatorSpacer, {}),
+    onSelect: () => {
+      group.select(value);
+      onSelect?.();
+    },
+    ...props
+  });
+}
+const MenuSubContext = /*#__PURE__*/createContext(null);
+function useMenuSub(component) {
+  const context = useContext(MenuSubContext);
+  if (!context) {
+    throw new Error(`${component} must be used within a <Menu.Sub>`);
+  }
+  return context;
+}
+/** Groups a `Menu.SubTrigger` with the rows it reveals. */
+function MenuSub({
+  children,
+  defaultOpen = false,
+  open,
+  onOpenChange
+}) {
+  const [internalOpen, setInternalOpen] = useState(defaultOpen);
+  const isControlled = open !== undefined;
+  const resolved = isControlled ? open : internalOpen;
+  const context = useMemo(() => ({
+    open: resolved,
+    toggle: () => {
+      if (!isControlled) setInternalOpen(!resolved);
+      onOpenChange?.(!resolved);
+    }
+  }), [resolved, isControlled, onOpenChange]);
+  return /*#__PURE__*/_jsx(MenuSubContext.Provider, {
+    value: context,
+    children: children
+  });
+}
+/**
+ * The row that opens a submenu.
+ *
+ * Its chevron points along the reading direction while closed and turns to
+ * point down once open, so the row states which way its rows will appear
+ * rather than only that it has some.
+ */
+function MenuSubTrigger({
+  className,
+  children,
+  icon,
+  onSelect,
+  ...props
+}) {
+  const {
+    open,
+    toggle
+  } = useMenuSub('Menu.SubTrigger');
+  const sign = useDirectionSign();
+  const reducedMotion = useReducedMotion();
+  const chevronTint = useTint('--color-muted-foreground');
+  const progress = useSharedValue(open ? 1 : 0);
+  useEffect(() => {
+    progress.value = reducedMotion ? open ? 1 : 0 : withTiming(open ? 1 : 0, {
+      duration: 180
+    });
+  }, [open, reducedMotion, progress]);
+
+  // 90° takes a chevron from pointing along the line of text to pointing down
+  // into the rows it is about to reveal. Mirrored under RTL, where the closed
+  // state points the other way to begin with.
+  const chevronStyle = useAnimatedStyle(() => ({
+    transform: [{
+      rotate: `${progress.value * 90 * sign}deg`
+    }]
+  }));
+  return /*#__PURE__*/_jsx(MenuItem, {
+    accessibilityState: {
+      expanded: open,
+      disabled: props.disabled ?? false
+    },
+    closeOnSelect: false,
+    icon: icon,
+    className: className,
+    trailing: /*#__PURE__*/_jsx(Animated.View, {
+      style: chevronStyle,
+      children: /*#__PURE__*/_jsx(ChevronRightIcon, {
+        size: 16,
+        color: chevronTint
+      })
+    }),
+    onSelect: () => {
+      toggle();
+      onSelect?.();
+    },
+    ...props,
+    children: children
+  });
+}
+/**
+ * The rows a submenu reveals, opening in place.
+ *
+ * The height is animated from a measurement rather than left to a layout
+ * animation, and the measured copy is absolutely positioned so it always lays
+ * out at its natural size — a child of a view whose height is mid-animation
+ * would otherwise report the animated height back, and the panel would settle
+ * at whatever it happened to measure on the first frame.
+ */
+function MenuSubContent({
+  className,
+  children,
+  ...props
+}) {
+  const {
+    open
+  } = useMenuSub('Menu.SubContent');
+  const reducedMotion = useReducedMotion();
+  const [height, setHeight] = useState(0);
+  const progress = useSharedValue(open ? 1 : 0);
+  useEffect(() => {
+    progress.value = reducedMotion ? open ? 1 : 0 : withTiming(open ? 1 : 0, {
+      duration: 200
+    });
+  }, [open, reducedMotion, progress]);
+  const style = useAnimatedStyle(() => ({
+    height: progress.value * height,
+    opacity: progress.value
+  }));
+  return /*#__PURE__*/_jsx(Animated.View, {
+    style: style,
+    className: "overflow-hidden",
+    children: /*#__PURE__*/_jsx(View, {
+      onLayout: event => setHeight(event.nativeEvent.layout.height),
+      style: {
+        position: 'absolute',
+        left: 0,
+        right: 0,
+        top: 0
+      },
+      className: cn('ms-4 gap-0.5 border-s border-border ps-1', className),
+      ...props,
+      children: children
+    })
+  });
+}
+MenuTrigger.displayName = 'Menu.Trigger';
+MenuContent.displayName = 'Menu.Content';
+MenuBackground.displayName = 'Menu.Background';
+MenuLabel.displayName = 'Menu.Label';
+MenuItem.displayName = 'Menu.Item';
+MenuCheckboxItem.displayName = 'Menu.CheckboxItem';
+MenuRadioGroup.displayName = 'Menu.RadioGroup';
+MenuRadioItem.displayName = 'Menu.RadioItem';
+MenuSeparator.displayName = 'Menu.Separator';
+MenuSub.displayName = 'Menu.Sub';
+MenuSubTrigger.displayName = 'Menu.SubTrigger';
+MenuSubContent.displayName = 'Menu.SubContent';
+export const Menu = Object.assign(MenuRoot, {
+  Trigger: MenuTrigger,
+  Content: MenuContent,
+  Background: MenuBackground,
+  Label: MenuLabel,
+  Item: MenuItem,
+  CheckboxItem: MenuCheckboxItem,
+  RadioGroup: MenuRadioGroup,
+  RadioItem: MenuRadioItem,
+  Separator: MenuSeparator,
+  Sub: MenuSub,
+  SubTrigger: MenuSubTrigger,
+  SubContent: MenuSubContent
+});
+//# sourceMappingURL=index.js.map