@dxos/react-ui-menu 0.8.4-main.c85a9c8dae → 0.8.4-main.d05539e30a

package/LICENSE

@@ -1,8 +1,105 @@
-MIT License
-Copyright (c) 2024 DXOS
+# Functional Source License, Version 1.1, ALv2 Future License
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+## Abbreviation
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+FSL-1.1-Apache-2.0
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+## Notice
+
+Copyright 2026 DXOS
+
+## Terms and Conditions
+
+### Licensor ("We")
+
+The party offering the Software under these Terms and Conditions.
+
+### The Software
+
+The "Software" is each version of the software that we make available under
+these Terms and Conditions, as indicated by our inclusion of these Terms and
+Conditions with the Software.
+
+### License Grant
+
+Subject to your compliance with this License Grant and the Patents,
+Redistribution and Trademark clauses below, we hereby grant you the right to
+use, copy, modify, create derivative works, publicly perform, publicly display
+and redistribute the Software for any Permitted Purpose identified below.
+
+### Permitted Purpose
+
+A Permitted Purpose is any purpose other than a Competing Use. A Competing Use
+means making the Software available to others in a commercial product or
+service that:
+
+1. substitutes for the Software;
+
+2. substitutes for any other product or service we offer using the Software
+   that exists as of the date we make the Software available; or
+
+3. offers the same or substantially similar functionality as the Software.
+
+Permitted Purposes specifically include using the Software:
+
+1. for your internal use and access;
+
+2. for non-commercial education;
+
+3. for non-commercial research; and
+
+4. in connection with professional services that you provide to a licensee
+   using the Software in accordance with these Terms and Conditions.
+
+### Patents
+
+To the extent your use for a Permitted Purpose would necessarily infringe our
+patents, the license grant above includes a license under our patents. If you
+make a claim against any party that the Software infringes or contributes to
+the infringement of any patent, then your patent license to the Software ends
+immediately.
+
+### Redistribution
+
+The Terms and Conditions apply to all copies, modifications and derivatives of
+the Software.
+
+If you redistribute any copies, modifications or derivatives of the Software,
+you must include a copy of or a link to these Terms and Conditions and not
+remove any copyright notices provided in or with the Software.
+
+### Disclaimer
+
+THE SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTIES OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING WITHOUT LIMITATION WARRANTIES OF FITNESS FOR A PARTICULAR
+PURPOSE, MERCHANTABILITY, TITLE OR NON-INFRINGEMENT.
+
+IN NO EVENT WILL WE HAVE ANY LIABILITY TO YOU ARISING OUT OF OR RELATED TO THE
+SOFTWARE, INCLUDING INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES,
+EVEN IF WE HAVE BEEN INFORMED OF THEIR POSSIBILITY IN ADVANCE.
+
+### Trademarks
+
+Except for displaying the License Details and identifying us as the origin of
+the Software, you have no right under these Terms and Conditions to use our
+trademarks, trade names, service marks or product names.
+
+## Grant of Future License
+
+We hereby irrevocably grant you an additional license to use the Software under
+the Apache License, Version 2.0 that is effective on the second anniversary of
+the date we make the Software available. On or after that date, you may use the
+Software under the Apache License, Version 2.0, in which case the following
+will apply:
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use
+this file except in compliance with the License.
+
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed
+under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied. See the License for the
+specific language governing permissions and limitations under the License.

package/dist/lib/browser/index.mjs

@@ -2,7 +2,7 @@
 import { Atom, RegistryContext, useAtomValue } from "@effect-atom/atom-react";
 import { createContextScope } from "@radix-ui/react-context";
 import { useControllableState as useControllableState2 } from "@radix-ui/react-use-controllable-state";
-import React4, { useCallback as useCallback3, useContext, useMemo } from "react";
+import React4, { createContext, useCallback as useCallback3, useContext, useMemo } from "react";
 import { log } from "@dxos/log";
 import { Icon as Icon3, DropdownMenu as NaturalDropdownMenu2 } from "@dxos/react-ui";
 
@@ -77,18 +77,7 @@ import React from "react";
 import { keySymbols } from "@dxos/keyboard";
 import { toLocalizedString, useTranslation } from "@dxos/react-ui";
 import { mx } from "@dxos/ui-theme";
-
-// src/translations.ts
-var translationKey = "@dxos/react-ui-menu";
-var translations = [
-  {
-    "en-US": {
-      [translationKey]: {}
-    }
-  }
-];
-
-// src/components/ActionLabel.tsx
+import { translationKey } from "#translations";
 var ActionLabel = ({ action }) => {
   const { t } = useTranslation(translationKey);
   const shortcut = getShortcut(action);
@@ -104,10 +93,11 @@ var actionLabel = (action, t) => {
 };
 
 // src/components/ToolbarMenu.tsx
-import React3, { Fragment, useCallback as useCallback2 } from "react";
+import React3, { useCallback as useCallback2 } from "react";
 import { Icon as Icon2, Toolbar as NaturalToolbar, useTranslation as useTranslation2 } from "@dxos/react-ui";
 import { useAttention } from "@dxos/react-ui-attention";
-import { mx as mx2, textBlockWidth, toolbarLayout } from "@dxos/ui-theme";
+import { composable, composableProps } from "@dxos/ui-theme";
+import { translationKey as translationKey2 } from "#translations";
 
 // src/types.ts
 import { Node as Node2 } from "@dxos/app-graph";
@@ -187,21 +177,11 @@ var DropdownMenu = {
 };
 
 // src/components/ToolbarMenu.tsx
-var ActionToolbarItem = ({ action, __menuScope }) => {
+var ActionToolbarItem = ({ __menuScope, action }) => {
   const { iconSize, onAction } = useMenuScoped("ActionToolbarItem", __menuScope);
-  const { t } = useTranslation2(translationKey);
-  const { icon, iconOnly = true, disabled, testId, hidden, classNames } = action.properties;
-  const Root = icon ? NaturalToolbar.IconButton : NaturalToolbar.Button;
-  const rootProps = icon ? {
-    icon,
-    size: iconSize,
-    iconOnly,
-    label: actionLabel(action, t)
-  } : {
-    children: /* @__PURE__ */ React3.createElement(ActionLabel, {
-      action
-    })
-  };
+  const { t } = useTranslation2(translationKey2);
+  const { icon, iconOnly = true, disabled, testId, hidden, classNames, iconClassNames } = action.properties;
+  const buttonVariant = action.properties.variant === "primary" ? "primary" : "ghost";
   const handleClick = useCallback2(() => {
     if (onAction) {
       onAction(action, {});
@@ -212,32 +192,49 @@ var ActionToolbarItem = ({ action, __menuScope }) => {
     action,
     onAction
   ]);
-  return hidden ? null : /* @__PURE__ */ React3.createElement(Root, {
-    key: action.id,
+  const commonProps = {
+    variant: buttonVariant,
     disabled,
+    classNames,
     onClick: handleClick,
-    variant: "ghost",
     ...testId && {
       "data-testid": testId
-    },
-    ...rootProps,
-    classNames
-  });
+    }
+  };
+  if (hidden) {
+    return null;
+  }
+  return icon ? /* @__PURE__ */ React3.createElement(NaturalToolbar.IconButton, {
+    key: action.id,
+    ...commonProps,
+    icon,
+    size: iconSize,
+    iconOnly,
+    iconClassNames,
+    label: actionLabel(action, t)
+  }) : /* @__PURE__ */ React3.createElement(NaturalToolbar.Button, {
+    key: action.id,
+    ...commonProps
+  }, /* @__PURE__ */ React3.createElement(ActionLabel, {
+    action
+  }));
 };
-var DropdownMenuToolbarItem = ({ group, items: propsItems, __menuScope }) => {
+var DropdownMenuToolbarItem = ({ __menuScope, group, items: propsItems }) => {
   const { iconOnly, disabled, testId } = group.properties;
-  const { t } = useTranslation2(translationKey);
+  const { t } = useTranslation2(translationKey2);
   const { iconSize } = useMenuScoped("DropdownMenuToolbarItem", __menuScope);
   const items = useMenuItems(group, propsItems, "DropdownMenuToolbarItem", __menuScope);
   const activeItem = items?.find((item) => !!item.properties.checked);
   const icon = group.properties.applyActive && // TODO(thure): Handle other menu item types.
   activeItem?.properties.icon || group.properties.icon;
+  const iconClassNames = group.properties.applyActive && activeItem?.properties.iconClassNames || group.properties.iconClassNames;
   const Root = icon ? NaturalToolbar.IconButton : NaturalToolbar.Button;
   const labelAction = group.properties.applyActive && activeItem ? activeItem : group;
   const rootProps = icon ? {
     icon,
     size: iconSize,
     iconOnly,
+    iconClassNames,
     label: actionLabel(labelAction, t),
     caretDown: true
   } : {
@@ -263,10 +260,10 @@ var DropdownMenuToolbarItem = ({ group, items: propsItems, __menuScope }) => {
     }
   })));
 };
-var ToggleGroupItem = ({ group, action, __menuScope }) => {
+var ToggleGroupItem = ({ __menuScope, group, action }) => {
   const { iconSize, onAction } = useMenuScoped("ToggleGroupItem", __menuScope);
-  const { t } = useTranslation2(translationKey);
-  const { icon, iconOnly = true, disabled, testId, hidden, classNames } = action.properties;
+  const { t } = useTranslation2(translationKey2);
+  const { icon, iconOnly = true, disabled, testId, hidden, classNames, iconClassNames } = action.properties;
   const handleClick = useCallback2(() => {
     if (onAction) {
       onAction(action, {
@@ -282,74 +279,64 @@ var ToggleGroupItem = ({ group, action, __menuScope }) => {
     group,
     onAction
   ]);
-  const Root = icon ? NaturalToolbar.ToggleGroupIconItem : NaturalToolbar.ToggleGroupItem;
-  const rootProps = icon ? {
-    icon,
-    size: iconSize,
-    iconOnly,
-    label: actionLabel(action, t)
-  } : {
-    children: /* @__PURE__ */ React3.createElement(ActionLabel, {
-      action
-    })
-  };
-  return hidden ? null : /* @__PURE__ */ React3.createElement(Root, {
-    key: action.id,
+  const commonProps = {
     value: action.id,
     disabled,
-    onClick: handleClick,
     variant: "ghost",
+    classNames,
+    onClick: handleClick,
     ...testId && {
       "data-testid": testId
-    },
-    ...rootProps,
-    classNames
-  });
+    }
+  };
+  return hidden ? null : icon ? /* @__PURE__ */ React3.createElement(NaturalToolbar.ToggleGroupIconItem, {
+    ...commonProps,
+    icon,
+    size: iconSize,
+    iconOnly,
+    iconClassNames,
+    label: actionLabel(action, t)
+  }) : /* @__PURE__ */ React3.createElement(NaturalToolbar.ToggleGroupItem, commonProps, /* @__PURE__ */ React3.createElement(ActionLabel, {
+    action
+  }));
 };
-var ToggleGroupToolbarItem = ({ group, items: propsItems, __menuScope }) => {
-  const items = useMenuItems(group, propsItems, "ToggleGroupToolbarItem", __menuScope);
-  const { selectCardinality, value } = group.properties;
-  return (
-    // TODO(thure): Fix.
-    // @ts-ignore
-    /* @__PURE__ */ React3.createElement(
-      NaturalToolbar.ToggleGroup,
-      {
-        type: selectCardinality,
-        value
-      },
-      // TODO(thure): Handle other menu item types.
-      items.map((action) => /* @__PURE__ */ React3.createElement(ToggleGroupItem, {
-        key: action.id,
-        group,
-        action
-      }))
-    )
-  );
+var ToggleGroupToolbarItem = ({ __menuScope, group, items: itemsProp }) => {
+  const items = useMenuItems(group, itemsProp, "ToggleGroupToolbarItem", __menuScope);
+  const { selectCardinality } = group.properties;
+  const children = items.map((action) => /* @__PURE__ */ React3.createElement(ToggleGroupItem, {
+    key: action.id,
+    group,
+    action
+  }));
+  if (selectCardinality === "multiple") {
+    return /* @__PURE__ */ React3.createElement(NaturalToolbar.ToggleGroup, {
+      type: "multiple",
+      value: group.properties.value
+    }, children);
+  } else {
+    return /* @__PURE__ */ React3.createElement(NaturalToolbar.ToggleGroup, {
+      type: "single",
+      value: group.properties.value
+    }, children);
+  }
 };
-var ToolbarMenu = ({ __menuScope, classNames, textBlockWidth: textBlockWidthProp, ...props }) => {
+var ToolbarMenu = composable(({ __menuScope, children, ...props }, forwardedRef) => {
   const items = useMenuItems(void 0, void 0, "ToolbarMenu", __menuScope);
   const { attendableId, alwaysActive } = useMenuScoped("ToolbarMenu", __menuScope);
   const { hasAttention } = useAttention(attendableId);
-  const InnerRoot = textBlockWidthProp ? "div" : Fragment;
-  const innerRootProps = textBlockWidthProp ? {
-    role: "none",
-    className: mx2(textBlockWidth, toolbarLayout, "h-full")
-  } : {};
   return /* @__PURE__ */ React3.createElement(NaturalToolbar.Root, {
-    ...props,
-    classNames: [
-      attendableId,
-      classNames
-    ],
+    ...composableProps(props, {
+      classNames: attendableId
+    }),
     disabled: !alwaysActive && !hasAttention,
-    layoutManaged: textBlockWidthProp
-  }, /* @__PURE__ */ React3.createElement(InnerRoot, innerRootProps, items?.map((item, i) => /* @__PURE__ */ React3.createElement(ToolbarMenuItem, {
-    key: item.id ?? i,
+    ref: forwardedRef
+  }, items?.map((item) => /* @__PURE__ */ React3.createElement(ToolbarMenuItem, {
+    key: item.id,
+    __menuScope,
     item
-  }))));
-};
-var ToolbarMenuItem = ({ item }) => {
+  })), children);
+});
+var ToolbarMenuItem = ({ __menuScope, item }) => {
   if (isSeparator(item)) {
     return /* @__PURE__ */ React3.createElement(NaturalToolbar.Separator, {
       variant: item.properties.variant
@@ -358,15 +345,18 @@ var ToolbarMenuItem = ({ item }) => {
   if (isMenuGroup(item)) {
     if (item.properties.variant === "dropdownMenu") {
       return /* @__PURE__ */ React3.createElement(DropdownMenuToolbarItem, {
+        __menuScope,
         group: item
       });
     } else {
       return /* @__PURE__ */ React3.createElement(ToggleGroupToolbarItem, {
+        __menuScope,
         group: item
       });
     }
   }
   return /* @__PURE__ */ React3.createElement(ActionToolbarItem, {
+    __menuScope,
     action: item
   });
 };
@@ -389,7 +379,7 @@ var menuContextDefaults = {
 };
 var [MenuContextProvider, useMenuScoped] = createMenuContext(MENU_NAME, menuContextDefaults);
 var useMenuScope = createMenuScope();
-var MenuDropdownContext = /* @__PURE__ */ React4.createContext({
+var MenuDropdownContext = /* @__PURE__ */ createContext({
   closeMenu: () => {
   }
 });
@@ -454,12 +444,7 @@ var resolveItems = (baseItems, group, entries) => {
       log.warn("multiple replacement entries found", {
         ids: replacements.map((r) => r.id).join(", "),
         using: replacements[0].id
-      }, {
-        F: __dxlog_file,
-        L: 152,
-        S: void 0,
-        C: (f, a) => f(...a)
-      });
+      }, { "~LogMeta": "~LogMeta", F: __dxlog_file, L: 94, S: void 0 });
     }
     return replacements[0].items;
   }
@@ -574,24 +559,22 @@ var Menu = {
 };
 
 // src/hooks/useMenuActions.ts
-import { RegistryContext as RegistryContext2, useAtomValue as useAtomValue2 } from "@effect-atom/atom-react";
-import { useCallback as useCallback4, useContext as useContext2, useRef } from "react";
+import { Atom as Atom2, RegistryContext as RegistryContext2, useAtomValue as useAtomValue2 } from "@effect-atom/atom-react";
+import { useCallback as useCallback4, useContext as useContext2, useMemo as useMemo2 } from "react";
 import { Graph, Node as Node3 } from "@dxos/app-graph";
 var useMenuActions = (props) => {
   const registry = useContext2(RegistryContext2);
   const menuGraphProps = useAtomValue2(props);
-  const graphRef = useRef(null);
-  if (!graphRef.current || graphRef.current.props !== menuGraphProps) {
+  const graph = useMemo2(() => {
     const newGraph = Graph.make({
       registry
     });
     newGraph.pipe(Graph.addNodes(menuGraphProps.nodes), Graph.addEdges(menuGraphProps.edges));
-    graphRef.current = {
-      graph: newGraph,
-      props: menuGraphProps
-    };
-  }
-  const graph = graphRef.current.graph;
+    return newGraph;
+  }, [
+    registry,
+    menuGraphProps
+  ]);
   const items = useCallback4((group) => {
     return graph.connections(group?.id || Node3.RootId, "child");
   }, [
@@ -601,6 +584,10 @@ var useMenuActions = (props) => {
     items
   };
 };
+var useMenuBuilder = (build, deps) => {
+  const atom = useMemo2(() => Atom2.make(build), deps);
+  return useMenuActions(atom);
+};
 
 // src/builder.ts
 import { invariant } from "@dxos/invariant";
@@ -614,24 +601,8 @@ var MenuBuilderImpl = class _MenuBuilderImpl {
     this._rootId = _rootId;
   }
   root(props) {
-    invariant(this._rootId === "root", "Root group can only be at the top level", {
-      F: __dxlog_file2,
-      L: 41,
-      S: this,
-      A: [
-        "this._rootId === 'root'",
-        "'Root group can only be at the top level'"
-      ]
-    });
-    invariant(this._data.nodes.find((node) => node.id === "root") === void 0, "Root group can only be created once", {
-      F: __dxlog_file2,
-      L: 42,
-      S: this,
-      A: [
-        "this._data.nodes.find((node) => node.id === 'root') === undefined",
-        "'Root group can only be created once'"
-      ]
-    });
+    invariant(this._rootId === "root", "Root group can only be at the top level", { "~LogMeta": "~LogMeta", F: __dxlog_file2, L: 16, S: this, A: ["this._rootId === 'root'", "'Root group can only be at the top level'"] });
+    invariant(this._data.nodes.find((node) => node.id === "root") === void 0, "Root group can only be created once", { "~LogMeta": "~LogMeta", F: __dxlog_file2, L: 17, S: this, A: ["this._data.nodes.find((node)=>node.id === 'root') === undefined", "'Root group can only be created once'"] });
     this._data.nodes.push(createMenuItemGroup("root", props));
     return this;
   }
@@ -657,13 +628,20 @@ var MenuBuilderImpl = class _MenuBuilderImpl {
     cb(new _MenuBuilderImpl(this._data, id));
     return this;
   }
-  subgraph(subgraph) {
-    this._data.nodes.push(...subgraph.nodes);
-    this._data.edges.push(...subgraph.edges);
+  subgraph(subgraphOrCb) {
+    if (!subgraphOrCb) {
+      return this;
+    }
+    if (typeof subgraphOrCb === "function") {
+      subgraphOrCb(new _MenuBuilderImpl(this._data, this._rootId));
+    } else {
+      this._data.nodes.push(...subgraphOrCb.nodes);
+      this._data.edges.push(...subgraphOrCb.edges);
+    }
     return this;
   }
-  separator(id, variant = "gap") {
-    id ??= `separator-${++this._separatorCount}`;
+  separator(variant = "gap") {
+    const id = `separator-${++this._separatorCount}`;
     this._data.nodes.push({
       id,
       type: MenuSeparatorType,
@@ -699,6 +677,7 @@ export {
   menuContextDefaults,
   useMenu,
   useMenuActions,
+  useMenuBuilder,
   useMenuItems,
   useMenuScoped
 };