@itwin/itwinui-react 5.0.0-alpha.11 → 5.0.0-alpha.13

package/dist/bricks/Toolbar.d.ts

@@ -0,0 +1,35 @@
+import { type BaseProps } from "./~utils.js";
+interface ToolbarProps extends BaseProps {
+    /** Must be set to `"solid"` for now. */
+    variant: "solid";
+}
+/**
+ * A toolbar for grouping related interactive elements.
+ *
+ * Follows the [ARIA Toolbar pattern](https://www.w3.org/WAI/ARIA/apg/patterns/toolbar/) for reducing the number of tab stops.
+ *
+ * Example:
+ * ```jsx
+ * <Toolbar.Group variant="solid">
+ *   <Toolbar.Item render={…} />
+ *   <Toolbar.Item render={…} />
+ *   <Toolbar.Item render={…} />
+ * </Toolbar.Group>
+ * ```
+ */
+declare const ToolbarGroup: import("react").ForwardRefExoticComponent<ToolbarProps & import("react").RefAttributes<HTMLElement | HTMLDivElement>>;
+interface ToolbarItemProps extends Omit<BaseProps<"button">, "render">, Required<Pick<BaseProps, "render">> {
+}
+/**
+ * An item within the toolbar.
+ * Should be used with the `render` prop.
+ *
+ * Example:
+ * ```jsx
+ * <Toolbar.Item
+ *   render={<IconButton variant="ghost" … />}
+ * />
+ * ```
+ */
+declare const ToolbarItem: import("react").ForwardRefExoticComponent<ToolbarItemProps & import("react").RefAttributes<HTMLElement | HTMLButtonElement>>;
+export { ToolbarGroup as Group, ToolbarItem as Item };

package/dist/bricks/Toolbar.js

@@ -0,0 +1,23 @@
+import { jsx } from "react/jsx-runtime";
+import cx from "classnames";
+import * as Toolbar from "@ariakit/react/toolbar";
+import { forwardRef } from "./~utils.js";
+const ToolbarGroup = forwardRef((props, forwardedRef) => {
+  return /* @__PURE__ */ jsx(
+    Toolbar.Toolbar,
+    {
+      ...props,
+      className: cx("\u{1F95D}-toolbar", props.className),
+      ref: forwardedRef
+    }
+  );
+});
+const ToolbarItem = forwardRef(
+  (props, forwardedRef) => {
+    return /* @__PURE__ */ jsx(Toolbar.ToolbarItem, { ...props, ref: forwardedRef });
+  }
+);
+export {
+  ToolbarGroup as Group,
+  ToolbarItem as Item
+};

package/dist/bricks/TreeItem.d.ts

@@ -1,5 +1,4 @@
 import * as React from "react";
-import { IconButton } from "./IconButton.js";
 import { type BaseProps } from "./~utils.js";
 interface TreeItemRootProps extends Omit<BaseProps, "content" | "children"> {
     /** Specifies the nesting level of the tree item. Nesting levels start at 1. */
@@ -62,23 +61,46 @@ interface TreeItemRootProps extends Omit<BaseProps, "content" | "children"> {
     /** Secondary line of text to display additional information about the tree item. */
     description?: React.ReactNode;
     /**
-     * The actions available for the tree item. Must be a list of `Tree.ItemAction` components.
+     * The secondary actions available for the tree item. Must be a list of `Tree.ItemAction` components.
      *
      * Example:
      * ```tsx
      * actions={[
+     *   error && <Tree.ItemAction key={…} icon={…} label={…} />,
      *   <Tree.ItemAction key={…} icon={…} label={…} />,
      *   <Tree.ItemAction key={…} icon={…} label={…} />,
      * ]}
      * ```
+     *
+     * Excess actions will automatically get collapsed into an overflow menu.
+     * - Normally, the third action and onwards will overflow.
+     * - When the `error` prop is set, the _second_ action and onwards will overflow.
+     *
+     * The actions are normally hidden until the treeitem is hovered or focused.
+     * When the `error` prop is set, the actions will be made visible by default. The first
+     * action slot can be used to display an error-related action.
+     *
+     * ```tsx
+     * actions={[
+     *   error && <Tree.ItemAction key={…} icon={…} label={…} />,
+     *   <Tree.ItemAction key={…} icon={…} label={…} />,
+     *   <Tree.ItemAction key={…} icon={…} label={…} />,
+     * ]}
+     * ```
+     *
+     * @experimental
      */
     actions?: React.ReactNode[];
     /**
      * Specifies if the tree item is in an error state.
+     * The id for an associated error message (e.g. `<ErrorRegion.Item>`) can be passed as a string.
+     *
+     * Can be combined with the `actions` prop to display an error-related action (e.g. "Retry").
+     * The first action will be made visible by default.
      *
      * @default false
      */
-    error?: boolean;
+    error?: boolean | string;
 }
 /**
  * A treeitem is a node in a tree structure that may be expanded or collapsed to reveal or hide its descendants.
@@ -107,23 +129,55 @@ interface TreeItemRootProps extends Omit<BaseProps, "content" | "children"> {
  * Secondary actions can be passed into the `actions` prop.
  */
 declare const TreeItemRoot: React.ForwardRefExoticComponent<TreeItemRootProps & React.RefAttributes<HTMLElement | HTMLDivElement>>;
-type IconButtonProps = React.ComponentProps<typeof IconButton>;
-interface TreeItemActionProps extends BaseProps<"button">, Pick<IconButtonProps, "label" | "icon"> {
+interface TreeItemActionProps extends Omit<BaseProps<"button">, "children"> {
+    /**
+     * Label for the action.
+     *
+     * Will be displayed as a tooltip when the action is an icon-button,
+     * otherwise will be displayed as a label inside the menu-item.
+     */
+    label: string;
+    /**
+     * Icon for the action.
+     *
+     * Can be a URL of an SVG from the `@itwin/itwinui-icons` package, or a JSX element.
+     *
+     * Required when the action is displayed as an icon-button (i.e. not overflowing).
+     */
+    icon?: string | React.JSX.Element;
     /**
-     * Controls the visibility of the action.
+     * Controls the visibility of the action (only when the action is displayed as icon-button).
      *
      * If `true`, the action is always visible.
      * If `false`, the action is hidden and becomes inaccessible, but still occupies space.
      *
-     * By default, the action is shown only when the treeitem receives hover/focus.
+     * By default, the action is shown only when the treeitem receives hover/focus. When the
+     * treeitem has an `error`, the action will become always visible (i.e. it will default
+     * to `true` when `error` is set).
      */
     visible?: boolean;
+    /**
+     * A small dot displayed in the corner of the action.
+     *
+     * The value of this prop gets used as the button's "accessible description".
+     *
+     * Example:
+     * ```tsx
+     * <Tree.ItemAction
+     *   label="Filter"
+     *   dot="Some filters applied"
+     *   icon={…}
+     * />
+     * ```
+     */
+    dot?: string;
 }
 /**
  * A secondary action for `<Tree.Item>`, to be passed into the `actions` prop. The action is typically
- * displayed as an icon-button on the right end of the treeitem.
+ * displayed as an icon-button or a menu-item (e.g. when overflowing).
  *
- * By default, the action appears only on hover/focus. This can be controlled by the `visible` prop.
+ * By default, the action appears only when the treeitem has hover/focus or an error. This behavior can
+ * be overridden using the `visible` prop.
  */
 declare const TreeItemAction: React.ForwardRefExoticComponent<TreeItemActionProps & React.RefAttributes<HTMLElement | HTMLButtonElement>>;
 export { TreeItemRoot as Root, TreeItemAction as Action };

package/dist/bricks/TreeItem.js

@@ -2,15 +2,17 @@ import { jsx, jsxs } from "react/jsx-runtime";
 import * as React from "react";
 import cx from "classnames";
 import { Role } from "@ariakit/react/role";
+import { PopoverProvider } from "@ariakit/react/popover";
 import {
   CompositeItem
 } from "@ariakit/react/composite";
-import { Toolbar } from "@ariakit/react/toolbar";
+import { Toolbar, ToolbarItem } from "@ariakit/react/toolbar";
 import * as ListItem from "./~utils.ListItem.js";
 import { IconButton } from "./IconButton.js";
-import { Icon, StatusWarning } from "./Icon.js";
+import * as DropdownMenu from "./DropdownMenu.js";
+import { ChevronDown, Icon, StatusWarning, MoreHorizontal } from "./Icon.js";
 import { forwardRef } from "./~utils.js";
-import { useEventHandlers } from "./~hooks.js";
+import { useEventHandlers, useSafeContext } from "./~hooks.js";
 import { GhostAligner, useGhostAlignment } from "./~utils.GhostAligner.js";
 const TreeItemContext = React.createContext(void 0);
 const TreeItemRoot = forwardRef(
@@ -49,13 +51,22 @@ const TreeItemRoot = forwardRef(
     const labelId = React.useId();
     const descriptionId = React.useId();
     const decorationId = React.useId();
+    const errorId = typeof error === "string" ? error : void 0;
     const icon = error ? /* @__PURE__ */ jsx(StatusWarning, {}) : iconProp;
     const describedBy = React.useMemo(() => {
       const idRefs = [];
       if (description) idRefs.push(descriptionId);
       if (unstable_decorations || icon) idRefs.push(decorationId);
+      if (errorId) idRefs.push(errorId);
       return idRefs.length > 0 ? idRefs.join(" ") : void 0;
-    }, [unstable_decorations, icon, decorationId, description, descriptionId]);
+    }, [
+      unstable_decorations,
+      icon,
+      decorationId,
+      description,
+      descriptionId,
+      errorId
+    ]);
     return /* @__PURE__ */ jsx(
       TreeItemContext.Provider,
       {
@@ -63,9 +74,10 @@ const TreeItemRoot = forwardRef(
           () => ({
             level,
             expanded,
-            selected
+            selected,
+            error
           }),
-          [level, expanded, selected]
+          [level, expanded, selected, error]
         ),
         children: /* @__PURE__ */ jsx(
           CompositeItem,
@@ -142,30 +154,103 @@ const TreeItemRoot = forwardRef(
   }
 );
 const TreeItemActions = forwardRef((props, forwardedRef) => {
-  return /* @__PURE__ */ jsx(
+  const { children, ...rest } = props;
+  const actions = React.Children.toArray(children).filter(Boolean);
+  const { error } = useSafeContext(TreeItemContext);
+  const limit = error ? 2 : 3;
+  return /* @__PURE__ */ jsxs(
     Toolbar,
     {
-      ...props,
+      ...rest,
       onClick: useEventHandlers(props.onClick, (e) => e.stopPropagation()),
       onKeyDown: useEventHandlers(props.onKeyDown, (e) => e.stopPropagation()),
       className: cx("\u{1F95D}-tree-item-actions-container", props.className),
+      focusLoop: false,
       ref: forwardedRef,
-      children: props.children
+      children: [
+        actions.slice(0, limit - 1),
+        actions.length === limit ? actions[limit - 1] : null,
+        actions.length > limit ? /* @__PURE__ */ jsx(TreeItemActionsOverflowMenu, { children: actions.slice(limit - 1) }) : null
+      ]
     }
   );
 });
+const arrowKeys = ["ArrowDown", "ArrowUp", "ArrowLeft", "ArrowRight"];
+const TreeItemActionsOverflowMenuContext = React.createContext(false);
+function TreeItemActionsOverflowMenu({ children }) {
+  const [open, setOpen] = React.useState(false);
+  const isArrowKeyPressed = React.useRef(false);
+  return /* @__PURE__ */ jsx(PopoverProvider, { placement: "right-start", children: /* @__PURE__ */ jsxs(
+    DropdownMenu.Root,
+    {
+      open,
+      setOpen: React.useCallback((value) => {
+        if (value && !isArrowKeyPressed.current) {
+          setOpen(true);
+        } else {
+          setOpen(false);
+        }
+      }, []),
+      children: [
+        /* @__PURE__ */ jsx(
+          DropdownMenu.Button,
+          {
+            onKeyDown: (e) => {
+              if (arrowKeys.includes(e.key)) {
+                isArrowKeyPressed.current = true;
+              }
+              queueMicrotask(() => {
+                isArrowKeyPressed.current = false;
+              });
+            },
+            render: /* @__PURE__ */ jsx(TreeItemAction, { label: "More", icon: /* @__PURE__ */ jsx(MoreHorizontal, {}) })
+          }
+        ),
+        /* @__PURE__ */ jsx(TreeItemActionsOverflowMenuContext.Provider, { value: true, children: /* @__PURE__ */ jsx(DropdownMenu.Content, { children }) })
+      ]
+    }
+  ) });
+}
 const TreeItemAction = forwardRef(
   (props, forwardedRef) => {
-    const { visible, ...rest } = props;
+    const { error } = useSafeContext(TreeItemContext);
+    const {
+      visible = error ? true : void 0,
+      // visible by default during error state
+      label,
+      icon,
+      dot,
+      ...rest
+    } = props;
+    if (React.useContext(TreeItemActionsOverflowMenuContext)) {
+      return /* @__PURE__ */ jsx(
+        DropdownMenu.Item,
+        {
+          ...rest,
+          label,
+          icon,
+          unstable_dot: dot,
+          ref: forwardedRef
+        }
+      );
+    }
     return /* @__PURE__ */ jsx(
-      IconButton,
+      ToolbarItem,
       {
-        inert: visible === false ? true : void 0,
-        ...rest,
-        variant: "ghost",
-        className: cx("\u{1F95D}-tree-item-action", props.className),
-        "data-kiwi-visible": visible,
-        ref: forwardedRef
+        render: /* @__PURE__ */ jsx(
+          IconButton,
+          {
+            label,
+            icon,
+            inert: visible === false ? true : void 0,
+            ...rest,
+            dot,
+            variant: "ghost",
+            className: cx("\u{1F95D}-tree-item-action", props.className),
+            "data-kiwi-visible": visible,
+            ref: forwardedRef
+          }
+        )
       }
     );
   }
@@ -188,30 +273,7 @@ const TreeItemExpander = forwardRef(
         "data-kiwi-variant": "ghost",
         "data-kiwi-ghost-align": useGhostAlignment(),
         ref: forwardedRef,
-        children: /* @__PURE__ */ jsx(TreeChevron, {})
-      }
-    );
-  }
-);
-const TreeChevron = forwardRef(
-  (props, forwardedRef) => {
-    return /* @__PURE__ */ jsx(
-      Icon,
-      {
-        ...props,
-        render: /* @__PURE__ */ jsx(
-          Role.svg,
-          {
-            width: "16",
-            height: "16",
-            fill: "currentColor",
-            viewBox: "0 0 16 16",
-            render: props.render,
-            children: /* @__PURE__ */ jsx("path", { d: "M4.146 6.146a.5.5 0 0 1 .708 0L8 9.293l3.146-3.147a.5.5 0 0 1 .708.708l-3.5 3.5a.5.5 0 0 1-.708 0l-3.5-3.5a.5.5 0 0 1 0-.708Z" })
-          }
-        ),
-        className: cx("\u{1F95D}-tree-chevron", props.className),
-        ref: forwardedRef
+        children: /* @__PURE__ */ jsx(ChevronDown, {})
       }
     );
   }

package/dist/bricks/index.d.ts

@@ -7,10 +7,11 @@ export { Checkbox } from "./Checkbox.js";
 export { Chip } from "./Chip.js";
 export { Description } from "./Description.js";
 export * as DropdownMenu from "./DropdownMenu.js";
+export * as unstable_ErrorRegion from "./ErrorRegion.js";
 export { Divider } from "./Divider.js";
 export { Icon } from "./Icon.js";
 export { IconButton } from "./IconButton.js";
-export { Field } from "./Field.js";
+export * as Field from "./Field.js";
 export { Kbd } from "./Kbd.js";
 export { Label } from "./Label.js";
 export { ProgressBar } from "./ProgressBar.js";
@@ -19,9 +20,11 @@ export * as Select from "./Select.js";
 export { Spinner } from "./Spinner.js";
 export { Skeleton } from "./Skeleton.js";
 export { Switch } from "./Switch.js";
+export * as Table from "./Table.js";
 export * as Tabs from "./Tabs.js";
 export { Text } from "./Text.js";
 export * as TextBox from "./TextBox.js";
-export * as Tree from "./Tree.js";
+export * as unstable_Toolbar from "./Toolbar.js";
 export { Tooltip } from "./Tooltip.js";
+export * as Tree from "./Tree.js";
 export { VisuallyHidden } from "./VisuallyHidden.js";

package/dist/bricks/index.js

@@ -8,10 +8,11 @@ import { Checkbox } from "./Checkbox.js";
 import { Chip } from "./Chip.js";
 import { Description } from "./Description.js";
 import * as DropdownMenu from "./DropdownMenu.js";
+import * as unstable_ErrorRegion from "./ErrorRegion.js";
 import { Divider } from "./Divider.js";
 import { Icon } from "./Icon.js";
 import { IconButton } from "./IconButton.js";
-import { Field } from "./Field.js";
+import * as Field from "./Field.js";
 import { Kbd } from "./Kbd.js";
 import { Label } from "./Label.js";
 import { ProgressBar } from "./ProgressBar.js";
@@ -20,11 +21,13 @@ import * as Select from "./Select.js";
 import { Spinner } from "./Spinner.js";
 import { Skeleton } from "./Skeleton.js";
 import { Switch } from "./Switch.js";
+import * as Table from "./Table.js";
 import * as Tabs from "./Tabs.js";
 import { Text } from "./Text.js";
 import * as TextBox from "./TextBox.js";
-import * as Tree from "./Tree.js";
+import * as unstable_Toolbar from "./Toolbar.js";
 import { Tooltip } from "./Tooltip.js";
+import * as Tree from "./Tree.js";
 import { VisuallyHidden } from "./VisuallyHidden.js";
 export {
   Anchor,
@@ -48,10 +51,13 @@ export {
   Skeleton,
   Spinner,
   Switch,
+  Table,
   Tabs,
   Text,
   TextBox,
   Tooltip,
   Tree,
-  VisuallyHidden
+  VisuallyHidden,
+  unstable_ErrorRegion,
+  unstable_Toolbar
 };