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

package/dist/bricks/Kbd.d.ts

@@ -1,7 +1,33 @@
 import { type BaseProps } from "./~utils.js";
+declare const predefinedSymbols: {
+    readonly Backspace: "⌫";
+    readonly Command: "⌘";
+    readonly Control: "Ctrl";
+    readonly Down: "↓";
+    readonly Eject: "⏏";
+    readonly Enter: "↵";
+    readonly Escape: "Esc";
+    readonly Left: "←";
+    readonly Option: "⌥";
+    readonly Right: "→";
+    readonly Shift: "⇧";
+    readonly Space: "␣";
+    readonly Tab: "Tab";
+    readonly Up: "↑";
+};
 interface KbdProps extends BaseProps<"kbd"> {
     /** @default "solid" */
     variant?: "solid" | "muted" | "ghost";
+    /**
+     * Display a specific key symbol from a predefined list. This is useful for
+     * displaying modifier keys or special keys, such as `Control`, `Shift`, `Enter`, etc.
+     *
+     * Example:
+     * ```tsx
+     * <Kbd symbol="Control" />
+     * ```
+     */
+    symbol?: keyof typeof predefinedSymbols;
 }
 /**
  * A styled wrapper over the HTML `<kbd>` element. This is typically
@@ -10,6 +36,10 @@ interface KbdProps extends BaseProps<"kbd"> {
  * ```tsx
  * <Kbd>Ctrl</Kbd> <Kbd>S</Kbd>
  * ```
+ *
+ * ```tsx
+ * <Kbd symbol="Control" />
+ * ```
  */
 export declare const Kbd: import("react").ForwardRefExoticComponent<KbdProps & import("react").RefAttributes<HTMLElement>>;
 export {};

package/dist/bricks/Kbd.js

@@ -1,17 +1,42 @@
-import { jsx } from "react/jsx-runtime";
+import { Fragment, jsx, jsxs } from "react/jsx-runtime";
 import cx from "classnames";
 import * as Ariakit from "@ariakit/react";
 import { forwardRef } from "./~utils.js";
+import { VisuallyHidden } from "./VisuallyHidden.js";
+const predefinedSymbols = {
+  Backspace: "\u232B",
+  Command: "\u2318",
+  Control: "Ctrl",
+  Down: "\u2193",
+  Eject: "\u23CF",
+  Enter: "\u21B5",
+  Escape: "Esc",
+  Left: "\u2190",
+  Option: "\u2325",
+  Right: "\u2192",
+  Shift: "\u21E7",
+  Space: "\u2423",
+  Tab: "Tab",
+  Up: "\u2191"
+};
 const Kbd = forwardRef((props, forwardedRef) => {
-  const { variant = "solid", ...rest } = props;
+  const { variant = "solid", symbol, children, ...rest } = props;
+  let content = children;
+  if (symbol) {
+    content = /* @__PURE__ */ jsxs(Fragment, { children: [
+      /* @__PURE__ */ jsx("span", { "aria-hidden": "true", children: predefinedSymbols[symbol] }),
+      children || /* @__PURE__ */ jsx(VisuallyHidden, { children: symbol })
+    ] });
+  }
   return /* @__PURE__ */ jsx(
     Ariakit.Role,
     {
-      "data-kiwi-variant": variant,
       ...rest,
+      "data-kiwi-variant": variant,
       className: cx("\u{1F95D}-kbd", props.className),
       render: props.render || /* @__PURE__ */ jsx("kbd", {}),
-      ref: forwardedRef
+      ref: forwardedRef,
+      children: content
     }
   );
 });

package/dist/bricks/Radio.js

@@ -1,10 +1,11 @@
 import { jsx } from "react/jsx-runtime";
 import cx from "classnames";
 import * as Ariakit from "@ariakit/react";
-import { useFieldId } from "./Field.js";
+import { useFieldDescribedBy, useFieldId } from "./Field.js";
 import { forwardRef } from "./~utils.js";
 const Radio = forwardRef((props, forwardedRef) => {
   const fieldId = useFieldId();
+  const describedBy = useFieldDescribedBy(props["aria-describedby"]);
   return /* @__PURE__ */ jsx(
     Ariakit.Radio,
     {
@@ -12,6 +13,7 @@ const Radio = forwardRef((props, forwardedRef) => {
       id: fieldId,
       ...props,
       className: cx("\u{1F95D}-checkbox", "\u{1F95D}-radio", props.className),
+      "aria-describedby": describedBy,
       ref: forwardedRef
     }
   );

package/dist/bricks/Select.js

@@ -7,7 +7,7 @@ import {
   isBrowser
 } from "./~utils.js";
 import { DisclosureArrow } from "./Icon.js";
-import { useFieldId } from "./Field.js";
+import { useFieldDescribedBy, useFieldId } from "./Field.js";
 const supportsHas = isBrowser && CSS?.supports?.("selector(:has(+ *))");
 const HtmlSelectContext = React.createContext(() => {
 });
@@ -27,6 +27,7 @@ const HtmlSelect = forwardRef(
   (props, forwardedRef) => {
     const setIsHtmlSelect = React.useContext(HtmlSelectContext);
     const fieldId = useFieldId();
+    const describedBy = useFieldDescribedBy(props["aria-describedby"]);
     React.useEffect(
       function updateContext() {
         setIsHtmlSelect(true);
@@ -40,6 +41,7 @@ const HtmlSelect = forwardRef(
           id: fieldId,
           ...props,
           className: cx("\u{1F95D}-button", "\u{1F95D}-select", props.className),
+          "aria-describedby": describedBy,
           "data-kiwi-tone": "neutral",
           "data-kiwi-variant": "solid",
           ref: forwardedRef

package/dist/bricks/Spinner.d.ts

@@ -0,0 +1,31 @@
+import { type BaseProps } from "./~utils.js";
+interface SpinnerProps extends BaseProps {
+    /**
+     * A text alternative for the spinner.
+     * @default "Loading…"
+     */
+    alt?: string;
+    /**
+     * The size of the spinner.
+     * @default "medium"
+     */
+    size?: "small" | "medium" | "large" | "xlarge";
+    /**
+     * The tone of the spinner.
+     * @default "neutral"
+     */
+    tone?: "neutral" | "accent";
+}
+/**
+ * A loading spinner.
+ *
+ * Example:
+ * ```tsx
+ * <Spinner />
+ * ```
+ *
+ * Supports a `tone` prop to change the tone (color) of the spinner.
+ * Supports a `size` prop to change the size of the spinner.
+ */
+export declare const Spinner: import("react").ForwardRefExoticComponent<SpinnerProps & import("react").RefAttributes<HTMLElement | HTMLDivElement>>;
+export {};

package/dist/bricks/Spinner.js

@@ -0,0 +1,39 @@
+import { jsx, jsxs } from "react/jsx-runtime";
+import * as Ariakit from "@ariakit/react";
+import cx from "classnames";
+import { VisuallyHidden } from "./VisuallyHidden.js";
+import { forwardRef } from "./~utils.js";
+const Spinner = forwardRef(
+  (props, forwardedRef) => {
+    const {
+      alt = "Loading\u2026",
+      size = "medium",
+      tone = "neutral",
+      ...rest
+    } = props;
+    return /* @__PURE__ */ jsxs(
+      Ariakit.Role,
+      {
+        ...rest,
+        "data-kiwi-size": size,
+        "data-kiwi-tone": tone,
+        className: cx("\u{1F95D}-spinner", props.className),
+        ref: forwardedRef,
+        children: [
+          /* @__PURE__ */ jsx("svg", { "aria-hidden": "true", className: "\u{1F95D}-spinner-svg", viewBox: "0 0 16 16", children: /* @__PURE__ */ jsx(
+            "path",
+            {
+              stroke: "currentColor",
+              "stroke-linecap": "round",
+              d: "M9.5 1.674a6.503 6.503 0 0 1 0 12.652m-3-12.652a6.503 6.503 0 0 0 0 12.652"
+            }
+          ) }),
+          /* @__PURE__ */ jsx(VisuallyHidden, { children: alt })
+        ]
+      }
+    );
+  }
+);
+export {
+  Spinner
+};

package/dist/bricks/Switch.js

@@ -1,11 +1,12 @@
 import { jsx } from "react/jsx-runtime";
 import cx from "classnames";
 import * as Ariakit from "@ariakit/react";
-import { useFieldId } from "./Field.js";
+import { useFieldDescribedBy, useFieldId } from "./Field.js";
 import { forwardRef } from "./~utils.js";
 const Switch = forwardRef(
   (props, forwardedRef) => {
     const fieldId = useFieldId();
+    const describedBy = useFieldDescribedBy(props["aria-describedby"]);
     return /* @__PURE__ */ jsx(
       Ariakit.Checkbox,
       {
@@ -13,6 +14,7 @@ const Switch = forwardRef(
         id: fieldId,
         ...props,
         className: cx("\u{1F95D}-switch", props.className),
+        "aria-describedby": describedBy,
         role: "switch",
         ref: forwardedRef
       }

package/dist/bricks/Tabs.d.ts

@@ -67,7 +67,7 @@ interface TabProps extends FocusableProps<"button">, Pick<Ariakit.TabProps, "id"
  * ```
  */
 declare const Tab: React.ForwardRefExoticComponent<TabProps & React.RefAttributes<HTMLElement | HTMLButtonElement>>;
-interface TabPanelProps extends BaseProps<"div">, Pick<Ariakit.TabPanelProps, "tabId" | "unmountOnHide"> {
+interface TabPanelProps extends FocusableProps<"div">, Pick<Ariakit.TabPanelProps, "tabId" | "unmountOnHide" | "focusable"> {
 }
 /**
  * The actual content of a tab, shown when the tab is selected. Should be used as a child of `Tabs.Root`.

package/dist/bricks/Tabs.js

@@ -47,8 +47,8 @@ const TabList = forwardRef((props, forwardedRef) => {
   return /* @__PURE__ */ jsx(
     Ariakit.TabList,
     {
-      "data-kiwi-tone": tone,
       ...rest,
+      "data-kiwi-tone": tone,
       className: cx("\u{1F95D}-tab-list", props.className),
       style: {
         "--\u{1F95D}tab-active-stripe-view-transition-name": viewTransitionName,

package/dist/bricks/TextBox.js

@@ -2,13 +2,14 @@ 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";
 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;
@@ -20,6 +21,7 @@ const TextBoxInput = forwardRef(
       {
         id: fieldId,
         ...props,
+        "aria-describedby": describedBy,
         className: cx({ "\u{1F95D}-text-box": !rootContext }, props.className),
         render: /* @__PURE__ */ jsx(
           Ariakit.Focusable,

package/dist/bricks/Textarea.js

@@ -1,17 +1,19 @@
 import { jsx } from "react/jsx-runtime";
 import * as Ariakit from "@ariakit/react";
 import cx from "classnames";
-import { useFieldId } from "./Field.js";
+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,
           {

package/dist/bricks/Tooltip.js

@@ -5,12 +5,12 @@ import * as Ariakit from "@ariakit/react";
 import { forwardRef, supportsPopover } from "./~utils.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,
@@ -53,7 +53,7 @@ const Tooltip = forwardRef(
               "aria-hidden": "true",
               ...rest,
               unmountOnHide,
-              className: cx("\u{1F95D}-tooltip", className),
+              className: cx("\u{1F95D}-tooltip", props.className),
               ref: forwardedRef,
               id,
               style: {

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";
 interface TreeProps extends BaseProps {
 }
+/**
+ * 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;
 }
+/**
+ * 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>>;
-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, };
+export { Tree as Root, TreeItem as Item };

package/dist/bricks/Tree.js

@@ -6,14 +6,33 @@ import * as ListItem from "./ListItem.js";
 import { IconButton } from "./IconButton.js";
 import { Icon } from "./Icon.js";
 import { forwardRef } from "./~utils.js";
+import { VisuallyHidden } from "./VisuallyHidden.js";
 const Tree = forwardRef((props, forwardedRef) => {
-  return /* @__PURE__ */ jsx(Ariakit.Role.div, { ...props, role: "list", ref: forwardedRef, children: props.children });
+  return /* @__PURE__ */ jsx(
+    Ariakit.Role.div,
+    {
+      ...props,
+      className: cx("\u{1F95D}-tree", props.className),
+      ref: forwardedRef,
+      children: /* @__PURE__ */ jsx("div", { role: "list", children: props.children })
+    }
+  );
 });
 const TreeItem = forwardRef((props, forwardedRef) => {
-  const { selected, content, children, className, expanded, style, ...rest } = props;
+  const {
+    selected,
+    children,
+    expanded,
+    icon,
+    label,
+    actions,
+    style,
+    onSelectedChange,
+    onExpandedChange,
+    ...rest
+  } = props;
   const parentContext = React.useContext(TreeItemContext);
   const level = parentContext ? parentContext.level + 1 : 1;
-  const firstSelected = !!selected && !parentContext?.selected;
   return /* @__PURE__ */ jsx(
     TreeItemContext.Provider,
     {
@@ -21,26 +40,39 @@ const TreeItem = forwardRef((props, forwardedRef) => {
         () => ({
           level,
           expanded,
-          selected
+          selected,
+          onSelectedChange
         }),
-        [level, expanded, selected]
+        [level, expanded, selected, onSelectedChange]
       ),
-      children: /* @__PURE__ */ jsxs("div", { role: "listitem", "aria-current": firstSelected ? true : void 0, children: [
-        /* @__PURE__ */ jsx(
+      children: /* @__PURE__ */ jsxs("div", { role: "listitem", children: [
+        /* @__PURE__ */ jsxs(
           ListItem.Root,
           {
             ...rest,
             "data-kiwi-expanded": expanded,
             "data-kiwi-selected": selected,
-            "data-kiwi-parent-selected": parentContext?.selected,
-            className: cx("\u{1F95D}-tree-item", className),
+            className: cx("\u{1F95D}-tree-item", props.className),
             style: {
               ...style,
               "--\u{1F95D}tree-item-level": level
             },
             ref: forwardedRef,
             role: void 0,
-            children: content
+            children: [
+              /* @__PURE__ */ jsx(
+                TreeItemExpander,
+                {
+                  onClick: () => {
+                    if (expanded === void 0) return;
+                    onExpandedChange?.(!expanded);
+                  }
+                }
+              ),
+              typeof icon === "string" ? /* @__PURE__ */ jsx(Icon, { href: icon }) : icon,
+              /* @__PURE__ */ jsx(TreeItemContent, { label }),
+              /* @__PURE__ */ jsx(TreeItemActions, { children: actions })
+            ]
           }
         ),
         children && /* @__PURE__ */ jsx("div", { role: "list", children })
@@ -50,14 +82,44 @@ const TreeItem = forwardRef((props, forwardedRef) => {
 });
 const TreeItemContent = forwardRef(
   (props, forwardedRef) => {
-    const { children, ...rest } = props;
+    const { label, ...rest } = props;
+    const context = React.useContext(TreeItemContext);
     return /* @__PURE__ */ jsx(
       ListItem.Content,
       {
         ...rest,
         className: cx("\u{1F95D}-tree-item-content", props.className),
         ref: forwardedRef,
-        children: /* @__PURE__ */ jsx("button", { type: "button", children })
+        children: /* @__PURE__ */ jsxs(
+          "button",
+          {
+            type: "button",
+            onClick: () => {
+              if (!context?.onSelectedChange || context.selected === void 0)
+                return;
+              context.onSelectedChange(!context.selected);
+            },
+            children: [
+              label,
+              context?.selected && /* @__PURE__ */ jsx(VisuallyHidden, { children: "Selected item" })
+            ]
+          }
+        )
+      }
+    );
+  }
+);
+const TreeItemActions = forwardRef(
+  (props, forwardedRef) => {
+    const { visible, ...rest } = props;
+    return /* @__PURE__ */ jsx(
+      Ariakit.Toolbar,
+      {
+        ...rest,
+        className: cx("\u{1F95D}-tree-item-actions", props.className),
+        "data-kiwi-visible": visible,
+        ref: forwardedRef,
+        children: props.children
       }
     );
   }
@@ -106,8 +168,6 @@ const TreeChevron = forwardRef(
 );
 const TreeItemContext = React.createContext(void 0);
 export {
-  TreeItemContent as Content,
-  TreeItemExpander as Expander,
   TreeItem as Item,
   Tree as Root
 };

package/dist/bricks/index.d.ts

@@ -2,6 +2,8 @@ export { Root } from "./Root.js";
 export { Anchor } from "./Anchor.js";
 export { Button } from "./Button.js";
 export { Checkbox } from "./Checkbox.js";
+export { Chip } from "./Chip.js";
+export { Description } from "./Description.js";
 export * as DropdownMenu from "./DropdownMenu.js";
 export { Divider } from "./Divider.js";
 export { Icon } from "./Icon.js";
@@ -11,9 +13,11 @@ export { Kbd } from "./Kbd.js";
 export { Label } from "./Label.js";
 export { Radio } from "./Radio.js";
 export * as Select from "./Select.js";
+export { Spinner } from "./Spinner.js";
 export { Switch } from "./Switch.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 { Tooltip } from "./Tooltip.js";
 export { VisuallyHidden } from "./VisuallyHidden.js";

package/dist/bricks/index.js

@@ -3,6 +3,8 @@ import { Root } from "./Root.js";
 import { Anchor } from "./Anchor.js";
 import { Button } from "./Button.js";
 import { Checkbox } from "./Checkbox.js";
+import { Chip } from "./Chip.js";
+import { Description } from "./Description.js";
 import * as DropdownMenu from "./DropdownMenu.js";
 import { Divider } from "./Divider.js";
 import { Icon } from "./Icon.js";
@@ -12,16 +14,20 @@ import { Kbd } from "./Kbd.js";
 import { Label } from "./Label.js";
 import { Radio } from "./Radio.js";
 import * as Select from "./Select.js";
+import { Spinner } from "./Spinner.js";
 import { Switch } from "./Switch.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 { Tooltip } from "./Tooltip.js";
 import { VisuallyHidden } from "./VisuallyHidden.js";
 export {
   Anchor,
   Button,
   Checkbox,
+  Chip,
+  Description,
   Divider,
   DropdownMenu,
   Field,
@@ -32,10 +38,12 @@ export {
   Radio,
   Root,
   Select,
+  Spinner,
   Switch,
   Tabs,
   Text,
   TextBox,
   Tooltip,
+  Tree,
   VisuallyHidden
 };