@itwin/itwinui-react 5.0.0-alpha.1 → 5.0.0-alpha.10

package/dist/bricks/TextBox.d.ts

@@ -1,6 +1,5 @@
 import * as React from "react";
 import { Icon } from "./Icon.js";
-import { Textarea } from "./Textarea.js";
 import { type FocusableProps, type BaseProps } from "./~utils.js";
 interface BaseInputProps extends FocusableProps<"input"> {
 }
@@ -39,6 +38,28 @@ interface TextBoxInputProps extends Omit<BaseInputProps, "children" | "type"> {
  * For a multiline text input, use the `TextBox.Textarea` component.
  */
 declare const TextBoxInput: React.ForwardRefExoticComponent<TextBoxInputProps & React.RefAttributes<HTMLElement | HTMLInputElement>>;
+interface TextareaProps extends FocusableProps<"textarea"> {
+}
+/**
+ * A styled textarea element that allows users to enter multiline text values.
+ *
+ * Example usage:
+ * ```tsx
+ * <TextBox.Textarea defaultValue="Hello" />
+ * ```
+ *
+ * Works well with the `Field` and `Label` components.
+ * ```tsx
+ * <Field>
+ *   <Label>Leave a comment, be kind</Label>
+ *   <TextBox.Textarea />
+ * </Field>
+ * ```
+ *
+ * Underneath, it's an HTML textarea, i.e. `<textarea>`, so it supports the same props, including
+ * `value`, `defaultValue`, `onChange`, and `disabled`.
+ */
+declare const TextBoxTextarea: React.ForwardRefExoticComponent<TextareaProps & React.RefAttributes<HTMLElement | HTMLTextAreaElement>>;
 interface TextBoxRootProps extends BaseProps {
 }
 /**
@@ -76,4 +97,4 @@ interface TextBoxTextProps extends BaseProps<"span"> {
  * A static text decoration for the `TextBox.Root` component. Can be added before or after the `TextBox.Input`.
  */
 declare const TextBoxText: React.ForwardRefExoticComponent<TextBoxTextProps & React.RefAttributes<HTMLElement | HTMLSpanElement>>;
-export { TextBoxRoot as Root, TextBoxInput as Input, Textarea, TextBoxIcon as Icon, TextBoxText as Text, };
+export { TextBoxRoot as Root, TextBoxInput as Input, TextBoxTextarea as Textarea, TextBoxIcon as Icon, TextBoxText as Text, };

package/dist/bricks/TextBox.js

@@ -1,34 +1,71 @@
 import { jsx } from "react/jsx-runtime";
 import * as React from "react";
-import * as Ariakit from "@ariakit/react";
+import { Role } from "@ariakit/react/role";
+import { Focusable } from "@ariakit/react/focusable";
 import cx from "classnames";
-import { useFieldId } from "./Field.js";
+import { FieldControl } from "./Field.js";
 import { Icon } from "./Icon.js";
-import { Textarea } from "./Textarea.js";
 import { useMergedRefs } from "./~hooks.js";
 import { forwardRef } from "./~utils.js";
 const TextBoxInput = forwardRef(
   (props, forwardedRef) => {
-    const fieldId = useFieldId();
+    const { id, ...rest } = props;
     const rootContext = React.useContext(TextBoxRootContext);
     const setDisabled = rootContext?.setDisabled;
     React.useEffect(() => {
       setDisabled?.(props.disabled);
     }, [setDisabled, props.disabled]);
     return /* @__PURE__ */ jsx(
-      Ariakit.Role.input,
+      FieldControl,
       {
-        id: fieldId,
-        ...props,
-        className: cx({ "\u{1F95D}-text-box": !rootContext }, props.className),
+        type: "textlike",
+        id,
         render: /* @__PURE__ */ jsx(
-          Ariakit.Focusable,
+          Role.input,
           {
-            accessibleWhenDisabled: true,
-            render: props.render || /* @__PURE__ */ jsx("input", {})
+            readOnly: props.disabled,
+            ...rest,
+            className: cx({ "\u{1F95D}-text-box": !rootContext }, props.className),
+            placeholder: props.placeholder ?? " ",
+            render: /* @__PURE__ */ jsx(
+              Focusable,
+              {
+                accessibleWhenDisabled: true,
+                render: props.render || /* @__PURE__ */ jsx("input", {})
+              }
+            ),
+            ref: useMergedRefs(rootContext?.inputRef, forwardedRef)
           }
-        ),
-        ref: useMergedRefs(rootContext?.inputRef, forwardedRef)
+        )
+      }
+    );
+  }
+);
+const TextBoxTextarea = forwardRef(
+  (props, forwardedRef) => {
+    const { id, ...rest } = props;
+    return /* @__PURE__ */ jsx(
+      FieldControl,
+      {
+        type: "textlike",
+        id,
+        render: /* @__PURE__ */ jsx(
+          Role.textarea,
+          {
+            readOnly: props.disabled,
+            ...rest,
+            className: cx("\u{1F95D}-text-box", props.className),
+            placeholder: props.placeholder ?? " ",
+            render: /* @__PURE__ */ jsx(
+              Focusable,
+              {
+                accessibleWhenDisabled: true,
+                render: props.render || /* @__PURE__ */ jsx("textarea", {})
+              }
+            ),
+            ref: forwardedRef
+          }
+        )
       }
     );
   }
@@ -42,7 +79,7 @@ const TextBoxRoot = forwardRef(
       {
         value: React.useMemo(() => ({ setDisabled, inputRef }), []),
         children: /* @__PURE__ */ jsx(
-          Ariakit.Role.div,
+          Role.div,
           {
             ...props,
             "data-kiwi-disabled": disabled,
@@ -77,7 +114,7 @@ const TextBoxIcon = forwardRef(
 const TextBoxText = forwardRef(
   (props, forwardedRef) => {
     return /* @__PURE__ */ jsx(
-      Ariakit.Role.span,
+      Role.span,
       {
         ...props,
         className: cx("\u{1F95D}-text-box-decoration", props.className),
@@ -92,5 +129,5 @@ export {
   TextBoxInput as Input,
   TextBoxRoot as Root,
   TextBoxText as Text,
-  Textarea
+  TextBoxTextarea as Textarea
 };

package/dist/bricks/Tooltip.d.ts

@@ -1,7 +1,7 @@
 import * as React from "react";
-import * as Ariakit from "@ariakit/react";
+import * as AkTooltip from "@ariakit/react/tooltip";
 import { type FocusableProps } from "./~utils.js";
-interface TooltipProps extends Omit<FocusableProps<"div">, "content">, Pick<Ariakit.TooltipProps, "open" | "unmountOnHide">, Pick<Ariakit.TooltipProviderProps, "defaultOpen" | "setOpen"> {
+interface TooltipProps extends Omit<FocusableProps<"div">, "content">, Pick<AkTooltip.TooltipProps, "open" | "unmountOnHide">, Pick<AkTooltip.TooltipProviderProps, "defaultOpen" | "setOpen"> {
     /**
      * The content to be displayed inside the tooltip when the trigger element is hovered or focused.
      */

package/dist/bricks/Tooltip.js

@@ -1,38 +1,29 @@
 import { Fragment, jsx, jsxs } from "react/jsx-runtime";
 import * as React from "react";
 import cx from "classnames";
-import * as Ariakit from "@ariakit/react";
-import { forwardRef, supportsPopover } from "./~utils.js";
+import * as AkTooltip from "@ariakit/react/tooltip";
+import { useStoreState } from "@ariakit/react/store";
+import { forwardRef } from "./~utils.js";
+import { usePopoverApi } from "./~hooks.js";
 const Tooltip = forwardRef(
   (props, forwardedRef) => {
+    const generatedId = React.useId();
     const {
       content,
       children,
-      className,
       type = "description",
-      id = React.useId(),
+      id = generatedId,
       defaultOpen: defaultOpenProp,
       open: openProp,
       setOpen: setOpenProp,
       unmountOnHide = type === "none",
       ...rest
     } = props;
-    const store = Ariakit.useTooltipStore();
-    const open = Ariakit.useStoreState(store, (state) => state.open);
-    const popover = Ariakit.useStoreState(
-      store,
-      (state) => state.popoverElement
-    );
-    React.useEffect(
-      function syncPopoverWithOpenState() {
-        if (popover?.isConnected) {
-          popover?.togglePopover?.(open);
-        }
-      },
-      [open, popover]
-    );
+    const store = AkTooltip.useTooltipStore();
+    const open = useStoreState(store, (store2) => store2.open);
+    const popover = usePopoverApi(store);
     return /* @__PURE__ */ jsx(Fragment, { children: /* @__PURE__ */ jsxs(
-      Ariakit.TooltipProvider,
+      AkTooltip.TooltipProvider,
       {
         store,
         defaultOpen: defaultOpenProp,
@@ -40,28 +31,29 @@ const Tooltip = forwardRef(
         setOpen: setOpenProp,
         children: [
           /* @__PURE__ */ jsx(
-            Ariakit.TooltipAnchor,
+            AkTooltip.TooltipAnchor,
             {
               render: children,
+              "data-has-popover-open": open || void 0,
               ...type === "description" && { "aria-describedby": id },
               ...type === "label" && { "aria-labelledby": id }
             }
           ),
           /* @__PURE__ */ jsx(
-            Ariakit.Tooltip,
+            AkTooltip.Tooltip,
             {
               "aria-hidden": "true",
               ...rest,
               unmountOnHide,
-              className: cx("\u{1F95D}-tooltip", className),
+              className: cx("\u{1F95D}-tooltip", props.className),
               ref: forwardedRef,
               id,
               style: {
-                zIndex: supportsPopover ? void 0 : 9999,
+                ...popover.style,
                 ...props.style
               },
-              wrapperProps: { popover: "manual" },
-              portal: !supportsPopover,
+              wrapperProps: popover.wrapperProps,
+              portal: popover.portal,
               children: content
             }
           )

package/dist/bricks/Tree.d.ts

@@ -1,23 +1,22 @@
-import * as React from "react";
-import { IconButton } from "./IconButton.js";
 import { type BaseProps } from "./~utils.js";
+import { Root as TreeItemRoot, Action as TreeItemAction } from "./TreeItem.js";
 interface TreeProps extends BaseProps {
 }
-declare const Tree: React.ForwardRefExoticComponent<TreeProps & React.RefAttributes<HTMLElement | HTMLDivElement>>;
-interface TreeItemProps extends Omit<BaseProps, "content"> {
-    content?: React.ReactNode;
-    selected?: boolean;
-    /** Specifies if the tree item is expanded. Used to determine if a tree item is a parent node. Defaults to `undefined`. */
-    expanded?: boolean;
-}
-declare const TreeItem: React.ForwardRefExoticComponent<TreeItemProps & React.RefAttributes<HTMLElement | HTMLDivElement>>;
-interface TreeItemContentProps extends BaseProps<"span"> {
-}
-declare const TreeItemContent: React.ForwardRefExoticComponent<TreeItemContentProps & React.RefAttributes<HTMLElement | HTMLSpanElement>>;
-type IconButtonProps = React.ComponentProps<typeof IconButton>;
-interface TreeItemExpanderProps extends Omit<IconButtonProps, "variant" | "label" | "icon"> {
-    label?: IconButtonProps["label"];
-    icon?: IconButtonProps["icon"];
-}
-declare const TreeItemExpander: React.ForwardRefExoticComponent<Omit<TreeItemExpanderProps, "ref"> & React.RefAttributes<HTMLElement | HTMLButtonElement>>;
-export { Tree as Root, TreeItem as Item, TreeItemExpander as Expander, TreeItemContent as Content, };
+/**
+ * A tree is a hierarchical list of items that can be expanded or collapsed, or optionally selected.
+ *
+ * `Tree.Root` is the root component for a tree. `Tree.Item`s are rendered as a flat list in the `Tree.Root` component to create a hierarchical tree structure.
+ *
+ * Example:
+ * ```tsx
+ * <Tree.Root>
+ *   <Tree.Item label="Parent 1" aria-level={1} aria-posinset={1} aria-setsize={2} />
+ *   <Tree.Item label="Child 1.1" aria-level={2} aria-posinset={1} aria-setsize={2} />
+ *   <Tree.Item label="Child 1.2" aria-level={2} aria-posinset={2} aria-setsize={2} />
+ *   <Tree.Item label="Parent 2" aria-level={1} aria-posinset={2} aria-setsize={2} />
+ *   <Tree.Item label="Child 2.1" aria-level={2} aria-posinset={1} aria-setsize={1} />
+ * </Tree.Root>
+ * ```
+ */
+declare const Tree: import("react").ForwardRefExoticComponent<TreeProps & import("react").RefAttributes<HTMLElement | HTMLDivElement>>;
+export { Tree as Root, TreeItemRoot as Item, TreeItemAction as ItemAction };

package/dist/bricks/Tree.js

@@ -1,113 +1,25 @@
-import { jsx, jsxs } from "react/jsx-runtime";
-import * as React from "react";
+import { jsx } from "react/jsx-runtime";
 import cx from "classnames";
-import * as Ariakit from "@ariakit/react";
-import * as ListItem from "./ListItem.js";
-import { IconButton } from "./IconButton.js";
-import { Icon } from "./Icon.js";
+import { Role } from "@ariakit/react/role";
+import { useCompositeStore, Composite } from "@ariakit/react/composite";
 import { forwardRef } from "./~utils.js";
+import { Root as TreeItemRoot, Action as TreeItemAction } from "./TreeItem.js";
 const Tree = forwardRef((props, forwardedRef) => {
-  return /* @__PURE__ */ jsx(Ariakit.Role.div, { ...props, role: "list", ref: forwardedRef, children: props.children });
-});
-const TreeItem = forwardRef((props, forwardedRef) => {
-  const { selected, content, children, className, expanded, style, ...rest } = props;
-  const parentContext = React.useContext(TreeItemContext);
-  const level = parentContext ? parentContext.level + 1 : 1;
-  const firstSelected = !!selected && !parentContext?.selected;
+  const composite = useCompositeStore({ orientation: "vertical" });
   return /* @__PURE__ */ jsx(
-    TreeItemContext.Provider,
+    Role.div,
     {
-      value: React.useMemo(
-        () => ({
-          level,
-          expanded,
-          selected
-        }),
-        [level, expanded, selected]
-      ),
-      children: /* @__PURE__ */ jsxs("div", { role: "listitem", "aria-current": firstSelected ? true : void 0, children: [
-        /* @__PURE__ */ jsx(
-          ListItem.Root,
-          {
-            ...rest,
-            "data-kiwi-expanded": expanded,
-            "data-kiwi-selected": selected,
-            "data-kiwi-parent-selected": parentContext?.selected,
-            className: cx("\u{1F95D}-tree-item", className),
-            style: {
-              ...style,
-              "--\u{1F95D}tree-item-level": level
-            },
-            ref: forwardedRef,
-            role: void 0,
-            children: content
-          }
-        ),
-        children && /* @__PURE__ */ jsx("div", { role: "list", children })
-      ] })
+      role: "tree",
+      ...props,
+      render: /* @__PURE__ */ jsx(Composite, { store: composite }),
+      className: cx("\u{1F95D}-tree", props.className),
+      ref: forwardedRef,
+      children: props.children
     }
   );
 });
-const TreeItemContent = forwardRef(
-  (props, forwardedRef) => {
-    const { children, ...rest } = props;
-    return /* @__PURE__ */ jsx(
-      ListItem.Content,
-      {
-        ...rest,
-        className: cx("\u{1F95D}-tree-item-content", props.className),
-        ref: forwardedRef,
-        children: /* @__PURE__ */ jsx("button", { type: "button", children })
-      }
-    );
-  }
-);
-const TreeItemExpander = forwardRef(
-  (props, forwardedRef) => {
-    const context = React.useContext(TreeItemContext);
-    const expanded = context?.expanded;
-    return /* @__PURE__ */ jsx(
-      IconButton,
-      {
-        icon: /* @__PURE__ */ jsx(TreeChevron, {}),
-        label: "Toggle",
-        "aria-expanded": expanded === void 0 ? void 0 : expanded,
-        ...props,
-        className: cx("\u{1F95D}-tree-item-expander", props.className),
-        variant: "ghost",
-        labelVariant: "visually-hidden",
-        ref: forwardedRef
-      }
-    );
-  }
-);
-const TreeChevron = forwardRef(
-  (props, forwardedRef) => {
-    return /* @__PURE__ */ jsx(
-      Icon,
-      {
-        ...props,
-        render: /* @__PURE__ */ jsx(
-          Ariakit.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
-      }
-    );
-  }
-);
-const TreeItemContext = React.createContext(void 0);
 export {
-  TreeItemContent as Content,
-  TreeItemExpander as Expander,
-  TreeItem as Item,
+  TreeItemRoot as Item,
+  TreeItemAction as ItemAction,
   Tree as Root
 };

package/dist/bricks/TreeItem.d.ts

@@ -0,0 +1,123 @@
+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. */
+    "aria-level": number;
+    /** Defines tree item position in the current level of tree items. Integer greater than or equal to 1. */
+    "aria-posinset": number;
+    /** Defines tree item set size of the current level. */
+    "aria-setsize": number;
+    /**
+     * Specifies if the tree item is selected.
+     *
+     * If `undefined`, the tree item is not selectable.
+     *
+     * @default undefined
+     */
+    selected?: boolean;
+    /**
+     * Callback fired when the tree item is selected.
+     *
+     * Should be used with the `selected` prop.
+     */
+    onSelectedChange?: (selected: boolean) => void;
+    /**
+     * Specifies if the tree item is expanded.
+     *
+     * Used to determine if a tree item is a parent node. If `undefined`, it is a leaf node (i.e. not expandable).
+     *
+     * @default undefined
+     * */
+    expanded?: boolean;
+    /**
+     * Callback fired when the tree item is expanded.
+     *
+     * Should be used with the `expanded` prop.
+     */
+    onExpandedChange?: (expanded: boolean) => void;
+    /**
+     * Icon to be displayed inside the tree item.
+     *
+     * Can be a URL of an SVG from the `@itwin/itwinui-icons` package, or a JSX element.
+     *
+     * For multiple icons/decorations, use the `unstable_decorations` prop.
+     */
+    icon?: string | React.JSX.Element;
+    /**
+     * Decoration(s) to be displayed inside the tree item.
+     *
+     * This is an alternative to the `icon` prop, and can be used to
+     * display multiple icons or other decorations before the label.
+     *
+     * Note: This should _not_ be used together with the `icon` prop.
+     *
+     * @experimental
+     */
+    unstable_decorations?: React.ReactNode;
+    /**
+     * The primary label that identifies the tree item and is displayed inside it.
+     */
+    label?: React.ReactNode;
+    /** 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.
+     *
+     * Example:
+     * ```tsx
+     * actions={[
+     *   <Tree.ItemAction key={…} icon={…} label={…} />,
+     *   <Tree.ItemAction key={…} icon={…} label={…} />,
+     * ]}
+     * ```
+     */
+    actions?: React.ReactNode[];
+}
+/**
+ * A treeitem is a node in a tree structure that may be expanded or collapsed to reveal or hide its descendants.
+ *
+ * `Tree.Item`s can be rendered inside a `Tree.Root`. Additional properties are specified to the `Tree.Item`s to create a hierarchical tree structure.
+ *
+ * Example:
+ * ```tsx
+ * <Tree.Root>
+ *   <Tree.Item label="Parent" aria-level={1} aria-posinset={1} aria-setsize={1} />
+ *   <Tree.Item label="Child 1" aria-level={2} aria-posinset={1} aria-setsize={2} />
+ *   <Tree.Item label="Child 2" aria-level={2} aria-posinset={2} aria-setsize={2}  />
+ * </Tree.Root>
+ * ```
+ *
+ * The `label` and `icon` props can be used to specify the treeitem's own content.
+ *
+ * The `aria-level` prop is used to specify the nesting level of the treeitem. Nesting levels start at 1.
+ *
+ * The `aria-posinset` and `aria-setsize` props are used to define the treeitem's position in the current level of tree items.
+ *
+ * The `expanded` and `onExpandedChange` props can be used to control the expansion state of a treeitem.
+ *
+ * The `selected` and `onSelectedChange` props can be used to control the selection state of a treeitem.
+ *
+ * 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"> {
+    /**
+     * Controls the visibility of the action.
+     *
+     * 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.
+     */
+    visible?: boolean;
+}
+/**
+ * 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.
+ *
+ * By default, the action appears only on hover/focus. This can be controlled by the `visible` prop.
+ */
+declare const TreeItemAction: React.ForwardRefExoticComponent<TreeItemActionProps & React.RefAttributes<HTMLElement | HTMLButtonElement>>;
+export { TreeItemRoot as Root, TreeItemAction as Action };