@itwin/itwinui-react 5.0.0-alpha.0 → 5.0.0-alpha.2

package/dist/bricks/Text.js

@@ -0,0 +1,19 @@
+import { jsx } from "react/jsx-runtime";
+import * as Ariakit from "@ariakit/react";
+import cx from "classnames";
+import { forwardRef } from "./~utils.js";
+const Text = forwardRef((props, forwardedRef) => {
+  const { variant, ...rest } = props;
+  return /* @__PURE__ */ jsx(
+    Ariakit.Role,
+    {
+      ...rest,
+      className: cx("\u{1F95D}-text", props.className),
+      "data-kiwi-text-variant": variant,
+      ref: forwardedRef
+    }
+  );
+});
+export {
+  Text
+};

package/dist/bricks/TextBox.d.ts

@@ -1,7 +1,7 @@
 import * as React from "react";
 import { Icon } from "./Icon.js";
 import { Textarea } from "./Textarea.js";
-import type { FocusableProps, BaseProps } from "./~utils.js";
+import { type FocusableProps, type BaseProps } from "./~utils.js";
 interface BaseInputProps extends FocusableProps<"input"> {
 }
 interface TextBoxInputProps extends Omit<BaseInputProps, "children" | "type"> {
@@ -16,7 +16,7 @@ interface TextBoxInputProps extends Omit<BaseInputProps, "children" | "type"> {
     type?: Extract<BaseInputProps["type"], "text" | "email" | "password" | "search" | "tel" | "url" | "number" | "date">;
 }
 /**
- * Input component that allows users to enter text based values.
+ * An input component that allows users to enter text based values.
  *
  * Example usage:
  * ```tsx
@@ -24,26 +24,56 @@ interface TextBoxInputProps extends Omit<BaseInputProps, "children" | "type"> {
  * ```
  *
  * To add additional decorations, see `TextBox.Root` component.
+ *
+ * Works well with the `Field` and `Label` components.
+ * ```tsx
+ * <Field>
+ *   <Label>Enter your name</Label>
+ *   <TextBox.Input />
+ * </Field>
+ * ```
+ *
+ * Underneath, it's an HTML input, i.e. `<input>`, so it supports the same props, including
+ * `value`, `defaultValue`, `onChange`, and `disabled`.
+ *
+ * For a multiline text input, use the `TextBox.Textarea` component.
  */
-declare const TextBoxInput: React.ForwardRefExoticComponent<TextBoxInputProps & React.RefAttributes<HTMLInputElement>>;
+declare const TextBoxInput: React.ForwardRefExoticComponent<TextBoxInputProps & React.RefAttributes<HTMLElement | HTMLInputElement>>;
 interface TextBoxRootProps extends BaseProps {
 }
 /**
- * Root component allows adding additional decorations to text based inputs.
+ * Compound component for a text input. Allows adding additional decorations.
  *
  * Example usage to add an end icon:
  * ```tsx
  * <TextBox.Root>
- * 	<TextBox.Input defaultValue="Hello" />
- * 	<TextBox.Icon href={...} />
+ *   <TextBox.Input defaultValue="Hello" />
+ *   <TextBox.Icon href={...} />
  * </TextBox.Root>
  * ```
+ *
+ * Works well with the `Field` and `Label` components.
+ * ```tsx
+ * <Field>
+ *   <Label>Enter your name</Label>
+ *   <TextBox.Root>
+ *     <TextBox.Input />
+ *     <TextBox.Icon href={…} />
+ *   </TextBox.Root>
+ * </Field>
+ * ```
  */
-declare const TextBoxRoot: React.ForwardRefExoticComponent<TextBoxRootProps & React.RefAttributes<HTMLDivElement>>;
+declare const TextBoxRoot: React.ForwardRefExoticComponent<TextBoxRootProps & React.RefAttributes<HTMLElement | HTMLDivElement>>;
 interface TextBoxIconProps extends React.ComponentProps<typeof Icon> {
 }
-declare const TextBoxIcon: React.ForwardRefExoticComponent<Omit<TextBoxIconProps, "ref"> & React.RefAttributes<SVGSVGElement>>;
+/**
+ * A static icon decoration for the `TextBox.Root` component. Can be added before or after the `TextBox.Input`.
+ */
+declare const TextBoxIcon: React.ForwardRefExoticComponent<Omit<TextBoxIconProps, "ref"> & React.RefAttributes<HTMLElement | SVGSVGElement>>;
 interface TextBoxTextProps extends BaseProps<"span"> {
 }
-declare const TextBoxText: React.ForwardRefExoticComponent<TextBoxTextProps & React.RefAttributes<HTMLSpanElement>>;
+/**
+ * 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, };

package/dist/bricks/TextBox.js

@@ -2,35 +2,40 @@ import { jsx } from "react/jsx-runtime";
 import * as React from "react";
 import * as Ariakit from "@ariakit/react";
 import cx from "classnames";
-import { useFieldId } from "./Field.js";
+import { useFieldDescribedBy, useFieldId } from "./Field.js";
 import { Icon } from "./Icon.js";
 import { Textarea } from "./Textarea.js";
 import { useMergedRefs } from "./~hooks.js";
-const TextBoxInput = React.forwardRef((props, forwardedRef) => {
-  const fieldId = useFieldId();
-  const rootContext = React.useContext(TextBoxRootContext);
-  const setDisabled = rootContext?.setDisabled;
-  React.useEffect(() => {
-    setDisabled?.(props.disabled);
-  }, [setDisabled, props.disabled]);
-  return /* @__PURE__ */ jsx(
-    Ariakit.Role.input,
-    {
-      id: fieldId,
-      ...props,
-      className: cx({ "\u{1F95D}-text-box": !rootContext }, props.className),
-      render: /* @__PURE__ */ jsx(
-        Ariakit.Focusable,
-        {
-          accessibleWhenDisabled: true,
-          render: props.render || /* @__PURE__ */ jsx("input", {})
-        }
-      ),
-      ref: useMergedRefs(rootContext?.inputRef, forwardedRef)
-    }
-  );
-});
-const TextBoxRoot = React.forwardRef(
+import { forwardRef } from "./~utils.js";
+const TextBoxInput = forwardRef(
+  (props, forwardedRef) => {
+    const describedBy = useFieldDescribedBy(props["aria-describedby"]);
+    const fieldId = useFieldId();
+    const rootContext = React.useContext(TextBoxRootContext);
+    const setDisabled = rootContext?.setDisabled;
+    React.useEffect(() => {
+      setDisabled?.(props.disabled);
+    }, [setDisabled, props.disabled]);
+    return /* @__PURE__ */ jsx(
+      Ariakit.Role.input,
+      {
+        id: fieldId,
+        ...props,
+        "aria-describedby": describedBy,
+        className: cx({ "\u{1F95D}-text-box": !rootContext }, props.className),
+        render: /* @__PURE__ */ jsx(
+          Ariakit.Focusable,
+          {
+            accessibleWhenDisabled: true,
+            render: props.render || /* @__PURE__ */ jsx("input", {})
+          }
+        ),
+        ref: useMergedRefs(rootContext?.inputRef, forwardedRef)
+      }
+    );
+  }
+);
+const TextBoxRoot = forwardRef(
   (props, forwardedRef) => {
     const inputRef = React.useRef(null);
     const [disabled, setDisabled] = React.useState();
@@ -59,26 +64,30 @@ const TextBoxRoot = React.forwardRef(
     );
   }
 );
-const TextBoxIcon = React.forwardRef((props, forwardedRef) => {
-  return /* @__PURE__ */ jsx(
-    Icon,
-    {
-      ...props,
-      className: cx("\u{1F95D}-text-box-decoration", props.className),
-      ref: forwardedRef
-    }
-  );
-});
-const TextBoxText = React.forwardRef((props, forwardedRef) => {
-  return /* @__PURE__ */ jsx(
-    Ariakit.Role.span,
-    {
-      ...props,
-      className: cx("\u{1F95D}-text-box-decoration", props.className),
-      ref: forwardedRef
-    }
-  );
-});
+const TextBoxIcon = forwardRef(
+  (props, forwardedRef) => {
+    return /* @__PURE__ */ jsx(
+      Icon,
+      {
+        ...props,
+        className: cx("\u{1F95D}-text-box-decoration", props.className),
+        ref: forwardedRef
+      }
+    );
+  }
+);
+const TextBoxText = forwardRef(
+  (props, forwardedRef) => {
+    return /* @__PURE__ */ jsx(
+      Ariakit.Role.span,
+      {
+        ...props,
+        className: cx("\u{1F95D}-text-box-decoration", props.className),
+        ref: forwardedRef
+      }
+    );
+  }
+);
 const TextBoxRootContext = React.createContext(void 0);
 export {
   TextBoxIcon as Icon,

package/dist/bricks/Textarea.d.ts

@@ -1,14 +1,24 @@
-import * as React from "react";
-import type { FocusableProps } from "./~utils.js";
+import { type FocusableProps } from "./~utils.js";
 interface TextareaProps extends FocusableProps<"textarea"> {
 }
 /**
- * Textarea component that allows users to enter multiline text values.
+ * 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`.
  */
-export declare const Textarea: React.ForwardRefExoticComponent<TextareaProps & React.RefAttributes<HTMLTextAreaElement>>;
+export declare const Textarea: import("react").ForwardRefExoticComponent<TextareaProps & import("react").RefAttributes<HTMLElement | HTMLTextAreaElement>>;
 export {};

package/dist/bricks/Textarea.js

@@ -1,27 +1,31 @@
 import { jsx } from "react/jsx-runtime";
-import * as React from "react";
 import * as Ariakit from "@ariakit/react";
 import cx from "classnames";
-import { useFieldId } from "./Field.js";
-const Textarea = React.forwardRef((props, forwardedRef) => {
-  const fieldId = useFieldId();
-  return /* @__PURE__ */ jsx(
-    Ariakit.Role.textarea,
-    {
-      id: fieldId,
-      ...props,
-      className: cx("\u{1F95D}-text-box", props.className),
-      render: /* @__PURE__ */ jsx(
-        Ariakit.Focusable,
-        {
-          accessibleWhenDisabled: true,
-          render: props.render || /* @__PURE__ */ jsx("textarea", {})
-        }
-      ),
-      ref: forwardedRef
-    }
-  );
-});
+import { useFieldDescribedBy, useFieldId } from "./Field.js";
+import { forwardRef } from "./~utils.js";
+const Textarea = forwardRef(
+  (props, forwardedRef) => {
+    const fieldId = useFieldId();
+    const describedBy = useFieldDescribedBy(props["aria-describedby"]);
+    return /* @__PURE__ */ jsx(
+      Ariakit.Role.textarea,
+      {
+        id: fieldId,
+        ...props,
+        className: cx("\u{1F95D}-text-box", props.className),
+        "aria-describedby": describedBy,
+        render: /* @__PURE__ */ jsx(
+          Ariakit.Focusable,
+          {
+            accessibleWhenDisabled: true,
+            render: props.render || /* @__PURE__ */ jsx("textarea", {})
+          }
+        ),
+        ref: forwardedRef
+      }
+    );
+  }
+);
 export {
   Textarea
 };

package/dist/bricks/Tooltip.d.ts

@@ -3,12 +3,16 @@ import * as Ariakit from "@ariakit/react";
 import { type FocusableProps } from "./~utils.js";
 interface TooltipProps extends Omit<FocusableProps<"div">, "content">, Pick<Ariakit.TooltipProps, "open" | "unmountOnHide">, Pick<Ariakit.TooltipProviderProps, "defaultOpen" | "setOpen"> {
     /**
-     * The content to be displayed inside the tooltip.
+     * The content to be displayed inside the tooltip when the trigger element is hovered or focused.
      */
     content: React.ReactNode;
     /**
      * The element that will trigger the tooltip when hovered or focused.
      * Common examples include buttons, links, or form controls.
+     *
+     * **Note**: The trigger must be a single interactive element. Do not add a
+     * tooltip to a non-interactive static element (such as a `<div>` or `<svg>`). Also,
+     * the trigger element must forward its ref and spread its props.
      */
     children: React.ReactElement;
     /**
@@ -23,7 +27,7 @@ interface TooltipProps extends Omit<FocusableProps<"div">, "content">, Pick<Aria
     type?: "description" | "label" | "none";
 }
 /**
- * Tooltip component that provides additional information or context for a trigger element.
+ * A tooltip component that provides additional information or context for an interactive trigger element.
  *
  * Example usage:
  *
@@ -33,7 +37,10 @@ interface TooltipProps extends Omit<FocusableProps<"div">, "content">, Pick<Aria
  * </Tooltip>
  * ```
  *
- * **Note**: If `type` is set to `"none"`, the tooltip will not use ARIA attributes and will unmount when hidden.
+ * **Note**: The trigger element must be a single interactive element, such as a button or link. Do not add a
+ * tooltip to a non-interactive static element (such as a `<div>` or `<svg>`).
+ *
+ * **Note**: If `type` is set to `"none"`, the tooltip will not use ARIA attributes.
  */
-export declare const Tooltip: React.ForwardRefExoticComponent<TooltipProps & React.RefAttributes<HTMLDivElement>>;
+export declare const Tooltip: React.ForwardRefExoticComponent<TooltipProps & React.RefAttributes<HTMLElement | HTMLDivElement>>;
 export {};

package/dist/bricks/Tooltip.js

@@ -2,66 +2,74 @@ import { Fragment, jsx, jsxs } from "react/jsx-runtime";
 import * as React from "react";
 import cx from "classnames";
 import * as Ariakit from "@ariakit/react";
-import { supportsPopover } from "./~utils.js";
-const Tooltip = React.forwardRef((props, forwardedRef) => {
-  const {
-    content,
-    children,
-    className,
-    type = "description",
-    id = React.useId(),
-    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]
-  );
-  return /* @__PURE__ */ jsx(Fragment, { children: /* @__PURE__ */ jsxs(
-    Ariakit.TooltipProvider,
-    {
-      store,
+import { forwardRef, supportsPopover } from "./~utils.js";
+const Tooltip = forwardRef(
+  (props, forwardedRef) => {
+    const generatedId = React.useId();
+    const {
+      content,
+      children,
+      type = "description",
+      id = generatedId,
       defaultOpen: defaultOpenProp,
       open: openProp,
       setOpen: setOpenProp,
-      children: [
-        /* @__PURE__ */ jsx(
-          Ariakit.TooltipAnchor,
-          {
-            render: children,
-            ...type === "description" && { "aria-describedby": id },
-            ...type === "label" && { "aria-labelledby": id }
-          }
-        ),
-        /* @__PURE__ */ jsx(
-          Ariakit.Tooltip,
-          {
-            "aria-hidden": "true",
-            ...rest,
-            unmountOnHide,
-            className: cx("\u{1F95D}-tooltip", className),
-            ref: forwardedRef,
-            id,
-            style: { zIndex: supportsPopover ? void 0 : 9999, ...props.style },
-            wrapperProps: { popover: "manual" },
-            portal: !supportsPopover,
-            children: content
-          }
-        )
-      ]
-    }
-  ) });
-});
+      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]
+    );
+    return /* @__PURE__ */ jsx(Fragment, { children: /* @__PURE__ */ jsxs(
+      Ariakit.TooltipProvider,
+      {
+        store,
+        defaultOpen: defaultOpenProp,
+        open: openProp,
+        setOpen: setOpenProp,
+        children: [
+          /* @__PURE__ */ jsx(
+            Ariakit.TooltipAnchor,
+            {
+              render: children,
+              ...type === "description" && { "aria-describedby": id },
+              ...type === "label" && { "aria-labelledby": id }
+            }
+          ),
+          /* @__PURE__ */ jsx(
+            Ariakit.Tooltip,
+            {
+              "aria-hidden": "true",
+              ...rest,
+              unmountOnHide,
+              className: cx("\u{1F95D}-tooltip", props.className),
+              ref: forwardedRef,
+              id,
+              style: {
+                zIndex: supportsPopover ? void 0 : 9999,
+                ...props.style
+              },
+              wrapperProps: { popover: "manual" },
+              portal: !supportsPopover,
+              children: content
+            }
+          )
+        ]
+      }
+    ) });
+  }
+);
 export {
   Tooltip
 };

package/dist/bricks/Tree.d.ts

@@ -1,23 +1,86 @@
 import * as React from "react";
-import { IconButton } from "./IconButton.js";
-import type { BaseProps } from "./~utils.js";
+import { type BaseProps } from "./~utils.js";
 interface TreeProps extends BaseProps {
 }
-declare const Tree: React.ForwardRefExoticComponent<TreeProps & React.RefAttributes<HTMLDivElement>>;
+/**
+ * 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 can be nested inside a `Tree.Root` to create a hierarchical tree structure.
+ *
+ * Example:
+ * ```tsx
+ * <Tree.Root>
+ *   <Tree.Item label="Parent 1">
+ *     <Tree.Item label="Child 1.1" />
+ *     <Tree.Item label="Child 1.2" />
+ *   </Tree.Item>
+ *   <Tree.Item label="Parent 2">
+ *     <Tree.Item label="Child 2.1" />
+ *   </Tree.Item>
+ * </Tree.Root>
+ * ```
+ */
+declare const Tree: React.ForwardRefExoticComponent<TreeProps & React.RefAttributes<HTMLElement | HTMLDivElement>>;
 interface TreeItemProps extends Omit<BaseProps, "content"> {
-    content?: React.ReactNode;
+    /**
+     * Specifies if the tree item is selected.
+     *
+     * If `undefined`, the tree item is not selectable.
+     *
+     * @default undefined
+     */
     selected?: boolean;
-    /** Specifies if the tree item is expanded. Used to determine if a tree item is a parent node. Defaults to `undefined`. */
+    /**
+     * 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 `kiwi-icons` package, or a JSX element.
+     */
+    icon?: string | React.JSX.Element;
+    /** The label to display for the tree item. */
+    label?: React.ReactNode;
+    /** The actions available for the tree item. */
+    actions?: React.ReactNode;
 }
-declare const TreeItem: React.ForwardRefExoticComponent<TreeItemProps & React.RefAttributes<HTMLDivElement>>;
-interface TreeItemContentProps extends BaseProps<"span"> {
-}
-declare const TreeItemContent: React.ForwardRefExoticComponent<TreeItemContentProps & React.RefAttributes<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<HTMLButtonElement>>;
-export { Tree as Root, TreeItem as Item, TreeItemExpander as Expander, TreeItemContent as Content, };
+/**
+ * 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 nested as JSX elements inside a `Tree.Root` to create a hierarchical tree structure.
+ *
+ * Example:
+ * ```tsx
+ * <Tree.Root>
+ *   <Tree.Item label="Parent">
+ *     <Tree.Item label="Child 1" />
+ *     <Tree.Item label="Child 2" />
+ *   </Tree.Item>
+ * </Tree.Root>
+ * ```
+ *
+ * The `label` and `icon` props can be used to specify the treeitem's own content. `children` is only used for nested 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.
+ */
+declare const TreeItem: React.ForwardRefExoticComponent<TreeItemProps & React.RefAttributes<HTMLElement | HTMLDivElement>>;
+export { Tree as Root, TreeItem as Item };