@itwin/itwinui-react 1.48.1 → 2.0.0-dev.0

package/cjs/core/utils/hooks/useTheme.d.ts

@@ -1,9 +1,13 @@
 import '@itwin/itwinui-css/css/global.css';
+import '@itwin/itwinui-variables/index.css';
 export declare type ThemeOptions = {
     /**
      * Document to which the theme will be applied.
      * Can be specified to handle popup windows.
      * @default document
+     *
+     * @deprecated This prop will continue to work in `useTheme` but
+     * we recommend rendering `ThemeProvider` in the correct document instead.
      */
     ownerDocument?: Document;
     /**
@@ -13,10 +17,23 @@ export declare type ThemeOptions = {
     highContrast?: boolean;
 };
 export declare type ThemeType = 'light' | 'dark' | 'os';
+export declare type UseThemeProps = {
+    /**
+     * Theme to be applied. If not set, light theme will be used.
+     */
+    theme?: ThemeType;
+    /**
+     * Options that can be specified to override default theming behavior.
+     */
+    themeOptions?: ThemeOptions;
+};
 /**
- * Hook that applies styling and theme to all components.
- * Defaults to light theme if none provided or set elsewhere.
+ * Hook that conditionally applies styling and theme to all components.
+ * Defaults to light theme if none provided.
+ *
+ * If ThemeProvider is used as an ancestor, this hook will not do anything.
+ *
  * @param theme Light, dark, or based on OS setting.
  * @param themeOptions Options that override default theming behavior.
  */
-export declare const useTheme: (theme?: ThemeType, themeOptions?: ThemeOptions) => void;
+export declare const useTheme: (theme?: UseThemeProps['theme'], themeOptions?: UseThemeProps['themeOptions']) => void;

package/cjs/core/utils/hooks/useTheme.js

@@ -9,78 +9,77 @@ exports.useTheme = void 0;
  * See LICENSE.md in the project root for license terms and full copyright notice.
  *--------------------------------------------------------------------------------------------*/
 var react_1 = __importDefault(require("react"));
+var ThemeProvider_1 = require("../../ThemeProvider/ThemeProvider");
+var functions_1 = require("../functions");
+var useIsomorphicLayoutEffect_1 = require("./useIsomorphicLayoutEffect");
 require("@itwin/itwinui-css/css/global.css");
-var dom_1 = require("../functions/dom");
-var useMediaQuery_1 = require("./useMediaQuery");
+require("@itwin/itwinui-variables/index.css");
 /**
- * Hook that applies styling and theme to all components.
- * Defaults to light theme if none provided or set elsewhere.
+ * Hook that conditionally applies styling and theme to all components.
+ * Defaults to light theme if none provided.
+ *
+ * If ThemeProvider is used as an ancestor, this hook will not do anything.
+ *
  * @param theme Light, dark, or based on OS setting.
  * @param themeOptions Options that override default theming behavior.
  */
 var useTheme = function (theme, themeOptions) {
     var _a;
-    var ownerDocument = (_a = themeOptions === null || themeOptions === void 0 ? void 0 : themeOptions.ownerDocument) !== null && _a !== void 0 ? _a : (0, dom_1.getDocument)();
-    var prefersHighContrast = (0, useMediaQuery_1.useMediaQuery)('(prefers-contrast: more)');
-    var highContrast = react_1.default.useMemo(function () { var _a; return !!((_a = themeOptions === null || themeOptions === void 0 ? void 0 : themeOptions.highContrast) !== null && _a !== void 0 ? _a : prefersHighContrast); }, [prefersHighContrast, themeOptions === null || themeOptions === void 0 ? void 0 : themeOptions.highContrast]);
-    react_1.default.useLayoutEffect(function () {
-        if (!(ownerDocument === null || ownerDocument === void 0 ? void 0 : ownerDocument.body.classList.contains('iui-body'))) {
-            ownerDocument === null || ownerDocument === void 0 ? void 0 : ownerDocument.body.classList.add('iui-body');
-        }
-    }, [ownerDocument]);
-    react_1.default.useLayoutEffect(function () {
-        var _a, _b, _c, _d, _e;
-        if (!ownerDocument) {
+    var themeContext = react_1.default.useContext(ThemeProvider_1.ThemeContext);
+    var ownerDocument = (_a = themeOptions === null || themeOptions === void 0 ? void 0 : themeOptions.ownerDocument) !== null && _a !== void 0 ? _a : (0, functions_1.getDocument)();
+    (0, useIsomorphicLayoutEffect_1.useIsomorphicLayoutEffect)(function () {
+        // exit early if theme was already set by provider
+        if (themeContext || !ownerDocument) {
             return;
         }
-        var prefersDarkMediaQuery = (_b = (_a = (0, dom_1.getWindow)()) === null || _a === void 0 ? void 0 : _a.matchMedia) === null || _b === void 0 ? void 0 : _b.call(_a, '(prefers-color-scheme: dark)');
-        var addOSTheme = function (_a) {
-            var isDark = _a.matches;
-            if (isDark) {
-                applyTheme('dark', { ownerDocument: ownerDocument, highContrast: highContrast });
-            }
-            else {
-                applyTheme('light', { ownerDocument: ownerDocument, highContrast: highContrast });
-            }
-        };
+        ownerDocument.body.classList.toggle('iui-root', true);
         switch (theme) {
             case 'light':
-                (_c = prefersDarkMediaQuery === null || prefersDarkMediaQuery === void 0 ? void 0 : prefersDarkMediaQuery.removeEventListener) === null || _c === void 0 ? void 0 : _c.call(prefersDarkMediaQuery, 'change', addOSTheme);
-                applyTheme('light', { ownerDocument: ownerDocument, highContrast: highContrast });
-                break;
             case 'dark':
-                (_d = prefersDarkMediaQuery === null || prefersDarkMediaQuery === void 0 ? void 0 : prefersDarkMediaQuery.removeEventListener) === null || _d === void 0 ? void 0 : _d.call(prefersDarkMediaQuery, 'change', addOSTheme);
-                applyTheme('dark', { ownerDocument: ownerDocument, highContrast: highContrast });
-                break;
-            case 'os':
-                if (prefersDarkMediaQuery != undefined) {
-                    addOSTheme(prefersDarkMediaQuery);
-                    (_e = prefersDarkMediaQuery.addEventListener) === null || _e === void 0 ? void 0 : _e.call(prefersDarkMediaQuery, 'change', addOSTheme);
-                }
-                else {
-                    applyTheme('light', { ownerDocument: ownerDocument, highContrast: highContrast });
-                }
-                break;
-            default:
-                if (ownerDocument.documentElement.className.indexOf('iui-theme') === -1) {
-                    applyTheme('light', { ownerDocument: ownerDocument, highContrast: highContrast });
+            case 'os': {
+                return handleTheme(theme, ownerDocument, themeOptions === null || themeOptions === void 0 ? void 0 : themeOptions.highContrast);
+            }
+            default: {
+                // set light theme by default
+                if (ownerDocument.documentElement.dataset.iuiTheme == null) {
+                    return handleTheme('light', ownerDocument, themeOptions === null || themeOptions === void 0 ? void 0 : themeOptions.highContrast);
                 }
+                return;
+            }
         }
-        return function () {
-            var _a;
-            (_a = prefersDarkMediaQuery === null || prefersDarkMediaQuery === void 0 ? void 0 : prefersDarkMediaQuery.removeEventListener) === null || _a === void 0 ? void 0 : _a.call(prefersDarkMediaQuery, 'change', addOSTheme);
-        };
-    }, [highContrast, ownerDocument, theme]);
+    }, [theme, themeContext, themeOptions === null || themeOptions === void 0 ? void 0 : themeOptions.highContrast, ownerDocument]);
 };
 exports.useTheme = useTheme;
-var applyTheme = function (theme, _a) {
-    var ownerDocument = _a.ownerDocument, highContrast = _a.highContrast;
-    var classList = ownerDocument.documentElement.classList;
-    var currentTheme = Array.from(classList).find(function (cls) {
-        return cls.startsWith('iui-theme');
-    });
-    if (currentTheme) {
-        classList.remove(currentTheme);
-    }
-    classList.add("iui-theme-".concat(theme).concat(highContrast ? '-hc' : ''));
+/**
+ * Helper function to apply the specified theme, or detect the OS theme.
+ * Returns a cleanup function to remove the change handlers.
+ */
+var handleTheme = function (theme, ownerDocument, highContrast) {
+    var _a, _b, _c, _d, _e;
+    var root = ownerDocument.documentElement;
+    var _window = (_a = ownerDocument.defaultView) !== null && _a !== void 0 ? _a : (0, functions_1.getWindow)();
+    var applyThemeAttributes = function (isDark, isHC) {
+        if (isDark === void 0) { isDark = false; }
+        if (isHC === void 0) { isHC = false; }
+        root.dataset.iuiTheme = isDark ? 'dark' : 'light';
+        root.dataset.iuiContrast = isHC ? 'high' : 'default';
+    };
+    var prefersDarkQuery = (_b = _window === null || _window === void 0 ? void 0 : _window.matchMedia) === null || _b === void 0 ? void 0 : _b.call(_window, '(prefers-color-scheme: dark)');
+    var prefersHCQuery = (_c = _window === null || _window === void 0 ? void 0 : _window.matchMedia) === null || _c === void 0 ? void 0 : _c.call(_window, '(prefers-contrast: more)');
+    var changeHandler = function () {
+        var isDark = theme === 'dark' || (theme === 'os' && (prefersDarkQuery === null || prefersDarkQuery === void 0 ? void 0 : prefersDarkQuery.matches));
+        var isHC = highContrast !== null && highContrast !== void 0 ? highContrast : prefersHCQuery === null || prefersHCQuery === void 0 ? void 0 : prefersHCQuery.matches;
+        applyThemeAttributes(isDark, isHC);
+    };
+    // call handler once to set initial theme
+    changeHandler();
+    // add listeners in supported browsers
+    (_d = prefersDarkQuery === null || prefersDarkQuery === void 0 ? void 0 : prefersDarkQuery.addEventListener) === null || _d === void 0 ? void 0 : _d.call(prefersDarkQuery, 'change', changeHandler);
+    (_e = prefersHCQuery === null || prefersHCQuery === void 0 ? void 0 : prefersHCQuery.addEventListener) === null || _e === void 0 ? void 0 : _e.call(prefersHCQuery, 'change', changeHandler);
+    // return cleanup function to remove event listeners (should be returned from useEffect)
+    return function () {
+        var _a, _b;
+        (_a = prefersDarkQuery === null || prefersDarkQuery === void 0 ? void 0 : prefersDarkQuery.removeEventListener) === null || _a === void 0 ? void 0 : _a.call(prefersDarkQuery, 'change', changeHandler);
+        (_b = prefersHCQuery === null || prefersHCQuery === void 0 ? void 0 : prefersHCQuery.removeEventListener) === null || _b === void 0 ? void 0 : _b.call(prefersHCQuery, 'change', changeHandler);
+    };
 };

package/esm/core/Alert/Alert.d.ts

@@ -15,11 +15,6 @@ export declare type AlertProps = {
      * Props for the clickable text. Used for providing `href` and other attributes.
      */
     clickableTextProps?: React.ComponentPropsWithRef<'a'>;
-    /**
-     * Action handler for the clickable text.
-     * @deprecated `clickableTextProps` should be used instead.
-     */
-    onClick?: () => void;
     /**
      * Action handler for close.
      */
@@ -41,7 +36,13 @@ export declare type AlertProps = {
  * <Alert type='positive'>This is a positive alert.</Alert>
  * <Alert type='warning'>This is a warning alert.</Alert>
  * <Alert type='negative'>This is a negative alert.</Alert>
- * <Alert type='positive' clickableText="I am a clickable text" onClick={()=>alert("Pressed")}>This is a positive alert with a clickable text</Alert>
+ * <Alert
+ *  type='positive'
+ *  clickableText="I am a clickable text"
+ *  clickableTextProps={{ href: 'https://www.example.com' }}
+ * >
+ *   This is a positive alert with a clickable text
+ * </Alert>
  */
 export declare const Alert: (props: AlertProps) => JSX.Element;
 export default Alert;

package/esm/core/Alert/Alert.js

@@ -29,7 +29,6 @@ import cx from 'classnames';
 import React from 'react';
 import { useTheme, StatusIconMap } from '../utils';
 import '@itwin/itwinui-css/css/alert.css';
-import { IconButton } from '../Buttons/IconButton';
 /**
  * A small box to quickly grab user attention and communicate a brief message
  * @example
@@ -37,18 +36,24 @@ import { IconButton } from '../Buttons/IconButton';
  * <Alert type='positive'>This is a positive alert.</Alert>
  * <Alert type='warning'>This is a warning alert.</Alert>
  * <Alert type='negative'>This is a negative alert.</Alert>
- * <Alert type='positive' clickableText="I am a clickable text" onClick={()=>alert("Pressed")}>This is a positive alert with a clickable text</Alert>
+ * <Alert
+ *  type='positive'
+ *  clickableText="I am a clickable text"
+ *  clickableTextProps={{ href: 'https://www.example.com' }}
+ * >
+ *   This is a positive alert with a clickable text
+ * </Alert>
  */
 export var Alert = function (props) {
-    var children = props.children, className = props.className, _a = props.type, type = _a === void 0 ? 'informational' : _a, clickableText = props.clickableText, clickableTextProps = props.clickableTextProps, onClick = props.onClick, onClose = props.onClose, style = props.style, _b = props.isSticky, isSticky = _b === void 0 ? false : _b, rest = __rest(props, ["children", "className", "type", "clickableText", "clickableTextProps", "onClick", "onClose", "style", "isSticky"]);
+    var children = props.children, className = props.className, _a = props.type, type = _a === void 0 ? 'informational' : _a, clickableText = props.clickableText, clickableTextProps = props.clickableTextProps, onClose = props.onClose, style = props.style, _b = props.isSticky, isSticky = _b === void 0 ? false : _b, rest = __rest(props, ["children", "className", "type", "clickableText", "clickableTextProps", "onClose", "style", "isSticky"]);
     useTheme();
     var StatusIcon = StatusIconMap[type];
-    return (React.createElement("div", __assign({ className: cx('iui-alert', "iui-".concat(type), { 'iui-sticky': isSticky }, className), style: style }, rest),
+    return (React.createElement("div", __assign({ className: cx("iui-alert-".concat(type), { 'iui-sticky': isSticky }, className), style: style }, rest),
         React.createElement(StatusIcon, { className: 'iui-alert-icon' }),
         React.createElement("span", { className: 'iui-alert-message' },
             children,
-            clickableText && (React.createElement("a", __assign({ onClick: onClick }, clickableTextProps, { className: cx('iui-alert-link', clickableTextProps === null || clickableTextProps === void 0 ? void 0 : clickableTextProps.className) }), clickableText))),
-        onClose && (React.createElement(IconButton, { styleType: 'borderless', size: 'small', onClick: onClose, "aria-label": 'Close' },
-            React.createElement(SvgCloseSmall, { "aria-hidden": true })))));
+            clickableText && (React.createElement("a", __assign({}, clickableTextProps, { className: cx('iui-alert-link', clickableTextProps === null || clickableTextProps === void 0 ? void 0 : clickableTextProps.className) }), clickableText))),
+        onClose && (React.createElement("button", { onClick: onClose, "aria-label": 'Close', type: 'button', className: 'iui-alert-button' },
+            React.createElement(SvgCloseSmall, { "aria-hidden": true, className: 'iui-alert-button-icon' })))));
 };
 export default Alert;

package/esm/core/Avatar/Avatar.d.ts

@@ -0,0 +1,69 @@
+/// <reference types="react" />
+import { CommonProps } from '../utils';
+import '@itwin/itwinui-css/css/avatar.css';
+export declare type AvatarStatus = 'online' | 'busy' | 'away' | 'offline';
+/**
+ * @deprecated Since v2, this has been renamed to `AvatarStatus` (Use with `Avatar`)
+ */
+export declare type UserIconStatus = AvatarStatus;
+export declare type StatusTitles = {
+    [key in Exclude<AvatarStatus, ''>]: string;
+};
+export declare type AvatarProps = {
+    /**
+     * Size of a avatar.
+     * @default 'small'
+     */
+    size?: 'small' | 'medium' | 'large' | 'x-large';
+    /**
+     * Status/Availability of a user.
+     */
+    status?: AvatarStatus;
+    /**
+     * Text which will appear when hovering over the icon.
+     */
+    title?: string;
+    /**
+     * Abbreviation to be displayed.
+     */
+    abbreviation?: string;
+    /**
+     * User image to be displayed. MUST be an <img> element!
+     */
+    image?: JSX.Element;
+    /**
+     * Color of the icon. You can use `getUserColor` function to generate color from user name or email.
+     * @default 'white'
+     */
+    backgroundColor?: string;
+    /**
+     * Translated status messages shown on hover.
+     */
+    translatedStatusTitles?: StatusTitles;
+} & Omit<CommonProps, 'title'>;
+/**
+ * @deprecated Since v2, this has been renamed to `AvatarProps` (Use with `Avatar`)
+ */
+export declare type UserIconProps = AvatarProps;
+export declare const defaultStatusTitles: StatusTitles;
+/**
+ * Basic avatar component
+ * @example
+ * <caption>Small icon with abbreviation</caption>
+ * <Avatar size='small' title='Terry Rivers' abbreviation='TR' backgroundColor='green'/>
+ * @example
+ * <caption>Medium icon with image</caption>
+ * <Avatar size='medium' title='Terry Rivers' abbreviation='TR' backgroundColor='green' image={<img src="https://cdn.example.com/user/profile/pic.png" />}/>
+ * @example
+ * <caption>Large icon with status</caption>
+ * <Avatar size='large' title='Terry Rivers' abbreviation='TR' backgroundColor='green' status='online' />
+ * @example
+ * <caption>X-large icon with image</caption>
+ * <Avatar size='x-large' title='Terry Rivers' abbreviation='TR' backgroundColor='green' image={<img src="https://cdn.example.com/user/profile/pic.png" />}/>
+ */
+export declare const Avatar: (props: AvatarProps) => JSX.Element;
+/**
+ * @deprecated Since v2, this has been renamed to `Avatar`
+ */
+export declare const UserIcon: (props: AvatarProps) => JSX.Element;
+export default Avatar;

package/esm/core/{UserIcon/UserIcon.js → Avatar/Avatar.js}

@@ -27,7 +27,7 @@ var __rest = (this && this.__rest) || function (s, e) {
 import cx from 'classnames';
 import React from 'react';
 import { useTheme } from '../utils';
-import '@itwin/itwinui-css/css/user-icon.css';
+import '@itwin/itwinui-css/css/avatar.css';
 export var defaultStatusTitles = {
     away: 'Away',
     busy: 'Busy',
@@ -35,29 +35,33 @@ export var defaultStatusTitles = {
     online: 'Online',
 };
 /**
- * Basic user icon component
+ * Basic avatar component
  * @example
  * <caption>Small icon with abbreviation</caption>
- * <UserIcon size='small' title='Terry Rivers' abbreviation='TR' backgroundColor='green'/>
+ * <Avatar size='small' title='Terry Rivers' abbreviation='TR' backgroundColor='green'/>
  * @example
  * <caption>Medium icon with image</caption>
- * <UserIcon size='medium' title='Terry Rivers' abbreviation='TR' backgroundColor='green' image={<img src="https://cdn.example.com/user/profile/pic.png" />}/>
+ * <Avatar size='medium' title='Terry Rivers' abbreviation='TR' backgroundColor='green' image={<img src="https://cdn.example.com/user/profile/pic.png" />}/>
  * @example
  * <caption>Large icon with status</caption>
- * <UserIcon size='large' title='Terry Rivers' abbreviation='TR' backgroundColor='green' status='online' />
+ * <Avatar size='large' title='Terry Rivers' abbreviation='TR' backgroundColor='green' status='online' />
  * @example
  * <caption>X-large icon with image</caption>
- * <UserIcon size='x-large' title='Terry Rivers' abbreviation='TR' backgroundColor='green' image={<img src="https://cdn.example.com/user/profile/pic.png" />}/>
+ * <Avatar size='x-large' title='Terry Rivers' abbreviation='TR' backgroundColor='green' image={<img src="https://cdn.example.com/user/profile/pic.png" />}/>
  */
-export var UserIcon = function (props) {
+export var Avatar = function (props) {
     var _a, _b;
     var _c = props.size, size = _c === void 0 ? 'small' : _c, status = props.status, abbreviation = props.abbreviation, image = props.image, _d = props.backgroundColor, backgroundColor = _d === void 0 ? 'white' : _d, title = props.title, translatedStatusTitles = props.translatedStatusTitles, className = props.className, style = props.style, rest = __rest(props, ["size", "status", "abbreviation", "image", "backgroundColor", "title", "translatedStatusTitles", "className", "style"]);
     useTheme();
     var statusTitles = __assign(__assign({}, defaultStatusTitles), translatedStatusTitles);
-    return (React.createElement("span", __assign({ className: cx('iui-user-icon', (_a = {}, _a["iui-".concat(size)] = size !== 'medium', _a), className), title: title, style: style }, rest), image !== null && image !== void 0 ? image : (React.createElement("abbr", { className: 'iui-initials', style: { backgroundColor: backgroundColor } }, abbreviation === null || abbreviation === void 0 ? void 0 : abbreviation.substring(0, 2))),
+    return (React.createElement("span", __assign({ className: cx('iui-avatar', (_a = {}, _a["iui-".concat(size)] = size !== 'medium', _a), className), title: title, style: style }, rest), image !== null && image !== void 0 ? image : (React.createElement("abbr", { className: 'iui-initials', style: { backgroundColor: backgroundColor } }, abbreviation === null || abbreviation === void 0 ? void 0 : abbreviation.substring(0, 2))),
         React.createElement("span", { className: 'iui-stroke' }),
         status && (React.createElement("span", { title: statusTitles[status], className: cx('iui-status', (_b = {},
                 _b["iui-".concat(status)] = !!status,
                 _b)), "aria-label": statusTitles[status] }))));
 };
-export default UserIcon;
+/**
+ * @deprecated Since v2, this has been renamed to `Avatar`
+ */
+export var UserIcon = Avatar;
+export default Avatar;

package/esm/core/Avatar/index.d.ts

@@ -0,0 +1,4 @@
+export { Avatar, UserIcon } from './Avatar';
+export type { AvatarProps, StatusTitles, AvatarStatus, UserIconProps, UserIconStatus, } from './Avatar';
+declare const _default: "./Avatar";
+export default _default;

package/esm/core/{UserIcon → Avatar}/index.js

@@ -2,5 +2,5 @@
  * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
  * See LICENSE.md in the project root for license terms and full copyright notice.
  *--------------------------------------------------------------------------------------------*/
-export { UserIcon } from './UserIcon';
-export default './UserIcon';
+export { Avatar, UserIcon } from './Avatar';
+export default './Avatar';

package/esm/core/AvatarGroup/AvatarGroup.d.ts

@@ -0,0 +1,70 @@
+import React from 'react';
+import { CommonProps } from '../utils';
+import '@itwin/itwinui-css/css/avatar.css';
+export declare type AvatarGroupProps = {
+    /**
+     * Max number of avatars unstacked.
+     * @default 5
+     */
+    maxIcons?: number;
+    /**
+     * If true, group will be stacked to take less space.
+     * @default true
+     */
+    stacked?: boolean;
+    /**
+     * If true, group will be animated on hover.
+     * @default false
+     */
+    animated?: boolean;
+    /**
+     * Size of avatars and count avatars.
+     * @default 'small'
+     */
+    iconSize?: 'small' | 'medium' | 'large' | 'x-large';
+    /**
+     * Avatars in the group.
+     */
+    children: React.ReactNode;
+    /**
+     * Count Avatar props.
+     */
+    countIconProps?: React.ComponentPropsWithRef<'div'>;
+} & Omit<CommonProps, 'title'>;
+/**
+ * @deprecated Since v2, this has been renamed to `AvatarGroupProps` (Use with `AvatarGroup`)
+ */
+export declare type UserIconGroupProps = AvatarGroupProps;
+/**
+ * Group Avatars together.
+ *
+ * Avatars stacking is based on `maxAvatars` count. If you provide 8 Avatars and keep default 5 `maxAvatars` count,
+ * this component will show 5 Avatars and Count Avatar with "3" in it.
+ *
+ * You can add custom Count Avatar behavior by using `countAvatarProps`.
+ *
+ * @example
+ * <AvatarGroup avatarSize='medium'>
+ *  <Avatar
+ *    abbreviation="TR"
+ *    backgroundColor={getUserColor("Terry Rivers")}
+ *    title="Terry Rivers"
+ *  />
+ *  <Avatar
+ *    abbreviation="RM"
+ *    backgroundColor={getUserColor("Robin Mercer")}
+ *    title="Robin Mercer"
+ *  />
+ *  <Avatar
+ *    abbreviation="JM"
+ *    backgroundColor={getUserColor("Jean Mullins")}
+ *    title="Jean Mullins"
+ *  />
+ * </AvatarGroup>
+ */
+export declare const AvatarGroup: (props: AvatarGroupProps) => JSX.Element;
+/**
+ * @deprecated Since v2, this has been renamed to `AvatarGroup`
+ */
+export declare const UserIconGroup: (props: AvatarGroupProps) => JSX.Element;
+export default AvatarGroup;

package/esm/core/{UserIconGroup/UserIconGroup.js → AvatarGroup/AvatarGroup.js}

@@ -27,42 +27,42 @@ var __rest = (this && this.__rest) || function (s, e) {
 import React from 'react';
 import cx from 'classnames';
 import { useTheme } from '../utils';
-import '@itwin/itwinui-css/css/user-icon.css';
+import '@itwin/itwinui-css/css/avatar.css';
 /**
- * Group User Icons together.
+ * Group Avatars together.
  *
- * User Icons stacking is based on `maxIcons` count. If you provide 8 User Icons and keep default 5 `maxIcons` count,
- * this component will show 5 User Icons and User Count Icon with "3" in it.
+ * Avatars stacking is based on `maxAvatars` count. If you provide 8 Avatars and keep default 5 `maxAvatars` count,
+ * this component will show 5 Avatars and Count Avatar with "3" in it.
  *
- * You can add custom User Count Icon behavior by using `countIconProps`.
+ * You can add custom Count Avatar behavior by using `countAvatarProps`.
  *
  * @example
- * <UserIconGroup iconSize='medium'>
- *  <UserIcon
+ * <AvatarGroup avatarSize='medium'>
+ *  <Avatar
  *    abbreviation="TR"
  *    backgroundColor={getUserColor("Terry Rivers")}
  *    title="Terry Rivers"
  *  />
- *  <UserIcon
+ *  <Avatar
  *    abbreviation="RM"
  *    backgroundColor={getUserColor("Robin Mercer")}
  *    title="Robin Mercer"
  *  />
- *  <UserIcon
+ *  <Avatar
  *    abbreviation="JM"
  *    backgroundColor={getUserColor("Jean Mullins")}
  *    title="Jean Mullins"
  *  />
- * </UserIconGroup>
+ * </AvatarGroup>
  */
-export var UserIconGroup = function (props) {
+export var AvatarGroup = function (props) {
     var _a;
     var maxLength = 99;
     var children = props.children, _b = props.animated, animated = _b === void 0 ? false : _b, _c = props.stacked, stacked = _c === void 0 ? true : _c, _d = props.maxIcons, maxIcons = _d === void 0 ? 5 : _d, _e = props.iconSize, iconSize = _e === void 0 ? 'small' : _e, countIconProps = props.countIconProps, className = props.className, rest = __rest(props, ["children", "animated", "stacked", "maxIcons", "iconSize", "countIconProps", "className"]);
     var childrenArray = React.Children.toArray(children);
     var childrenLength = childrenArray.length;
     useTheme();
-    var getUserIconList = function (count) {
+    var getAvatarList = function (count) {
         return childrenArray.slice(0, count).map(function (child) {
             return React.cloneElement(child, {
                 status: undefined,
@@ -71,17 +71,21 @@ export var UserIconGroup = function (props) {
         });
     };
     return (React.createElement(React.Fragment, null,
-        React.createElement("div", __assign({ className: cx('iui-user-icon-list', {
+        React.createElement("div", __assign({ className: cx('iui-avatar-list', {
                 'iui-animated': animated,
                 'iui-stacked': stacked,
             }, className) }, rest),
-            childrenArray.length <= maxIcons + 1 && getUserIconList(maxIcons + 1),
+            childrenArray.length <= maxIcons + 1 && getAvatarList(maxIcons + 1),
             childrenArray.length > maxIcons + 1 && (React.createElement(React.Fragment, null,
-                getUserIconList(maxIcons),
-                React.createElement("div", __assign({}, countIconProps, { className: cx('iui-user-icon', (_a = {}, _a["iui-".concat(iconSize)] = iconSize !== 'medium', _a), 'iui-user-icon-count', countIconProps === null || countIconProps === void 0 ? void 0 : countIconProps.className) }),
+                getAvatarList(maxIcons),
+                React.createElement("div", __assign({}, countIconProps, { className: cx('iui-avatar', (_a = {}, _a["iui-".concat(iconSize)] = iconSize !== 'medium', _a), 'iui-avatar-count', countIconProps === null || countIconProps === void 0 ? void 0 : countIconProps.className) }),
                     React.createElement("abbr", { className: 'iui-initials' }, childrenLength <= maxLength
                         ? "".concat(childrenLength - maxIcons)
                         : "".concat(maxLength, "+")),
                     React.createElement("span", { className: 'iui-stroke' })))))));
 };
-export default UserIconGroup;
+/**
+ * @deprecated Since v2, this has been renamed to `AvatarGroup`
+ */
+export var UserIconGroup = AvatarGroup;
+export default AvatarGroup;

package/esm/core/AvatarGroup/index.d.ts

@@ -0,0 +1,4 @@
+export { AvatarGroup, UserIconGroup } from './AvatarGroup';
+export type { AvatarGroupProps, UserIconGroupProps } from './AvatarGroup';
+declare const _default: "./AvatarGroup";
+export default _default;

package/esm/core/{UserIconGroup → AvatarGroup}/index.js

@@ -2,5 +2,5 @@
  * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
  * See LICENSE.md in the project root for license terms and full copyright notice.
  *--------------------------------------------------------------------------------------------*/
-export { UserIconGroup } from './UserIconGroup';
-export default './UserIconGroup';
+export { AvatarGroup, UserIconGroup } from './AvatarGroup';
+export default './AvatarGroup';

package/esm/core/Badge/Badge.js

@@ -26,7 +26,7 @@ var __rest = (this && this.__rest) || function (s, e) {
  *--------------------------------------------------------------------------------------------*/
 import React from 'react';
 import cx from 'classnames';
-import { useTheme, getWindow, isSoftBackground, SoftBackgrounds, } from '../utils';
+import { useTheme, isSoftBackground, SoftBackgrounds, } from '../utils';
 import '@itwin/itwinui-css/css/badge.css';
 /**
  * Helper function that returns one of the preset badge color values.
@@ -56,12 +56,10 @@ var getBadgeColorValue = function (color) {
  * <Badge backgroundColor="positive">Label</Badge>
  */
 export var Badge = function (props) {
-    var _a, _b, _c;
     var backgroundColor = props.backgroundColor, style = props.style, className = props.className, children = props.children, rest = __rest(props, ["backgroundColor", "style", "className", "children"]);
     useTheme();
-    var _style = backgroundColor &&
-        ((_c = (_b = (_a = getWindow()) === null || _a === void 0 ? void 0 : _a.CSS) === null || _b === void 0 ? void 0 : _b.supports) === null || _c === void 0 ? void 0 : _c.call(_b, "--iui-badge-background-color: ".concat(backgroundColor)))
-        ? __assign({ '--iui-badge-background-color': getBadgeColorValue(backgroundColor) }, style) : __assign({ backgroundColor: getBadgeColorValue(backgroundColor) }, style);
+    var _style = backgroundColor
+        ? __assign({ '--iui-badge-background-color': getBadgeColorValue(backgroundColor) }, style) : __assign({}, style);
     return (React.createElement("span", __assign({ className: cx('iui-badge', className), style: _style }, rest), children));
 };
 export default Badge;

package/esm/core/ButtonGroup/ButtonGroup.d.ts

@@ -54,5 +54,5 @@ export declare type ButtonGroupProps = {
  *   {buttons}
  * </ButtonGroup>
  */
-export declare const ButtonGroup: React.ForwardRefExoticComponent<Pick<ButtonGroupProps, "orientation" | "key" | keyof React.HTMLAttributes<HTMLDivElement> | "overflowButton" | "overflowPlacement"> & React.RefAttributes<HTMLDivElement>>;
+export declare const ButtonGroup: React.ForwardRefExoticComponent<Pick<ButtonGroupProps, "key" | keyof React.HTMLAttributes<HTMLDivElement> | "orientation" | "overflowButton" | "overflowPlacement"> & React.RefAttributes<HTMLDivElement>>;
 export default ButtonGroup;

package/esm/core/Buttons/Button/Button.js

@@ -38,20 +38,11 @@ import '@itwin/itwinui-css/css/button.css';
  * <Button startIcon={<SvgAdd />}>New</Button>
  */
 export var Button = React.forwardRef(function (props, ref) {
-    var _a;
-    var children = props.children, className = props.className, size = props.size, style = props.style, _b = props.styleType, styleType = _b === void 0 ? 'default' : _b, _c = props.type, type = _c === void 0 ? 'button' : _c, startIcon = props.startIcon, endIcon = props.endIcon, _d = props.as, Element = _d === void 0 ? 'button' : _d, rest = __rest(props, ["children", "className", "size", "style", "styleType", "type", "startIcon", "endIcon", "as"]);
+    var children = props.children, className = props.className, size = props.size, style = props.style, _a = props.styleType, styleType = _a === void 0 ? 'default' : _a, _b = props.type, type = _b === void 0 ? 'button' : _b, startIcon = props.startIcon, endIcon = props.endIcon, _c = props.as, Element = _c === void 0 ? 'button' : _c, rest = __rest(props, ["children", "className", "size", "style", "styleType", "type", "startIcon", "endIcon", "as"]);
     useTheme();
-    return (React.createElement(Element, __assign({ ref: ref, className: cx('iui-button', "iui-".concat(styleType), (_a = {},
-            _a["iui-".concat(size)] = !!size,
-            _a), className), style: style, type: type }, rest),
-        startIcon &&
-            React.cloneElement(startIcon, {
-                className: cx('iui-button-icon', startIcon.props.className),
-            }),
-        children && React.createElement("span", { className: 'iui-button-label' }, children),
-        endIcon &&
-            React.cloneElement(endIcon, {
-                className: cx('iui-button-icon', endIcon.props.className),
-            })));
+    return (React.createElement(Element, __assign({ ref: ref, className: cx('iui-button', className), "data-iui-variant": styleType !== 'default' ? styleType : undefined, "data-iui-size": size, style: style, type: type }, rest),
+        startIcon && (React.createElement("span", { className: 'iui-button-icon', "aria-hidden": true }, startIcon)),
+        children && React.createElement("span", null, children),
+        endIcon && (React.createElement("span", { className: 'iui-button-icon', "aria-hidden": true }, endIcon))));
 });
 export default Button;

package/esm/core/Buttons/DropdownButton/DropdownButton.js

@@ -54,6 +54,6 @@ export var DropdownButton = React.forwardRef(function (props, ref) {
         }
     }, [children, size, styleType]);
     return (React.createElement(DropdownMenu, { menuItems: menuItems, style: { minWidth: menuWidth }, onShow: function () { return setIsMenuOpen(true); }, onHide: function () { return setIsMenuOpen(false); } },
-        React.createElement(Button, __assign({ className: cx('iui-dropdown', className), size: size, styleType: styleType, endIcon: isMenuOpen ? (React.createElement(SvgCaretUpSmall, { "aria-hidden": true })) : (React.createElement(SvgCaretDownSmall, { "aria-hidden": true })), ref: refs, "aria-label": 'Dropdown' }, rest), children)));
+        React.createElement(Button, __assign({ className: cx('iui-button-dropdown', className), size: size, styleType: styleType, endIcon: isMenuOpen ? (React.createElement(SvgCaretUpSmall, { "aria-hidden": true })) : (React.createElement(SvgCaretDownSmall, { "aria-hidden": true })), ref: refs, "aria-label": 'Dropdown' }, rest), children)));
 });
 export default DropdownButton;