@itwin/appui-react 4.14.0 → 4.15.0

package/lib/esm/appui-react/theme/ThemeManager.js

@@ -7,35 +7,11 @@
  */
 import "./ThemeManager.scss";
 import * as React from "react";
-import { connect } from "react-redux";
 import { ThemeProvider } from "@itwin/itwinui-react";
 import { ThemeProvider as ThemeProviderV2 } from "@itwin/itwinui-react-v2";
-import { UiFramework } from "../UiFramework";
-/** System preferred color theme.
- * @public
- */
-export const SYSTEM_PREFERRED_COLOR_THEME = "SYSTEM_PREFERRED";
-/** Enum for the Color Theme string.
- * @public
- */
-export var ColorTheme;
-(function (ColorTheme) {
-    /** Will use iTwinUI `light` theme. */
-    ColorTheme["Light"] = "light";
-    /** Will use iTwinUI `dark` theme. */
-    ColorTheme["Dark"] = "dark";
-    /** Will use iTwinUI `os` theme. */
-    ColorTheme["System"] = "SYSTEM_PREFERRED";
-    /** Will use iTwinUI wrapping `ThemeProvider` if provided, or default to 'Light' */
-    ColorTheme["Inherit"] = "inherit";
-    /** Will use iTwinUI `light` theme with `highContrast` set to `true` */
-    ColorTheme["HighContrastLight"] = "high-contrast-light";
-    /** Will use iTwinUI `dark` theme with `highContrast` set to `true` */
-    ColorTheme["HighContrastDark"] = "high-contrast-dark";
-})(ColorTheme || (ColorTheme = {}));
-/**
- * Map of ColorTheme to ThemeType
- */
+import { ColorTheme, SYSTEM_PREFERRED_COLOR_THEME } from "./ThemeId";
+import { useReduxFrameworkState } from "../uistate/useReduxFrameworkState";
+/** Map of ColorTheme to ThemeType. */
 const colorThemeToThemeTypeMap = {
     [ColorTheme.Light]: "light",
     [ColorTheme.HighContrastLight]: "light",
@@ -44,76 +20,11 @@ const colorThemeToThemeTypeMap = {
     [ColorTheme.System]: "os",
     os: "os", // handle "os" for backwards compatibility
 };
-/**
- * List of high contrast color themes
- */
+/** List of high contrast color themes. */
 const highContrastColorThemes = [
     ColorTheme.HighContrastDark,
     ColorTheme.HighContrastLight,
 ];
-/** The default widget opacity.
- * @public
- */
-export const WIDGET_OPACITY_DEFAULT = 0.9;
-/** The default widget opacity.
- * @public
- */
-export const TOOLBAR_OPACITY_DEFAULT = 0.5;
-function mapStateToProps(state) {
-    const frameworkState = state[UiFramework.frameworkStateKey]; // since app sets up key, don't hard-code name
-    if (!frameworkState)
-        return undefined;
-    return {
-        theme: frameworkState.configurableUiState.theme,
-        widgetOpacity: frameworkState.configurableUiState.widgetOpacity,
-        toolbarOpacity: frameworkState.configurableUiState.toolbarOpacity,
-    };
-}
-/** ThemeManagerComponent handles setting themes.
- */
-class ThemeManagerComponent extends React.Component {
-    constructor() {
-        super(...arguments);
-        this._setTheme = (theme) => {
-            document.documentElement.classList.add("theme-transition");
-            document.documentElement.setAttribute("data-theme", theme);
-            window.setTimeout(() => document.documentElement.classList.remove("theme-transition"), 1000);
-        };
-        this._setWidgetOpacity = (opacity) => {
-            const currentWidgetOpacity = document.documentElement.style.getPropertyValue("--buic-widget-opacity");
-            if (currentWidgetOpacity !== opacity.toString()) {
-                setTimeout(() => document.documentElement.style.setProperty("--buic-widget-opacity", opacity.toString()));
-            }
-        };
-        this._setToolbarOpacity = (opacity) => {
-            const currentToolbarOpacity = document.documentElement.style.getPropertyValue("--buic-toolbar-opacity");
-            if (currentToolbarOpacity !== opacity.toString()) {
-                setTimeout(() => {
-                    document.documentElement.style.setProperty("--buic-toolbar-opacity", opacity.toString());
-                });
-            }
-        };
-    }
-    componentDidMount() {
-        this._setTheme(this.props.theme);
-        this._setWidgetOpacity(this.props.widgetOpacity);
-        this._setToolbarOpacity(this.props.toolbarOpacity);
-    }
-    componentDidUpdate(prevProps) {
-        if (this.props.theme !== prevProps.theme)
-            this._setTheme(this.props.theme);
-        if (this.props.widgetOpacity !== prevProps.widgetOpacity)
-            this._setWidgetOpacity(this.props.widgetOpacity);
-        if (this.props.toolbarOpacity !== prevProps.toolbarOpacity)
-            this._setToolbarOpacity(this.props.toolbarOpacity);
-    }
-    render() {
-        const theme = colorThemeToThemeTypeMap[this.props.theme];
-        const highContrast = highContrastColorThemes.includes(this.props.theme);
-        return (React.createElement(ThemeProvider, { className: "uifw-root", theme: theme ?? "inherit", themeOptions: { highContrast }, "data-root-container": "appui-root-id", includeCss: true },
-            React.createElement(ThemeProviderV2 /* v2 ThemeProvider is required to fix popup styling issues in widget popouts. */, { style: { height: "100%" }, theme: theme ?? "inherit", themeOptions: { highContrast } }, this.props.children)));
-    }
-}
 /** ThemeManager handles setting color themes and element opacity management. Note that this component will
  * affect the entire application by setting the data-theme attribute to the html element.
  * It also sets an iTwinUI `ThemeProvider` element locally, so all elements
@@ -123,16 +34,29 @@ class ThemeManagerComponent extends React.Component {
  * and `ThemeProvider` theme will be set to `inherit`, in this case the application is
  * responsible for setting the theme by overriding iTwinUI css variables.
  *
- * This React component is Redux connected and should wrap [[ConfigurableUiContent]].
+ * This React component should wrap {@link ConfigurableUiContent}.
  *
  * ```tsx
- * <Provider store={UiFramework.store}>
- *   <ThemeManager>
- *     <ConfigurableUiContent />
- *   </ThemeManager>
- * </Provider>
+ * <ThemeManager>
+ *   <ConfigurableUiContent />
+ * </ThemeManager>
  * ```
  * @public
  */
-export const ThemeManager = connect(mapStateToProps)(ThemeManagerComponent);
+export function ThemeManager({ children, ...props }) {
+    const reduxTheme = useReduxFrameworkState((state) => {
+        // eslint-disable-next-line deprecation/deprecation
+        return state?.configurableUiState.theme;
+    });
+    const theme = props.theme ?? reduxTheme ?? SYSTEM_PREFERRED_COLOR_THEME;
+    React.useEffect(() => {
+        document.documentElement.classList.add("theme-transition");
+        document.documentElement.setAttribute("data-theme", theme);
+        setTimeout(() => document.documentElement.classList.remove("theme-transition"), 1000);
+    }, [theme]);
+    const providerTheme = colorThemeToThemeTypeMap[theme];
+    const highContrast = highContrastColorThemes.includes(theme);
+    return (React.createElement(ThemeProvider, { className: "uifw-root", theme: providerTheme ?? "inherit", themeOptions: { highContrast }, "data-root-container": "appui-root-id", includeCss: true },
+        React.createElement(ThemeProviderV2 /* v2 ThemeProvider is required to fix popup styling issues in widget popouts. */, { style: { height: "100%" }, theme: providerTheme ?? "inherit", themeOptions: { highContrast } }, children)));
+}
 //# sourceMappingURL=ThemeManager.js.map

package/lib/esm/appui-react/theme/ThemeManager.js.map

@@ -1 +1 @@
-{"version":3,"file":"ThemeManager.js","sourceRoot":"","sources":["../../../../src/appui-react/theme/ThemeManager.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,qBAAqB,CAAC;AAC7B,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAEtC,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,aAAa,IAAI,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAE3E,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C;;GAEG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,kBAAkB,CAAC;AAE/D;;GAEG;AACH,MAAM,CAAN,IAAY,UAaX;AAbD,WAAY,UAAU;IACpB,sCAAsC;IACtC,6BAAe,CAAA;IACf,qCAAqC;IACrC,2BAAa,CAAA;IACb,mCAAmC;IACnC,yCAAqC,CAAA;IACrC,mFAAmF;IACnF,iCAAmB,CAAA;IACnB,uEAAuE;IACvE,uDAAyC,CAAA;IACzC,sEAAsE;IACtE,qDAAuC,CAAA;AACzC,CAAC,EAbW,UAAU,KAAV,UAAU,QAarB;AASD;;GAEG;AACH,MAAM,wBAAwB,GAA+B;IAC3D,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,OAAO;IAC3B,CAAC,UAAU,CAAC,iBAAiB,CAAC,EAAE,OAAO;IACvC,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,MAAM;IACzB,CAAC,UAAU,CAAC,gBAAgB,CAAC,EAAE,MAAM;IACrC,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,IAAI;IACzB,EAAE,EAAE,IAAI,EAAE,0CAA0C;CACrD,CAAC;AAEF;;GAEG;AACH,MAAM,uBAAuB,GAAa;IACxC,UAAU,CAAC,gBAAgB;IAC3B,UAAU,CAAC,iBAAiB;CAC7B,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,GAAG,CAAC;AAE1C;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,GAAG,CAAC;AAa3C,SAAS,eAAe,CAAC,KAAU;IACjC,MAAM,cAAc,GAAG,KAAK,CAAC,WAAW,CAAC,iBAAiB,CAAmB,CAAC,CAAC,8CAA8C;IAC7H,IAAI,CAAC,cAAc;QAAE,OAAO,SAAS,CAAC;IAEtC,OAAO;QACL,KAAK,EAAE,cAAc,CAAC,mBAAmB,CAAC,KAAK;QAC/C,aAAa,EAAE,cAAc,CAAC,mBAAmB,CAAC,aAAa;QAC/D,cAAc,EAAE,cAAc,CAAC,mBAAmB,CAAC,cAAc;KAClE,CAAC;AACJ,CAAC;AAED;GACG;AACH,MAAM,qBAAsB,SAAQ,KAAK,CAAC,SAA4B;IAAtE;;QAeU,cAAS,GAAG,CAAC,KAAa,EAAE,EAAE;YACpC,QAAQ,CAAC,eAAe,CAAC,SAAS,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;YAC3D,QAAQ,CAAC,eAAe,CAAC,YAAY,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;YAC3D,MAAM,CAAC,UAAU,CACf,GAAG,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC,SAAS,CAAC,MAAM,CAAC,kBAAkB,CAAC,EACnE,IAAI,CACL,CAAC;QACJ,CAAC,CAAC;QAEM,sBAAiB,GAAG,CAAC,OAAe,EAAE,EAAE;YAC9C,MAAM,oBAAoB,GACxB,QAAQ,CAAC,eAAe,CAAC,KAAK,CAAC,gBAAgB,CAAC,uBAAuB,CAAC,CAAC;YAC3E,IAAI,oBAAoB,KAAK,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC;gBAChD,UAAU,CAAC,GAAG,EAAE,CACd,QAAQ,CAAC,eAAe,CAAC,KAAK,CAAC,WAAW,CACxC,uBAAuB,EACvB,OAAO,CAAC,QAAQ,EAAE,CACnB,CACF,CAAC;YACJ,CAAC;QACH,CAAC,CAAC;QAEM,uBAAkB,GAAG,CAAC,OAAe,EAAE,EAAE;YAC/C,MAAM,qBAAqB,GACzB,QAAQ,CAAC,eAAe,CAAC,KAAK,CAAC,gBAAgB,CAAC,wBAAwB,CAAC,CAAC;YAC5E,IAAI,qBAAqB,KAAK,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC;gBACjD,UAAU,CAAC,GAAG,EAAE;oBACd,QAAQ,CAAC,eAAe,CAAC,KAAK,CAAC,WAAW,CACxC,wBAAwB,EACxB,OAAO,CAAC,QAAQ,EAAE,CACnB,CAAC;gBACJ,CAAC,CAAC,CAAC;YACL,CAAC;QACH,CAAC,CAAC;IAwBJ,CAAC;IAvEiB,iBAAiB;QAC/B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACjC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QACjD,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;IACrD,CAAC;IAEe,kBAAkB,CAAC,SAA4B;QAC7D,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,KAAK,SAAS,CAAC,KAAK;YAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC3E,IAAI,IAAI,CAAC,KAAK,CAAC,aAAa,KAAK,SAAS,CAAC,aAAa;YACtD,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QACnD,IAAI,IAAI,CAAC,KAAK,CAAC,cAAc,KAAK,SAAS,CAAC,cAAc;YACxD,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;IACvD,CAAC;IAqCe,MAAM;QACpB,MAAM,KAAK,GAAG,wBAAwB,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACzD,MAAM,YAAY,GAAG,uBAAuB,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAExE,OAAO,CACL,oBAAC,aAAa,IACZ,SAAS,EAAC,WAAW,EACrB,KAAK,EAAE,KAAK,IAAI,SAAS,EACzB,YAAY,EAAE,EAAE,YAAY,EAAE,yBACV,eAAe,EACnC,UAAU,EAAE,IAAI;YAEhB,oBAAC,eAAe,CAAC,iFAAiF,IAChG,KAAK,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,EACzB,KAAK,EAAE,KAAK,IAAI,SAAS,EACzB,YAAY,EAAE,EAAE,YAAY,EAAE,IAE7B,IAAI,CAAC,KAAK,CAAC,QAAQ,CACJ,CACJ,CACjB,CAAC;IACJ,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC,qBAAqB,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module State\n */\n\nimport \"./ThemeManager.scss\";\nimport * as React from \"react\";\nimport { connect } from \"react-redux\";\nimport type { ThemeType } from \"@itwin/itwinui-react\";\nimport { ThemeProvider } from \"@itwin/itwinui-react\";\nimport { ThemeProvider as ThemeProviderV2 } from \"@itwin/itwinui-react-v2\";\nimport type { FrameworkState } from \"../redux/FrameworkState\";\nimport { UiFramework } from \"../UiFramework\";\n\n/** System preferred color theme.\n * @public\n */\nexport const SYSTEM_PREFERRED_COLOR_THEME = \"SYSTEM_PREFERRED\";\n\n/** Enum for the Color Theme string.\n * @public\n */\nexport enum ColorTheme {\n  /** Will use iTwinUI `light` theme. */\n  Light = \"light\",\n  /** Will use iTwinUI `dark` theme. */\n  Dark = \"dark\",\n  /** Will use iTwinUI `os` theme. */\n  System = SYSTEM_PREFERRED_COLOR_THEME,\n  /** Will use iTwinUI wrapping `ThemeProvider` if provided, or default to 'Light' */\n  Inherit = \"inherit\",\n  /** Will use iTwinUI `light` theme with `highContrast` set to `true` */\n  HighContrastLight = \"high-contrast-light\",\n  /** Will use iTwinUI `dark` theme with `highContrast` set to `true` */\n  HighContrastDark = \"high-contrast-dark\",\n}\n\n/**\n * Describe valid themes.\n * See [[ThemeManager]] for more information.\n * @public\n */\nexport type ThemeId = `${ColorTheme}` | (string & {});\n\n/**\n * Map of ColorTheme to ThemeType\n */\nconst colorThemeToThemeTypeMap: { [x: string]: ThemeType } = {\n  [ColorTheme.Light]: \"light\",\n  [ColorTheme.HighContrastLight]: \"light\",\n  [ColorTheme.Dark]: \"dark\",\n  [ColorTheme.HighContrastDark]: \"dark\",\n  [ColorTheme.System]: \"os\",\n  os: \"os\", // handle \"os\" for backwards compatibility\n};\n\n/**\n * List of high contrast color themes\n */\nconst highContrastColorThemes: string[] = [\n  ColorTheme.HighContrastDark,\n  ColorTheme.HighContrastLight,\n];\n\n/** The default widget opacity.\n * @public\n */\nexport const WIDGET_OPACITY_DEFAULT = 0.9;\n\n/** The default widget opacity.\n * @public\n */\nexport const TOOLBAR_OPACITY_DEFAULT = 0.5;\n\n/** Properties of [[ThemeManagerComponent]].\n */\ninterface ThemeManagerProps {\n  /** theme (\"light\", \"dark\", etc.) */\n  theme: ThemeId;\n  /* Widget Opacity */\n  widgetOpacity: number;\n  children?: React.ReactNode;\n  toolbarOpacity: number;\n}\n\nfunction mapStateToProps(state: any) {\n  const frameworkState = state[UiFramework.frameworkStateKey] as FrameworkState; // since app sets up key, don't hard-code name\n  if (!frameworkState) return undefined;\n\n  return {\n    theme: frameworkState.configurableUiState.theme,\n    widgetOpacity: frameworkState.configurableUiState.widgetOpacity,\n    toolbarOpacity: frameworkState.configurableUiState.toolbarOpacity,\n  };\n}\n\n/** ThemeManagerComponent handles setting themes.\n */\nclass ThemeManagerComponent extends React.Component<ThemeManagerProps> {\n  public override componentDidMount() {\n    this._setTheme(this.props.theme);\n    this._setWidgetOpacity(this.props.widgetOpacity);\n    this._setToolbarOpacity(this.props.toolbarOpacity);\n  }\n\n  public override componentDidUpdate(prevProps: ThemeManagerProps) {\n    if (this.props.theme !== prevProps.theme) this._setTheme(this.props.theme);\n    if (this.props.widgetOpacity !== prevProps.widgetOpacity)\n      this._setWidgetOpacity(this.props.widgetOpacity);\n    if (this.props.toolbarOpacity !== prevProps.toolbarOpacity)\n      this._setToolbarOpacity(this.props.toolbarOpacity);\n  }\n\n  private _setTheme = (theme: string) => {\n    document.documentElement.classList.add(\"theme-transition\");\n    document.documentElement.setAttribute(\"data-theme\", theme);\n    window.setTimeout(\n      () => document.documentElement.classList.remove(\"theme-transition\"),\n      1000\n    );\n  };\n\n  private _setWidgetOpacity = (opacity: number) => {\n    const currentWidgetOpacity =\n      document.documentElement.style.getPropertyValue(\"--buic-widget-opacity\");\n    if (currentWidgetOpacity !== opacity.toString()) {\n      setTimeout(() =>\n        document.documentElement.style.setProperty(\n          \"--buic-widget-opacity\",\n          opacity.toString()\n        )\n      );\n    }\n  };\n\n  private _setToolbarOpacity = (opacity: number) => {\n    const currentToolbarOpacity =\n      document.documentElement.style.getPropertyValue(\"--buic-toolbar-opacity\");\n    if (currentToolbarOpacity !== opacity.toString()) {\n      setTimeout(() => {\n        document.documentElement.style.setProperty(\n          \"--buic-toolbar-opacity\",\n          opacity.toString()\n        );\n      });\n    }\n  };\n\n  public override render(): React.ReactNode {\n    const theme = colorThemeToThemeTypeMap[this.props.theme];\n    const highContrast = highContrastColorThemes.includes(this.props.theme);\n\n    return (\n      <ThemeProvider\n        className=\"uifw-root\"\n        theme={theme ?? \"inherit\"}\n        themeOptions={{ highContrast }}\n        data-root-container=\"appui-root-id\"\n        includeCss={true}\n      >\n        <ThemeProviderV2 /* v2 ThemeProvider is required to fix popup styling issues in widget popouts. */\n          style={{ height: \"100%\" }}\n          theme={theme ?? \"inherit\"}\n          themeOptions={{ highContrast }}\n        >\n          {this.props.children}\n        </ThemeProviderV2>\n      </ThemeProvider>\n    );\n  }\n}\n\n/** ThemeManager handles setting color themes and element opacity management. Note that this component will\n * affect the entire application by setting the data-theme attribute to the html element.\n * It also sets an iTwinUI `ThemeProvider` element locally, so all elements\n * within the AppUI tree will have the same theme, and should be using iTwinUI 2.x or later.\n * A `ColorTheme` enum values will configure iTwinUI `ThemeProvider` accordingly.\n * Any other string will only apply the `data-theme` attribute to the `html` element\n * and `ThemeProvider` theme will be set to `inherit`, in this case the application is\n * responsible for setting the theme by overriding iTwinUI css variables.\n *\n * This React component is Redux connected and should wrap [[ConfigurableUiContent]].\n *\n * ```tsx\n * <Provider store={UiFramework.store}>\n *   <ThemeManager>\n *     <ConfigurableUiContent />\n *   </ThemeManager>\n * </Provider>\n * ```\n * @public\n */\nexport const ThemeManager = connect(mapStateToProps)(ThemeManagerComponent);\n"]}
+{"version":3,"file":"ThemeManager.js","sourceRoot":"","sources":["../../../../src/appui-react/theme/ThemeManager.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,qBAAqB,CAAC;AAC7B,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,aAAa,IAAI,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAE3E,OAAO,EAAE,UAAU,EAAE,4BAA4B,EAAE,MAAM,WAAW,CAAC;AACrE,OAAO,EAAE,sBAAsB,EAAE,MAAM,mCAAmC,CAAC;AAG3E,sCAAsC;AACtC,MAAM,wBAAwB,GAA+B;IAC3D,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,OAAO;IAC3B,CAAC,UAAU,CAAC,iBAAiB,CAAC,EAAE,OAAO;IACvC,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,MAAM;IACzB,CAAC,UAAU,CAAC,gBAAgB,CAAC,EAAE,MAAM;IACrC,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,IAAI;IACzB,EAAE,EAAE,IAAI,EAAE,0CAA0C;CACrD,CAAC;AAEF,0CAA0C;AAC1C,MAAM,uBAAuB,GAAa;IACxC,UAAU,CAAC,gBAAgB;IAC3B,UAAU,CAAC,iBAAiB;CAC7B,CAAC;AAQF;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,YAAY,CAAC,EAAE,QAAQ,EAAE,GAAG,KAAK,EAAqB;IACpE,MAAM,UAAU,GAAG,sBAAsB,CAAC,CAAC,KAAK,EAAE,EAAE;QAClD,mDAAmD;QACnD,OAAO,KAAK,EAAE,mBAAmB,CAAC,KAAK,CAAC;IAC1C,CAAC,CAAC,CAAC;IACH,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,IAAI,UAAU,IAAI,4BAA4B,CAAC;IAExE,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,QAAQ,CAAC,eAAe,CAAC,SAAS,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;QAC3D,QAAQ,CAAC,eAAe,CAAC,YAAY,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;QAC3D,UAAU,CACR,GAAG,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC,SAAS,CAAC,MAAM,CAAC,kBAAkB,CAAC,EACnE,IAAI,CACL,CAAC;IACJ,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;IAEZ,MAAM,aAAa,GAAG,wBAAwB,CAAC,KAAK,CAAC,CAAC;IACtD,MAAM,YAAY,GAAG,uBAAuB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAE7D,OAAO,CACL,oBAAC,aAAa,IACZ,SAAS,EAAC,WAAW,EACrB,KAAK,EAAE,aAAa,IAAI,SAAS,EACjC,YAAY,EAAE,EAAE,YAAY,EAAE,yBACV,eAAe,EACnC,UAAU,EAAE,IAAI;QAEhB,oBAAC,eAAe,CAAC,iFAAiF,IAChG,KAAK,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,EACzB,KAAK,EAAE,aAAa,IAAI,SAAS,EACjC,YAAY,EAAE,EAAE,YAAY,EAAE,IAE7B,QAAQ,CACO,CACJ,CACjB,CAAC;AACJ,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module State\n */\n\nimport \"./ThemeManager.scss\";\nimport * as React from \"react\";\nimport type { ThemeType } from \"@itwin/itwinui-react\";\nimport { ThemeProvider } from \"@itwin/itwinui-react\";\nimport { ThemeProvider as ThemeProviderV2 } from \"@itwin/itwinui-react-v2\";\nimport type { ThemeId } from \"./ThemeId\";\nimport { ColorTheme, SYSTEM_PREFERRED_COLOR_THEME } from \"./ThemeId\";\nimport { useReduxFrameworkState } from \"../uistate/useReduxFrameworkState\";\nimport type { ConfigurableUiContent } from \"../configurableui/ConfigurableUiContent\";\n\n/** Map of ColorTheme to ThemeType. */\nconst colorThemeToThemeTypeMap: { [x: string]: ThemeType } = {\n  [ColorTheme.Light]: \"light\",\n  [ColorTheme.HighContrastLight]: \"light\",\n  [ColorTheme.Dark]: \"dark\",\n  [ColorTheme.HighContrastDark]: \"dark\",\n  [ColorTheme.System]: \"os\",\n  os: \"os\", // handle \"os\" for backwards compatibility\n};\n\n/** List of high contrast color themes. */\nconst highContrastColorThemes: string[] = [\n  ColorTheme.HighContrastDark,\n  ColorTheme.HighContrastLight,\n];\n\ninterface ThemeManagerProps {\n  children?: React.ReactNode;\n  /** Uses redux store as a fallback. Defaults to {@link SYSTEM_PREFERRED_COLOR_THEME}. */\n  theme?: ThemeId;\n}\n\n/** ThemeManager handles setting color themes and element opacity management. Note that this component will\n * affect the entire application by setting the data-theme attribute to the html element.\n * It also sets an iTwinUI `ThemeProvider` element locally, so all elements\n * within the AppUI tree will have the same theme, and should be using iTwinUI 2.x or later.\n * A `ColorTheme` enum values will configure iTwinUI `ThemeProvider` accordingly.\n * Any other string will only apply the `data-theme` attribute to the `html` element\n * and `ThemeProvider` theme will be set to `inherit`, in this case the application is\n * responsible for setting the theme by overriding iTwinUI css variables.\n *\n * This React component should wrap {@link ConfigurableUiContent}.\n *\n * ```tsx\n * <ThemeManager>\n *   <ConfigurableUiContent />\n * </ThemeManager>\n * ```\n * @public\n */\nexport function ThemeManager({ children, ...props }: ThemeManagerProps) {\n  const reduxTheme = useReduxFrameworkState((state) => {\n    // eslint-disable-next-line deprecation/deprecation\n    return state?.configurableUiState.theme;\n  });\n  const theme = props.theme ?? reduxTheme ?? SYSTEM_PREFERRED_COLOR_THEME;\n\n  React.useEffect(() => {\n    document.documentElement.classList.add(\"theme-transition\");\n    document.documentElement.setAttribute(\"data-theme\", theme);\n    setTimeout(\n      () => document.documentElement.classList.remove(\"theme-transition\"),\n      1000\n    );\n  }, [theme]);\n\n  const providerTheme = colorThemeToThemeTypeMap[theme];\n  const highContrast = highContrastColorThemes.includes(theme);\n\n  return (\n    <ThemeProvider\n      className=\"uifw-root\"\n      theme={providerTheme ?? \"inherit\"}\n      themeOptions={{ highContrast }}\n      data-root-container=\"appui-root-id\"\n      includeCss={true}\n    >\n      <ThemeProviderV2 /* v2 ThemeProvider is required to fix popup styling issues in widget popouts. */\n        style={{ height: \"100%\" }}\n        theme={providerTheme ?? \"inherit\"}\n        themeOptions={{ highContrast }}\n      >\n        {children}\n      </ThemeProviderV2>\n    </ThemeProvider>\n  );\n}\n"]}

package/lib/esm/appui-react/toolbar/GroupItem.d.ts

@@ -8,6 +8,7 @@ import type { GroupItemProps } from "../shared/GroupItemProps";
 import type { ItemDefBase } from "../shared/ItemDefBase";
 /** An Item that opens a group of items.
  * @public
+ * @deprecated in 4.15.0. Use specific item types instead, i.e. {@link ToolbarGroupItem}.
  */
 export declare class GroupItemDef extends ActionButtonItemDef {
     private static _sId;

package/lib/esm/appui-react/toolbar/GroupItem.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"GroupItem.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/GroupItem.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EACV,sBAAsB,EACtB,kBAAkB,EAClB,YAAY,EACb,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACpE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAQzD;;GAEG;AACH,qBAAa,YAAa,SAAQ,mBAAmB;IACnD,OAAO,CAAC,MAAM,CAAC,IAAI,CAAK;IACxB,OAAc,aAAa,SAAY;IAEhC,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,EAAE,MAAM,CAAC;IACtB,KAAK,EAAE,UAAU,EAAE,CAAC;IACpB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAEpC,gBAAgB;IACT,QAAQ,EAAE,OAAO,CAAS;IAEjC,OAAO,CAAC,SAAS,CAAY;IAC7B,OAAO,CAAC,QAAQ,CAAW;IAC3B,OAAO,CAAC,WAAW,CAAsD;gBAGvE,cAAc,EAAE,cAAc,EAC9B,cAAc,CAAC,EAAE,kBAAkB;IAwBrC,IAAW,EAAE,IAAI,MAAM,CAEtB;IAED,gCAAgC;IAChC,IAAW,UAAU,IAAI,MAAM,CAE9B;IAED;;OAEG;IACI,aAAa,CAAC,CAAC,EAAE,MAAM,GAAG,YAAY,GAAG,sBAAsB;IAI/D,YAAY,CAAC,KAAK,CAAC,EAAE,OAAO,GAAG,IAAI;IAanC,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS;IAIhD,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS;IAI7D,IAAW,SAAS,IAAI,MAAM,CAE7B;IAEe,OAAO,IAAI,IAAI;CAChC"}
+{"version":3,"file":"GroupItem.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/GroupItem.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EACV,sBAAsB,EACtB,kBAAkB,EAClB,YAAY,EACb,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACpE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAOzD;;;GAGG;AACH,qBAAa,YAAa,SAAQ,mBAAmB;IACnD,OAAO,CAAC,MAAM,CAAC,IAAI,CAAK;IACxB,OAAc,aAAa,SAAY;IAEhC,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,EAAE,MAAM,CAAC;IACtB,KAAK,EAAE,UAAU,EAAE,CAAC;IACpB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAEpC,gBAAgB;IACT,QAAQ,EAAE,OAAO,CAAS;IAEjC,OAAO,CAAC,SAAS,CAAY;IAC7B,OAAO,CAAC,QAAQ,CAAW;IAC3B,OAAO,CAAC,WAAW,CAAsD;gBAGvE,cAAc,EAAE,cAAc,EAC9B,cAAc,CAAC,EAAE,kBAAkB;IAwBrC,IAAW,EAAE,IAAI,MAAM,CAEtB;IAED,gCAAgC;IAChC,IAAW,UAAU,IAAI,MAAM,CAE9B;IAED;;OAEG;IACI,aAAa,CAAC,CAAC,EAAE,MAAM,GAAG,YAAY,GAAG,sBAAsB;IAI/D,YAAY,CAAC,KAAK,CAAC,EAAE,OAAO,GAAG,IAAI;IAanC,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS;IAIhD,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS;IAI7D,IAAW,SAAS,IAAI,MAAM,CAE7B;IAEe,OAAO,IAAI,IAAI;CAChC"}

package/lib/esm/appui-react/toolbar/GroupItem.js

@@ -8,11 +8,10 @@
 import { ActionButtonItemDef } from "../shared/ActionButtonItemDef";
 import { ItemList, ItemMap } from "../shared/ItemMap";
 import { PropsHelper } from "../utils/PropsHelper";
-// -----------------------------------------------------------------------------
-// GroupItemDef class
-// -----------------------------------------------------------------------------
+/* eslint-disable deprecation/deprecation */
 /** An Item that opens a group of items.
  * @public
+ * @deprecated in 4.15.0. Use specific item types instead, i.e. {@link ToolbarGroupItem}.
  */
 export class GroupItemDef extends ActionButtonItemDef {
     constructor(groupItemProps, onItemExecuted) {

package/lib/esm/appui-react/toolbar/GroupItem.js.map

@@ -1 +1 @@
-{"version":3,"file":"GroupItem.js","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/GroupItem.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAOH,OAAO,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AAIpE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAEnD,gFAAgF;AAChF,qBAAqB;AACrB,gFAAgF;AAEhF;;GAEG;AACH,MAAM,OAAO,YAAa,SAAQ,mBAAmB;IAgBnD,YACE,cAA8B,EAC9B,cAAmC;QAEnC,KAAK,CAAC,cAAc,EAAE,cAAc,CAAC,CAAC;QAXxC,gBAAgB;QACT,aAAQ,GAAY,KAAK,CAAC;QAIzB,gBAAW,GAAmD,EAAE,CAAC;QAQvE,IAAI,CAAC,OAAO;YACV,cAAc,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;QACrE,IAAI,cAAc,CAAC,OAAO;YAAE,IAAI,CAAC,OAAO,GAAG,cAAc,CAAC,OAAO,CAAC;aAC7D,CAAC;YACJ,YAAY,CAAC,IAAI,EAAE,CAAC;YACpB,IAAI,CAAC,OAAO,GAAG,YAAY,CAAC,aAAa,GAAG,YAAY,CAAC,IAAI,CAAC;QAChE,CAAC;QAED,IAAI,CAAC,aAAa;YAChB,cAAc,CAAC,aAAa,KAAK,SAAS;gBACxC,CAAC,CAAC,cAAc,CAAC,aAAa;gBAC9B,CAAC,CAAC,CAAC,CAAC;QACR,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC,aAAa,CAC1C,cAAc,CAAC,UAAU,EACzB,cAAc,CAAC,aAAa,CAC7B,CAAC;QACF,IAAI,CAAC,KAAK,GAAG,cAAc,CAAC,KAAK,CAAC;QAClC,IAAI,CAAC,mBAAmB,GAAG,cAAc,CAAC,mBAAmB,CAAC;IAChE,CAAC;IAED,IAAW,EAAE;QACX,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,gCAAgC;IAChC,IAAW,UAAU;QACnB,OAAO,WAAW,CAAC,iBAAiB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACI,aAAa,CAAC,CAAiD;QACpE,IAAI,CAAC,WAAW,GAAG,CAAC,CAAC;IACvB,CAAC;IAEM,YAAY,CAAC,KAAe;QACjC,IAAI,IAAI,CAAC,SAAS,IAAI,CAAC,KAAK;YAAE,OAAO;QAErC,IAAI,CAAC,SAAS,GAAG,IAAI,QAAQ,EAAE,CAAC;QAChC,IAAI,CAAC,QAAQ,GAAG,IAAI,OAAO,EAAE,CAAC;QAE9B,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAgB,EAAE,EAAE;YAClC,MAAM,EAAE,GAAW,IAAI,CAAC,EAAE,CAAC;YAC3B,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAC7B,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,WAAW,CAAC,EAAU;QAC3B,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAC/B,CAAC;IAEM,cAAc,CAAC,KAAa;QACjC,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACrC,CAAC;IAED,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC;IACrC,CAAC;IAEe,OAAO,KAAU,CAAC;;AAlFnB,iBAAI,GAAG,CAAC,AAAJ,CAAK;AACV,0BAAa,GAAG,QAAQ,AAAX,CAAY","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Item\n */\n\nimport type {\n  ConditionalStringValue,\n  OnItemExecutedFunc,\n  StringGetter,\n} from \"@itwin/appui-abstract\";\nimport { ActionButtonItemDef } from \"../shared/ActionButtonItemDef\";\nimport type { AnyItemDef } from \"../shared/AnyItemDef\";\nimport type { GroupItemProps } from \"../shared/GroupItemProps\";\nimport type { ItemDefBase } from \"../shared/ItemDefBase\";\nimport { ItemList, ItemMap } from \"../shared/ItemMap\";\nimport { PropsHelper } from \"../utils/PropsHelper\";\n\n// -----------------------------------------------------------------------------\n// GroupItemDef class\n// -----------------------------------------------------------------------------\n\n/** An Item that opens a group of items.\n * @public\n */\nexport class GroupItemDef extends ActionButtonItemDef {\n  private static _sId = 0;\n  public static groupIdPrefix = \"Group-\";\n\n  public groupId: string;\n  public itemsInColumn: number;\n  public items: AnyItemDef[];\n  public defaultActiveItemId?: string;\n\n  /** @internal */\n  public overflow: boolean = false;\n\n  private _itemList!: ItemList;\n  private _itemMap!: ItemMap;\n  private _panelLabel: string | StringGetter | ConditionalStringValue = \"\";\n\n  constructor(\n    groupItemProps: GroupItemProps,\n    onItemExecuted?: OnItemExecutedFunc\n  ) {\n    super(groupItemProps, onItemExecuted);\n\n    this.groupId =\n      groupItemProps.groupId !== undefined ? groupItemProps.groupId : \"\";\n    if (groupItemProps.groupId) this.groupId = groupItemProps.groupId;\n    else {\n      GroupItemDef._sId++;\n      this.groupId = GroupItemDef.groupIdPrefix + GroupItemDef._sId;\n    }\n\n    this.itemsInColumn =\n      groupItemProps.itemsInColumn !== undefined\n        ? groupItemProps.itemsInColumn\n        : 7;\n    this._panelLabel = PropsHelper.getStringSpec(\n      groupItemProps.panelLabel,\n      groupItemProps.panelLabelKey\n    );\n    this.items = groupItemProps.items;\n    this.defaultActiveItemId = groupItemProps.defaultActiveItemId;\n  }\n\n  public get id(): string {\n    return this.groupId;\n  }\n\n  /** Get the panelLabel string */\n  public get panelLabel(): string {\n    return PropsHelper.getStringFromSpec(this._panelLabel);\n  }\n\n  /** Set the panelLabel.\n   * @param v A string or a function to get the string.\n   */\n  public setPanelLabel(v: string | StringGetter | ConditionalStringValue) {\n    this._panelLabel = v;\n  }\n\n  public resolveItems(force?: boolean): void {\n    if (this._itemList && !force) return;\n\n    this._itemList = new ItemList();\n    this._itemMap = new ItemMap();\n\n    this.items.map((item: AnyItemDef) => {\n      const id: string = item.id;\n      this._itemList.addItem(item);\n      this._itemMap.set(id, item);\n    });\n  }\n\n  public getItemById(id: string): ItemDefBase | undefined {\n    return this._itemMap.get(id);\n  }\n\n  public getItemByIndex(index: number): ItemDefBase | undefined {\n    return this._itemList.items[index];\n  }\n\n  public get itemCount(): number {\n    return this._itemList.items.length;\n  }\n\n  public override execute(): void {}\n}\n"]}
+{"version":3,"file":"GroupItem.js","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/GroupItem.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAOH,OAAO,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AAIpE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAGnD,4CAA4C;AAE5C;;;GAGG;AACH,MAAM,OAAO,YAAa,SAAQ,mBAAmB;IAgBnD,YACE,cAA8B,EAC9B,cAAmC;QAEnC,KAAK,CAAC,cAAc,EAAE,cAAc,CAAC,CAAC;QAXxC,gBAAgB;QACT,aAAQ,GAAY,KAAK,CAAC;QAIzB,gBAAW,GAAmD,EAAE,CAAC;QAQvE,IAAI,CAAC,OAAO;YACV,cAAc,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;QACrE,IAAI,cAAc,CAAC,OAAO;YAAE,IAAI,CAAC,OAAO,GAAG,cAAc,CAAC,OAAO,CAAC;aAC7D,CAAC;YACJ,YAAY,CAAC,IAAI,EAAE,CAAC;YACpB,IAAI,CAAC,OAAO,GAAG,YAAY,CAAC,aAAa,GAAG,YAAY,CAAC,IAAI,CAAC;QAChE,CAAC;QAED,IAAI,CAAC,aAAa;YAChB,cAAc,CAAC,aAAa,KAAK,SAAS;gBACxC,CAAC,CAAC,cAAc,CAAC,aAAa;gBAC9B,CAAC,CAAC,CAAC,CAAC;QACR,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC,aAAa,CAC1C,cAAc,CAAC,UAAU,EACzB,cAAc,CAAC,aAAa,CAC7B,CAAC;QACF,IAAI,CAAC,KAAK,GAAG,cAAc,CAAC,KAAK,CAAC;QAClC,IAAI,CAAC,mBAAmB,GAAG,cAAc,CAAC,mBAAmB,CAAC;IAChE,CAAC;IAED,IAAW,EAAE;QACX,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,gCAAgC;IAChC,IAAW,UAAU;QACnB,OAAO,WAAW,CAAC,iBAAiB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACI,aAAa,CAAC,CAAiD;QACpE,IAAI,CAAC,WAAW,GAAG,CAAC,CAAC;IACvB,CAAC;IAEM,YAAY,CAAC,KAAe;QACjC,IAAI,IAAI,CAAC,SAAS,IAAI,CAAC,KAAK;YAAE,OAAO;QAErC,IAAI,CAAC,SAAS,GAAG,IAAI,QAAQ,EAAE,CAAC;QAChC,IAAI,CAAC,QAAQ,GAAG,IAAI,OAAO,EAAE,CAAC;QAE9B,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAgB,EAAE,EAAE;YAClC,MAAM,EAAE,GAAW,IAAI,CAAC,EAAE,CAAC;YAC3B,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAC7B,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,WAAW,CAAC,EAAU;QAC3B,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAC/B,CAAC;IAEM,cAAc,CAAC,KAAa;QACjC,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACrC,CAAC;IAED,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC;IACrC,CAAC;IAEe,OAAO,KAAU,CAAC;;AAlFnB,iBAAI,GAAG,CAAC,AAAJ,CAAK;AACV,0BAAa,GAAG,QAAQ,AAAX,CAAY","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Item\n */\n\nimport type {\n  ConditionalStringValue,\n  OnItemExecutedFunc,\n  StringGetter,\n} from \"@itwin/appui-abstract\";\nimport { ActionButtonItemDef } from \"../shared/ActionButtonItemDef\";\nimport type { AnyItemDef } from \"../shared/AnyItemDef\";\nimport type { GroupItemProps } from \"../shared/GroupItemProps\";\nimport type { ItemDefBase } from \"../shared/ItemDefBase\";\nimport { ItemList, ItemMap } from \"../shared/ItemMap\";\nimport { PropsHelper } from \"../utils/PropsHelper\";\nimport type { ToolbarGroupItem } from \"./ToolbarItem\";\n\n/* eslint-disable deprecation/deprecation */\n\n/** An Item that opens a group of items.\n * @public\n * @deprecated in 4.15.0. Use specific item types instead, i.e. {@link ToolbarGroupItem}.\n */\nexport class GroupItemDef extends ActionButtonItemDef {\n  private static _sId = 0;\n  public static groupIdPrefix = \"Group-\";\n\n  public groupId: string;\n  public itemsInColumn: number;\n  public items: AnyItemDef[];\n  public defaultActiveItemId?: string;\n\n  /** @internal */\n  public overflow: boolean = false;\n\n  private _itemList!: ItemList;\n  private _itemMap!: ItemMap;\n  private _panelLabel: string | StringGetter | ConditionalStringValue = \"\";\n\n  constructor(\n    groupItemProps: GroupItemProps,\n    onItemExecuted?: OnItemExecutedFunc\n  ) {\n    super(groupItemProps, onItemExecuted);\n\n    this.groupId =\n      groupItemProps.groupId !== undefined ? groupItemProps.groupId : \"\";\n    if (groupItemProps.groupId) this.groupId = groupItemProps.groupId;\n    else {\n      GroupItemDef._sId++;\n      this.groupId = GroupItemDef.groupIdPrefix + GroupItemDef._sId;\n    }\n\n    this.itemsInColumn =\n      groupItemProps.itemsInColumn !== undefined\n        ? groupItemProps.itemsInColumn\n        : 7;\n    this._panelLabel = PropsHelper.getStringSpec(\n      groupItemProps.panelLabel,\n      groupItemProps.panelLabelKey\n    );\n    this.items = groupItemProps.items;\n    this.defaultActiveItemId = groupItemProps.defaultActiveItemId;\n  }\n\n  public get id(): string {\n    return this.groupId;\n  }\n\n  /** Get the panelLabel string */\n  public get panelLabel(): string {\n    return PropsHelper.getStringFromSpec(this._panelLabel);\n  }\n\n  /** Set the panelLabel.\n   * @param v A string or a function to get the string.\n   */\n  public setPanelLabel(v: string | StringGetter | ConditionalStringValue) {\n    this._panelLabel = v;\n  }\n\n  public resolveItems(force?: boolean): void {\n    if (this._itemList && !force) return;\n\n    this._itemList = new ItemList();\n    this._itemMap = new ItemMap();\n\n    this.items.map((item: AnyItemDef) => {\n      const id: string = item.id;\n      this._itemList.addItem(item);\n      this._itemMap.set(id, item);\n    });\n  }\n\n  public getItemById(id: string): ItemDefBase | undefined {\n    return this._itemMap.get(id);\n  }\n\n  public getItemByIndex(index: number): ItemDefBase | undefined {\n    return this._itemList.items[index];\n  }\n\n  public get itemCount(): number {\n    return this._itemList.items.length;\n  }\n\n  public override execute(): void {}\n}\n"]}

package/lib/esm/appui-react/toolbar/Toolbar.d.ts

@@ -27,7 +27,7 @@ export interface ToolbarProps extends CommonProps, NoChildrenProps {
     items: ToolbarItem[];
     /** Describes how expanded panels are aligned. Defaults to: [[ToolbarPanelAlignment.Start]] */
     panelAlignment?: ToolbarPanelAlignment;
-    /** Use Drag Interaction to open popups with nest action buttons */
+    /** Use drag interaction to open popups with nested toolbar buttons. */
     useDragInteraction?: boolean;
     /** Determines whether to use mouse proximity to alter the opacity of the toolbar */
     toolbarOpacitySetting?: ToolbarOpacitySetting;

package/lib/esm/appui-react/toolbar/Toolbar.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Toolbar.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/Toolbar.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAChE,OAAO,KAAK,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACtE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AACrE,OAAO,EAEL,SAAS,EACT,qBAAqB,EACtB,MAAM,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAMjD;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,mIAAmI;IACnI,iBAAiB,CAAC,EAAE,SAAS,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,WAAW,EAAE,eAAe;IAChE,2OAA2O;IAC3O,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,gHAAgH;IAChH,cAAc,CAAC,EAAE,OAAO,GAAG,sBAAsB,CAAC;IAClD,uGAAuG;IACvG,KAAK,EAAE,WAAW,EAAE,CAAC;IACrB,8FAA8F;IAC9F,cAAc,CAAC,EAAE,qBAAqB,CAAC;IACvC,mEAAmE;IACnE,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,oFAAoF;IACpF,qBAAqB,CAAC,EAAE,qBAAqB,CAAC;IAC9C,sDAAsD;IACtD,cAAc,CAAC,EAAE,kBAAkB,CAAC;IACpC,2EAA2E;IAC3E,SAAS,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,aAAa,KAAK,IAAI,CAAC;CAC9C;AAED;;GAEG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,YAAY,qBAM1C"}
+{"version":3,"file":"Toolbar.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/Toolbar.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAChE,OAAO,KAAK,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACtE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AACrE,OAAO,EAEL,SAAS,EACT,qBAAqB,EACtB,MAAM,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAMjD;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,mIAAmI;IACnI,iBAAiB,CAAC,EAAE,SAAS,CAAC;CAC/B;AAED;;GAEG;AAEH,MAAM,WAAW,YAAa,SAAQ,WAAW,EAAE,eAAe;IAChE,2OAA2O;IAC3O,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,gHAAgH;IAChH,cAAc,CAAC,EAAE,OAAO,GAAG,sBAAsB,CAAC;IAClD,uGAAuG;IACvG,KAAK,EAAE,WAAW,EAAE,CAAC;IACrB,8FAA8F;IAC9F,cAAc,CAAC,EAAE,qBAAqB,CAAC;IACvC,uEAAuE;IACvE,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,oFAAoF;IACpF,qBAAqB,CAAC,EAAE,qBAAqB,CAAC;IAC9C,sDAAsD;IACtD,cAAc,CAAC,EAAE,kBAAkB,CAAC;IACpC,2EAA2E;IAC3E,SAAS,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,aAAa,KAAK,IAAI,CAAC;CAC9C;AAED;;GAEG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,YAAY,qBAM1C"}

package/lib/esm/appui-react/toolbar/Toolbar.js.map

@@ -1 +1 @@
-{"version":3,"file":"Toolbar.js","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/Toolbar.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAI/B,OAAO,EACL,wBAAwB,IAAI,UAAU,EACtC,SAAS,EACT,qBAAqB,GACtB,MAAM,yBAAyB,CAAC;AAEjC,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AACxE,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAiC9E;;GAEG;AACH,MAAM,UAAU,OAAO,CAAC,KAAmB;IACzC,MAAM,eAAe,GAAG,kBAAkB,EAAE,CAAC;IAC7C,IAAI,eAAe,CAAC,WAAW,EAAE,CAAC;QAChC,OAAO,oBAAC,UAAU,OAAK,KAAK,GAAI,CAAC;IACnC,CAAC;IACD,OAAO,oBAAC,eAAe,OAAK,KAAK,GAAI,CAAC;AACxC,CAAC;AAED,SAAS,UAAU,CAAC,KAAmB;IACrC,MAAM,SAAS,GAAG,WAAW,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IAC/C,MAAM,cAAc,GAAG,gBAAgB,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;IAC9D,OAAO,CACL,oBAAC,gBAAgB,IACf,SAAS,EAAE,SAAS,EACpB,cAAc,EAAE,cAAc,EAC9B,KAAK,EAAE,KAAK,CAAC,KAAK,GAClB,CACH,CAAC;AACJ,CAAC;AAED,SAAS,eAAe,CAAC,KAAmB;IAC1C,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,EAAE,GAAG,KAAK,CAAC;IAClC,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE;QAClC,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC;IACrD,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;IACZ,OAAO,CACL,oBAAC,UAAU,IACT,KAAK,EAAE,QAAQ,EACf,WAAW,EAAE,qBAAqB,CAAC,aAAa,KAC5C,KAAK,GACT,CACH,CAAC;AACJ,CAAC;AAED,SAAS,WAAW,CAAC,SAAoC;IACvD,QAAQ,SAAS,EAAE,CAAC;QAClB,KAAK,SAAS,CAAC,MAAM;YACnB,OAAO,QAAQ,CAAC;QAClB,KAAK,SAAS,CAAC,IAAI;YACjB,OAAO,MAAM,CAAC;QAChB,KAAK,SAAS,CAAC,KAAK;YAClB,OAAO,OAAO,CAAC;QACjB,KAAK,SAAS,CAAC,GAAG;YAChB,OAAO,KAAK,CAAC;IACjB,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,gBAAgB,CAAC,SAAyC;IACjE,QAAQ,SAAS,EAAE,CAAC;QAClB,KAAK,qBAAqB,CAAC,GAAG;YAC5B,OAAO,KAAK,CAAC;QACf,KAAK,qBAAqB,CAAC,KAAK;YAC9B,OAAO,OAAO,CAAC;IACnB,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Toolbar\n */\n\nimport * as React from \"react\";\nimport type { OnItemExecutedFunc } from \"@itwin/appui-abstract\";\nimport type { CommonProps, NoChildrenProps } from \"@itwin/core-react\";\nimport type { ToolbarOpacitySetting } from \"@itwin/components-react\";\nimport {\n  InternalToolbarComponent as CR_Toolbar,\n  Direction,\n  ToolbarPanelAlignment,\n} from \"@itwin/components-react\";\nimport type { ToolbarItem } from \"./ToolbarItem\";\nimport { toUIAToolbarItem } from \"./toUIAToolbarItem\";\nimport { SyncUiEventDispatcher } from \"../syncui/SyncUiEventDispatcher\";\nimport { usePreviewFeatures } from \"../preview/PreviewFeatures\";\nimport { Toolbar as ToolGroupToolbar } from \"../preview/new-toolbars/Toolbar\";\n\n/**\n * Properties of [[Toolbar.enableOverflow]] component.\n * @public\n */\nexport interface OverflowToolbarOptions {\n  /** Describes to which direction the overflow popup panels are expanded if overflow is enabled. Defaults to: [[Direction.Right]] */\n  overflowExpandsTo?: Direction;\n}\n\n/** Properties of [[Toolbar]] component.\n * @public\n */\nexport interface ToolbarProps extends CommonProps, NoChildrenProps {\n  /** Describes to which direction the popup panels are expanded, also defines the orientation of the toolbar (Top/Bottom will create an horizontal toolbar, Left/Right will create a vertical toolbar). Defaults to: [[Direction.Bottom]] */\n  expandsTo?: Direction;\n  /** Describes if items that do not fit available space should move to an expandable panel. Defaults to: false */\n  enableOverflow?: boolean | OverflowToolbarOptions;\n  /** Definitions for items of the toolbar. Items are expected to be already sorted by group and item. */\n  items: ToolbarItem[];\n  /** Describes how expanded panels are aligned. Defaults to: [[ToolbarPanelAlignment.Start]] */\n  panelAlignment?: ToolbarPanelAlignment;\n  /** Use Drag Interaction to open popups with nest action buttons */\n  useDragInteraction?: boolean;\n  /** Determines whether to use mouse proximity to alter the opacity of the toolbar */\n  toolbarOpacitySetting?: ToolbarOpacitySetting;\n  /** Optional function to call on any item execution */\n  onItemExecuted?: OnItemExecutedFunc;\n  /** Optional function to call on any KeyDown events processed by toolbar */\n  onKeyDown?: (e: React.KeyboardEvent) => void;\n}\n\n/** Component that displays toolbar items.\n * @beta\n */\nexport function Toolbar(props: ToolbarProps) {\n  const previewFeatures = usePreviewFeatures();\n  if (previewFeatures.newToolbars) {\n    return <NewToolbar {...props} />;\n  }\n  return <OriginalToolbar {...props} />;\n}\n\nfunction NewToolbar(props: ToolbarProps) {\n  const expandsTo = toDirection(props.expandsTo);\n  const panelAlignment = toPanelAlignment(props.panelAlignment);\n  return (\n    <ToolGroupToolbar\n      expandsTo={expandsTo}\n      panelAlignment={panelAlignment}\n      items={props.items}\n    />\n  );\n}\n\nfunction OriginalToolbar(props: ToolbarProps) {\n  const { items, ...other } = props;\n  const uiaItems = React.useMemo(() => {\n    return items.map((item) => toUIAToolbarItem(item));\n  }, [items]);\n  return (\n    <CR_Toolbar\n      items={uiaItems}\n      syncUiEvent={SyncUiEventDispatcher.onSyncUiEvent}\n      {...other}\n    />\n  );\n}\n\nfunction toDirection(direction: ToolbarProps[\"expandsTo\"]) {\n  switch (direction) {\n    case Direction.Bottom:\n      return \"bottom\";\n    case Direction.Left:\n      return \"left\";\n    case Direction.Right:\n      return \"right\";\n    case Direction.Top:\n      return \"top\";\n  }\n  return undefined;\n}\n\nfunction toPanelAlignment(alignment: ToolbarProps[\"panelAlignment\"]) {\n  switch (alignment) {\n    case ToolbarPanelAlignment.End:\n      return \"end\";\n    case ToolbarPanelAlignment.Start:\n      return \"start\";\n  }\n  return undefined;\n}\n"]}
+{"version":3,"file":"Toolbar.js","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/Toolbar.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAI/B,OAAO,EACL,wBAAwB,IAAI,UAAU,EACtC,SAAS,EACT,qBAAqB,GACtB,MAAM,yBAAyB,CAAC;AAEjC,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AACxE,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAkC9E;;GAEG;AACH,MAAM,UAAU,OAAO,CAAC,KAAmB;IACzC,MAAM,eAAe,GAAG,kBAAkB,EAAE,CAAC;IAC7C,IAAI,eAAe,CAAC,WAAW,EAAE,CAAC;QAChC,OAAO,oBAAC,UAAU,OAAK,KAAK,GAAI,CAAC;IACnC,CAAC;IACD,OAAO,oBAAC,eAAe,OAAK,KAAK,GAAI,CAAC;AACxC,CAAC;AAED,SAAS,UAAU,CAAC,KAAmB;IACrC,MAAM,SAAS,GAAG,WAAW,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IAC/C,MAAM,cAAc,GAAG,gBAAgB,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;IAC9D,OAAO,CACL,oBAAC,gBAAgB,IACf,SAAS,EAAE,SAAS,EACpB,cAAc,EAAE,cAAc,EAC9B,KAAK,EAAE,KAAK,CAAC,KAAK,GAClB,CACH,CAAC;AACJ,CAAC;AAED,SAAS,eAAe,CAAC,KAAmB;IAC1C,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,EAAE,GAAG,KAAK,CAAC;IAClC,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE;QAClC,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC;IACrD,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;IACZ,OAAO,CACL,oBAAC,UAAU,IACT,KAAK,EAAE,QAAQ,EACf,WAAW,EAAE,qBAAqB,CAAC,aAAa,KAC5C,KAAK,GACT,CACH,CAAC;AACJ,CAAC;AAED,SAAS,WAAW,CAAC,SAAoC;IACvD,QAAQ,SAAS,EAAE,CAAC;QAClB,KAAK,SAAS,CAAC,MAAM;YACnB,OAAO,QAAQ,CAAC;QAClB,KAAK,SAAS,CAAC,IAAI;YACjB,OAAO,MAAM,CAAC;QAChB,KAAK,SAAS,CAAC,KAAK;YAClB,OAAO,OAAO,CAAC;QACjB,KAAK,SAAS,CAAC,GAAG;YAChB,OAAO,KAAK,CAAC;IACjB,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,gBAAgB,CAAC,SAAyC;IACjE,QAAQ,SAAS,EAAE,CAAC;QAClB,KAAK,qBAAqB,CAAC,GAAG;YAC5B,OAAO,KAAK,CAAC;QACf,KAAK,qBAAqB,CAAC,KAAK;YAC9B,OAAO,OAAO,CAAC;IACnB,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Toolbar\n */\n\nimport * as React from \"react\";\nimport type { OnItemExecutedFunc } from \"@itwin/appui-abstract\";\nimport type { CommonProps, NoChildrenProps } from \"@itwin/core-react\";\nimport type { ToolbarOpacitySetting } from \"@itwin/components-react\";\nimport {\n  InternalToolbarComponent as CR_Toolbar,\n  Direction,\n  ToolbarPanelAlignment,\n} from \"@itwin/components-react\";\nimport type { ToolbarItem } from \"./ToolbarItem\";\nimport { toUIAToolbarItem } from \"./toUIAToolbarItem\";\nimport { SyncUiEventDispatcher } from \"../syncui/SyncUiEventDispatcher\";\nimport { usePreviewFeatures } from \"../preview/PreviewFeatures\";\nimport { Toolbar as ToolGroupToolbar } from \"../preview/new-toolbars/Toolbar\";\n\n/**\n * Properties of [[Toolbar.enableOverflow]] component.\n * @public\n */\nexport interface OverflowToolbarOptions {\n  /** Describes to which direction the overflow popup panels are expanded if overflow is enabled. Defaults to: [[Direction.Right]] */\n  overflowExpandsTo?: Direction;\n}\n\n/** Properties of [[Toolbar]] component.\n * @public\n */\n// eslint-disable-next-line deprecation/deprecation\nexport interface ToolbarProps extends CommonProps, NoChildrenProps {\n  /** Describes to which direction the popup panels are expanded, also defines the orientation of the toolbar (Top/Bottom will create an horizontal toolbar, Left/Right will create a vertical toolbar). Defaults to: [[Direction.Bottom]] */\n  expandsTo?: Direction;\n  /** Describes if items that do not fit available space should move to an expandable panel. Defaults to: false */\n  enableOverflow?: boolean | OverflowToolbarOptions;\n  /** Definitions for items of the toolbar. Items are expected to be already sorted by group and item. */\n  items: ToolbarItem[];\n  /** Describes how expanded panels are aligned. Defaults to: [[ToolbarPanelAlignment.Start]] */\n  panelAlignment?: ToolbarPanelAlignment;\n  /** Use drag interaction to open popups with nested toolbar buttons. */\n  useDragInteraction?: boolean;\n  /** Determines whether to use mouse proximity to alter the opacity of the toolbar */\n  toolbarOpacitySetting?: ToolbarOpacitySetting;\n  /** Optional function to call on any item execution */\n  onItemExecuted?: OnItemExecutedFunc;\n  /** Optional function to call on any KeyDown events processed by toolbar */\n  onKeyDown?: (e: React.KeyboardEvent) => void;\n}\n\n/** Component that displays toolbar items.\n * @beta\n */\nexport function Toolbar(props: ToolbarProps) {\n  const previewFeatures = usePreviewFeatures();\n  if (previewFeatures.newToolbars) {\n    return <NewToolbar {...props} />;\n  }\n  return <OriginalToolbar {...props} />;\n}\n\nfunction NewToolbar(props: ToolbarProps) {\n  const expandsTo = toDirection(props.expandsTo);\n  const panelAlignment = toPanelAlignment(props.panelAlignment);\n  return (\n    <ToolGroupToolbar\n      expandsTo={expandsTo}\n      panelAlignment={panelAlignment}\n      items={props.items}\n    />\n  );\n}\n\nfunction OriginalToolbar(props: ToolbarProps) {\n  const { items, ...other } = props;\n  const uiaItems = React.useMemo(() => {\n    return items.map((item) => toUIAToolbarItem(item));\n  }, [items]);\n  return (\n    <CR_Toolbar\n      items={uiaItems}\n      syncUiEvent={SyncUiEventDispatcher.onSyncUiEvent}\n      {...other}\n    />\n  );\n}\n\nfunction toDirection(direction: ToolbarProps[\"expandsTo\"]) {\n  switch (direction) {\n    case Direction.Bottom:\n      return \"bottom\";\n    case Direction.Left:\n      return \"left\";\n    case Direction.Right:\n      return \"right\";\n    case Direction.Top:\n      return \"top\";\n  }\n  return undefined;\n}\n\nfunction toPanelAlignment(alignment: ToolbarProps[\"panelAlignment\"]) {\n  switch (alignment) {\n    case ToolbarPanelAlignment.End:\n      return \"end\";\n    case ToolbarPanelAlignment.Start:\n      return \"start\";\n  }\n  return undefined;\n}\n"]}

package/lib/esm/appui-react/toolbar/ToolbarHelper.d.ts

@@ -4,23 +4,38 @@
 import type * as React from "react";
 import type { ActionButton, CommonToolbarItem, CustomButtonDefinition, GroupButton } from "@itwin/appui-abstract";
 import type { AnyItemDef } from "../shared/AnyItemDef";
+import { CommandItemDef } from "../shared/CommandItemDef";
 import { CustomItemDef } from "../shared/CustomItemDef";
+import { ToolItemDef } from "../shared/ToolItemDef";
+import { GroupItemDef } from "./GroupItem";
 import type { ToolbarActionItem, ToolbarCustomItem, ToolbarGroupItem, ToolbarItem } from "./ToolbarItem";
 /** Helper functions for defining a Toolbar items used in `Toolbar`, `ToolbarComposer` and `UiItemsProvider`.
  * @public
+ * @deprecated in 4.15.0. Use {@link ToolbarItemUtilities} instead.
  */
 export declare class ToolbarHelper {
-    /** Construct ToolbarCustomItem definitions given a CustomItemDef. */
+    /** Construct ToolbarCustomItem definitions given a CustomItemDef.
+     * @deprecated in 4.15.0. Use {@link ToolbarItemUtilities.createCustomItem} instead.
+     */
     static createCustomDefinitionToolbarItem(itemPriority: number, itemDef: CustomItemDef, overrides?: Partial<CustomButtonDefinition>): ToolbarCustomItem;
-    /** Construct ToolbarActionItem and ToolbarGroupItem definitions given an array of ItemDefs. */
+    /** Construct ToolbarActionItem and ToolbarGroupItem definitions given an array of ItemDefs.
+     * @deprecated in 4.15.0. Use {@link ToolbarItemUtilities} instead.
+     */
     static constructChildToolbarItems(itemDefs: AnyItemDef[]): Array<ToolbarActionItem | ToolbarGroupItem>;
     private static getStringOrConditionalString;
+    /** @deprecated in 4.15.0. Use {@link @itwin/core-react#IconHelper} instead. */
     static getIconReactNode(item: ActionButton | GroupButton): React.ReactNode;
-    /** Helper method to creates a generic toolbar item entry */
+    /** Helper method to creates a generic toolbar item entry.
+     * @deprecated in 4.15.0. Use {@link ToolbarItemUtilities} instead.
+     */
     static createToolbarItemFromItemDef(itemPriority: number, itemDef: AnyItemDef, overrides?: Partial<CommonToolbarItem>): ToolbarItem;
-    /**
-     * Helper method to creates a generic toolbar item entry list.
+    /** Helper method to creates a generic toolbar item entry list.
+     * @deprecated in 4.15.0. Use {@link ToolbarItemUtilities} instead.
      */
     static createToolbarItemsFromItemDefs(itemDefs: AnyItemDef[], startingItemPriority?: number, overrides?: Partial<CommonToolbarItem>): ToolbarItem[];
 }
+/** @internal */
+export declare function itemDefToToolbarActionItem(itemDef: ToolItemDef | CommandItemDef, overrides?: Partial<ToolbarActionItem>): ToolbarActionItem;
+/** @internal */
+export declare function itemDefToToolbarGroupItem(itemDef: GroupItemDef, overrides?: Partial<ToolbarGroupItem>): ToolbarGroupItem;
 //# sourceMappingURL=ToolbarHelper.d.ts.map

package/lib/esm/appui-react/toolbar/ToolbarHelper.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ToolbarHelper.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/ToolbarHelper.tsx"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,KAAK,KAAK,KAAK,MAAM,OAAO,CAAC;AACpC,OAAO,KAAK,EACV,YAAY,EACZ,iBAAiB,EACjB,sBAAsB,EACtB,WAAW,EAEZ,MAAM,uBAAuB,CAAC;AAG/B,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAEvD,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAGxD,OAAO,KAAK,EACV,iBAAiB,EACjB,iBAAiB,EACjB,gBAAgB,EAChB,WAAW,EACZ,MAAM,eAAe,CAAC;AAkCvB;;GAEG;AACH,qBAAa,aAAa;IACxB,qEAAqE;WACvD,iCAAiC,CAC7C,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,aAAa,EACtB,SAAS,CAAC,EAAE,OAAO,CAAC,sBAAsB,CAAC,GAC1C,iBAAiB;IAIpB,+FAA+F;WACjF,0BAA0B,CACtC,QAAQ,EAAE,UAAU,EAAE,GACrB,KAAK,CAAC,iBAAiB,GAAG,gBAAgB,CAAC;IAI9C,OAAO,CAAC,MAAM,CAAC,4BAA4B;WAY7B,gBAAgB,CAC5B,IAAI,EAAE,YAAY,GAAG,WAAW,GAC/B,KAAK,CAAC,SAAS;IAIlB,4DAA4D;WAC9C,4BAA4B,CACxC,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,UAAU,EACnB,SAAS,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,GACrC,WAAW;IA4Cd;;OAEG;WACW,8BAA8B,CAC1C,QAAQ,EAAE,UAAU,EAAE,EACtB,oBAAoB,SAAK,EACzB,SAAS,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,GACrC,WAAW,EAAE;CAQjB"}
+{"version":3,"file":"ToolbarHelper.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/ToolbarHelper.tsx"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,KAAK,KAAK,KAAK,MAAM,OAAO,CAAC;AACpC,OAAO,KAAK,EACV,YAAY,EACZ,iBAAiB,EACjB,sBAAsB,EACtB,WAAW,EAEZ,MAAM,uBAAuB,CAAC;AAI/B,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,KAAK,EACV,iBAAiB,EACjB,iBAAiB,EACjB,gBAAgB,EAChB,WAAW,EACZ,MAAM,eAAe,CAAC;AAqCvB;;;GAGG;AACH,qBAAa,aAAa;IACxB;;OAEG;WACW,iCAAiC,CAC7C,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,aAAa,EACtB,SAAS,CAAC,EAAE,OAAO,CAAC,sBAAsB,CAAC,GAC1C,iBAAiB;IAIpB;;OAEG;WACW,0BAA0B,CACtC,QAAQ,EAAE,UAAU,EAAE,GACrB,KAAK,CAAC,iBAAiB,GAAG,gBAAgB,CAAC;IAI9C,OAAO,CAAC,MAAM,CAAC,4BAA4B;IAY3C,+EAA+E;WACjE,gBAAgB,CAC5B,IAAI,EAAE,YAAY,GAAG,WAAW,GAC/B,KAAK,CAAC,SAAS;IAKlB;;OAEG;WACW,4BAA4B,CACxC,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,UAAU,EACnB,SAAS,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,GACrC,WAAW;IA4Cd;;OAEG;WACW,8BAA8B,CAC1C,QAAQ,EAAE,UAAU,EAAE,EACtB,oBAAoB,SAAK,EACzB,SAAS,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,GACrC,WAAW,EAAE;CAQjB;AAED,gBAAgB;AAChB,wBAAgB,0BAA0B,CACxC,OAAO,EAAE,WAAW,GAAG,cAAc,EACrC,SAAS,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,GACrC,iBAAiB,CAOnB;AAED,gBAAgB;AAChB,wBAAgB,yBAAyB,CACvC,OAAO,EAAE,YAAY,EACrB,SAAS,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC,GACpC,gBAAgB,CAOlB"}

package/lib/esm/appui-react/toolbar/ToolbarHelper.js

@@ -1,10 +1,12 @@
 import { ConditionalStringValue } from "@itwin/appui-abstract";
+import { assert } from "@itwin/core-bentley";
 import { IconHelper } from "@itwin/core-react";
 import { CommandItemDef } from "../shared/CommandItemDef";
 import { CustomItemDef } from "../shared/CustomItemDef";
 import { ToolItemDef } from "../shared/ToolItemDef";
 import { GroupItemDef } from "./GroupItem";
 import { isToolbarActionItem, isToolbarGroupItem } from "./ToolbarItem";
+/* eslint-disable deprecation/deprecation */
 /**
  * Common implementation for `constructChildToolbarItems` and `createToolbarItemsFromItemDefs`.
  * @param itemDefs List of itemDefs to convert.
@@ -26,13 +28,18 @@ function constructToolbarItemArray(itemDefs, allowCustom, startingItemPriority =
 }
 /** Helper functions for defining a Toolbar items used in `Toolbar`, `ToolbarComposer` and `UiItemsProvider`.
  * @public
+ * @deprecated in 4.15.0. Use {@link ToolbarItemUtilities} instead.
  */
 export class ToolbarHelper {
-    /** Construct ToolbarCustomItem definitions given a CustomItemDef. */
+    /** Construct ToolbarCustomItem definitions given a CustomItemDef.
+     * @deprecated in 4.15.0. Use {@link ToolbarItemUtilities.createCustomItem} instead.
+     */
     static createCustomDefinitionToolbarItem(itemPriority, itemDef, overrides) {
         return this.createToolbarItemFromItemDef(itemPriority, itemDef, overrides);
     }
-    /** Construct ToolbarActionItem and ToolbarGroupItem definitions given an array of ItemDefs. */
+    /** Construct ToolbarActionItem and ToolbarGroupItem definitions given an array of ItemDefs.
+     * @deprecated in 4.15.0. Use {@link ToolbarItemUtilities} instead.
+     */
     static constructChildToolbarItems(itemDefs) {
         return constructToolbarItemArray(itemDefs, false);
     }
@@ -42,10 +49,14 @@ export class ToolbarHelper {
             return inString;
         return inString();
     }
+    /** @deprecated in 4.15.0. Use {@link @itwin/core-react#IconHelper} instead. */
     static getIconReactNode(item) {
+        // eslint-disable-next-line deprecation/deprecation
         return IconHelper.getIconReactNode(item.icon, item.internalData);
     }
-    /** Helper method to creates a generic toolbar item entry */
+    /** Helper method to creates a generic toolbar item entry.
+     * @deprecated in 4.15.0. Use {@link ToolbarItemUtilities} instead.
+     */
     static createToolbarItemFromItemDef(itemPriority, itemDef, overrides) {
         const { badgeType, description, icon, internalData, ...itemOverrides } = overrides ?? {};
         const itemBase = {
@@ -54,8 +65,8 @@ export class ToolbarHelper {
             isActive: itemDef.isActive,
             isHidden: itemDef.isHidden,
             isDisabled: itemDef.isDisabled,
-            icon: internalData?.get(IconHelper.reactIconKey) ??
-                internalData?.get(IconHelper.conditionalIconItemKey) ??
+            icon: internalData?.get(IconHelper.reactIconKey) ?? // eslint-disable-line deprecation/deprecation
+                internalData?.get(IconHelper.conditionalIconItemKey) ?? // eslint-disable-line deprecation/deprecation
                 icon ??
                 itemDef.iconSpec,
             label: this.getStringOrConditionalString(itemDef.rawLabel),
@@ -89,11 +100,29 @@ export class ToolbarHelper {
             throw new Error(`Invalid Item type encountered, item id=${itemDef.id}`);
         }
     }
-    /**
-     * Helper method to creates a generic toolbar item entry list.
+    /** Helper method to creates a generic toolbar item entry list.
+     * @deprecated in 4.15.0. Use {@link ToolbarItemUtilities} instead.
      */
     static createToolbarItemsFromItemDefs(itemDefs, startingItemPriority = 10, overrides) {
         return constructToolbarItemArray(itemDefs, true, startingItemPriority, overrides);
     }
 }
+/** @internal */
+export function itemDefToToolbarActionItem(itemDef, overrides) {
+    const item = ToolbarHelper.createToolbarItemFromItemDef(0, itemDef);
+    assert(isToolbarActionItem(item));
+    return {
+        ...item,
+        ...overrides,
+    };
+}
+/** @internal */
+export function itemDefToToolbarGroupItem(itemDef, overrides) {
+    const item = ToolbarHelper.createToolbarItemFromItemDef(0, itemDef);
+    assert(isToolbarGroupItem(item));
+    return {
+        ...item,
+        ...overrides,
+    };
+}
 //# sourceMappingURL=ToolbarHelper.js.map

package/lib/esm/appui-react/toolbar/ToolbarHelper.js.map

@@ -1 +1 @@
-{"version":3,"file":"ToolbarHelper.js","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/ToolbarHelper.tsx"],"names":[],"mappings":"AAeA,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAC/D,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAE/C,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAO3C,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAExE;;;;;;;GAOG;AACH,SAAS,yBAAyB,CAChC,QAAsB,EACtB,WAAc,EACd,oBAAoB,GAAG,EAAE,EACzB,SAAsC;IAEtC,IAAI,QAAQ,GAAG,oBAAoB,CAAC;IACpC,MAAM,KAAK,GAAG,EAAE,CAAC;IACjB,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,MAAM,IAAI,GAAG,aAAa,CAAC,4BAA4B,CACrD,QAAQ,EACR,OAAO,EACP,SAAS,CACV,CAAC;QACF,QAAQ,GAAG,QAAQ,GAAG,EAAE,CAAC;QACzB,IAAI,WAAW,IAAI,mBAAmB,CAAC,IAAI,CAAC,IAAI,kBAAkB,CAAC,IAAI,CAAC;YACtE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACrB,CAAC;IACD,OAAO,KAEwC,CAAC;AAClD,CAAC;AAED;;GAEG;AACH,MAAM,OAAO,aAAa;IACxB,qEAAqE;IAC9D,MAAM,CAAC,iCAAiC,CAC7C,YAAoB,EACpB,OAAsB,EACtB,SAA2C;QAE3C,OAAO,IAAI,CAAC,4BAA4B,CAAC,YAAY,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC;IAC7E,CAAC;IAED,+FAA+F;IACxF,MAAM,CAAC,0BAA0B,CACtC,QAAsB;QAEtB,OAAO,yBAAyB,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IACpD,CAAC;IAEO,MAAM,CAAC,4BAA4B,CACzC,QAAwD;QAExD,IACE,QAAQ,YAAY,sBAAsB;YAC1C,OAAO,QAAQ,KAAK,QAAQ;YAE5B,OAAO,QAAQ,CAAC;QAElB,OAAO,QAAQ,EAAE,CAAC;IACpB,CAAC;IAEM,MAAM,CAAC,gBAAgB,CAC5B,IAAgC;QAEhC,OAAO,UAAU,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IACnE,CAAC;IAED,4DAA4D;IACrD,MAAM,CAAC,4BAA4B,CACxC,YAAoB,EACpB,OAAmB,EACnB,SAAsC;QAEtC,MAAM,EAAE,SAAS,EAAE,WAAW,EAAE,IAAI,EAAE,YAAY,EAAE,GAAG,aAAa,EAAE,GACpE,SAAS,IAAI,EAAE,CAAC;QAClB,MAAM,QAAQ,GAAgB;YAC5B,EAAE,EAAE,OAAO,CAAC,EAAE;YACd,YAAY;YACZ,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,IAAI,EACF,YAAY,EAAE,GAAG,CAAC,UAAU,CAAC,YAAY,CAAC;gBAC1C,YAAY,EAAE,GAAG,CAAC,UAAU,CAAC,sBAAsB,CAAC;gBACpD,IAAI;gBACJ,OAAO,CAAC,QAAQ;YAClB,KAAK,EAAE,IAAI,CAAC,4BAA4B,CAAC,OAAO,CAAC,QAAQ,CAAC;YAC1D,KAAK,EAAE,SAAS,IAAI,OAAO,CAAC,SAAS;YACrC,WAAW,EAAE,WAAW,IAAI,OAAO,CAAC,WAAW;SAChD,CAAC;QAEF,IAAI,OAAO,YAAY,cAAc,IAAI,OAAO,YAAY,WAAW,EAAE,CAAC;YACxE,OAAO;gBACL,GAAG,QAAQ;gBACX,OAAO,EAAE,OAAO,CAAC,OAAO;gBACxB,GAAG,aAAa;aACjB,CAAC;QACJ,CAAC;aAAM,IAAI,OAAO,YAAY,aAAa,EAAE,CAAC;YAC5C,OAAO;gBACL,GAAG,QAAQ;gBACX,YAAY,EAAE,OAAO,CAAC,cAAc;gBACpC,GAAG,aAAa;aACjB,CAAC;QACJ,CAAC;aAAM,IAAI,OAAO,YAAY,YAAY,EAAE,CAAC;YAC3C,OAAO;gBACL,GAAG,QAAQ;gBACX,UAAU,EAAE,OAAO,CAAC,UAAU;gBAC9B,KAAK,EAAE,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC,KAAK,CAAC;gBACrD,QAAQ,EAAE,KAAK;gBACf,GAAG,aAAa;aACjB,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,0CAA0C,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC;QAC1E,CAAC;IACH,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,8BAA8B,CAC1C,QAAsB,EACtB,oBAAoB,GAAG,EAAE,EACzB,SAAsC;QAEtC,OAAO,yBAAyB,CAC9B,QAAQ,EACR,IAAI,EACJ,oBAAoB,EACpB,SAAS,CACV,CAAC;IACJ,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Toolbar\n */\nimport type * as React from \"react\";\nimport type {\n  ActionButton,\n  CommonToolbarItem,\n  CustomButtonDefinition,\n  GroupButton,\n  StringGetter,\n} from \"@itwin/appui-abstract\";\nimport { ConditionalStringValue } from \"@itwin/appui-abstract\";\nimport { IconHelper } from \"@itwin/core-react\";\nimport type { AnyItemDef } from \"../shared/AnyItemDef\";\nimport { CommandItemDef } from \"../shared/CommandItemDef\";\nimport { CustomItemDef } from \"../shared/CustomItemDef\";\nimport { ToolItemDef } from \"../shared/ToolItemDef\";\nimport { GroupItemDef } from \"./GroupItem\";\nimport type {\n  ToolbarActionItem,\n  ToolbarCustomItem,\n  ToolbarGroupItem,\n  ToolbarItem,\n} from \"./ToolbarItem\";\nimport { isToolbarActionItem, isToolbarGroupItem } from \"./ToolbarItem\";\n\n/**\n * Common implementation for `constructChildToolbarItems` and `createToolbarItemsFromItemDefs`.\n * @param itemDefs List of itemDefs to convert.\n * @param allowCustom false if we are building children and don't support custom items.\n * @param startingItemPriority defaults to 10.\n * @param overrides Single override to apply to each itemDefs.\n * @returns ToolbarItem[] or (ToolbarActionItem | ToolbarGroupItem) if allowCustom is false.\n */\nfunction constructToolbarItemArray<T extends boolean>(\n  itemDefs: AnyItemDef[],\n  allowCustom: T,\n  startingItemPriority = 10,\n  overrides?: Partial<CommonToolbarItem>\n) {\n  let priority = startingItemPriority;\n  const items = [];\n  for (const itemDef of itemDefs) {\n    const item = ToolbarHelper.createToolbarItemFromItemDef(\n      priority,\n      itemDef,\n      overrides\n    );\n    priority = priority + 10;\n    if (allowCustom || isToolbarActionItem(item) || isToolbarGroupItem(item))\n      items.push(item);\n  }\n  return items as T extends true\n    ? Array<ToolbarItem>\n    : Array<ToolbarActionItem | ToolbarGroupItem>;\n}\n\n/** Helper functions for defining a Toolbar items used in `Toolbar`, `ToolbarComposer` and `UiItemsProvider`.\n * @public\n */\nexport class ToolbarHelper {\n  /** Construct ToolbarCustomItem definitions given a CustomItemDef. */\n  public static createCustomDefinitionToolbarItem(\n    itemPriority: number,\n    itemDef: CustomItemDef,\n    overrides?: Partial<CustomButtonDefinition>\n  ): ToolbarCustomItem {\n    return this.createToolbarItemFromItemDef(itemPriority, itemDef, overrides);\n  }\n\n  /** Construct ToolbarActionItem and ToolbarGroupItem definitions given an array of ItemDefs. */\n  public static constructChildToolbarItems(\n    itemDefs: AnyItemDef[]\n  ): Array<ToolbarActionItem | ToolbarGroupItem> {\n    return constructToolbarItemArray(itemDefs, false);\n  }\n\n  private static getStringOrConditionalString(\n    inString: string | StringGetter | ConditionalStringValue\n  ): string | ConditionalStringValue {\n    if (\n      inString instanceof ConditionalStringValue ||\n      typeof inString === \"string\"\n    )\n      return inString;\n\n    return inString();\n  }\n\n  public static getIconReactNode(\n    item: ActionButton | GroupButton\n  ): React.ReactNode {\n    return IconHelper.getIconReactNode(item.icon, item.internalData);\n  }\n\n  /** Helper method to creates a generic toolbar item entry */\n  public static createToolbarItemFromItemDef(\n    itemPriority: number,\n    itemDef: AnyItemDef,\n    overrides?: Partial<CommonToolbarItem>\n  ): ToolbarItem {\n    const { badgeType, description, icon, internalData, ...itemOverrides } =\n      overrides ?? {};\n    const itemBase: ToolbarItem = {\n      id: itemDef.id,\n      itemPriority,\n      isActive: itemDef.isActive,\n      isHidden: itemDef.isHidden,\n      isDisabled: itemDef.isDisabled,\n      icon:\n        internalData?.get(IconHelper.reactIconKey) ??\n        internalData?.get(IconHelper.conditionalIconItemKey) ??\n        icon ??\n        itemDef.iconSpec,\n      label: this.getStringOrConditionalString(itemDef.rawLabel),\n      badge: badgeType ?? itemDef.badgeType,\n      description: description ?? itemDef.description,\n    };\n\n    if (itemDef instanceof CommandItemDef || itemDef instanceof ToolItemDef) {\n      return {\n        ...itemBase,\n        execute: itemDef.execute,\n        ...itemOverrides,\n      };\n    } else if (itemDef instanceof CustomItemDef) {\n      return {\n        ...itemBase,\n        panelContent: itemDef.popupPanelNode,\n        ...itemOverrides,\n      };\n    } else if (itemDef instanceof GroupItemDef) {\n      return {\n        ...itemBase,\n        panelLabel: itemDef.panelLabel,\n        items: this.constructChildToolbarItems(itemDef.items),\n        isActive: false,\n        ...itemOverrides,\n      };\n    } else {\n      throw new Error(`Invalid Item type encountered, item id=${itemDef.id}`);\n    }\n  }\n\n  /**\n   * Helper method to creates a generic toolbar item entry list.\n   */\n  public static createToolbarItemsFromItemDefs(\n    itemDefs: AnyItemDef[],\n    startingItemPriority = 10,\n    overrides?: Partial<CommonToolbarItem>\n  ): ToolbarItem[] {\n    return constructToolbarItemArray(\n      itemDefs,\n      true,\n      startingItemPriority,\n      overrides\n    );\n  }\n}\n"]}
+{"version":3,"file":"ToolbarHelper.js","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/ToolbarHelper.tsx"],"names":[],"mappings":"AAeA,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAC/D,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAE/C,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAO3C,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAGxE,4CAA4C;AAE5C;;;;;;;GAOG;AACH,SAAS,yBAAyB,CAChC,QAAsB,EACtB,WAAc,EACd,oBAAoB,GAAG,EAAE,EACzB,SAAsC;IAEtC,IAAI,QAAQ,GAAG,oBAAoB,CAAC;IACpC,MAAM,KAAK,GAAG,EAAE,CAAC;IACjB,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,MAAM,IAAI,GAAG,aAAa,CAAC,4BAA4B,CACrD,QAAQ,EACR,OAAO,EACP,SAAS,CACV,CAAC;QACF,QAAQ,GAAG,QAAQ,GAAG,EAAE,CAAC;QACzB,IAAI,WAAW,IAAI,mBAAmB,CAAC,IAAI,CAAC,IAAI,kBAAkB,CAAC,IAAI,CAAC;YACtE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACrB,CAAC;IACD,OAAO,KAEwC,CAAC;AAClD,CAAC;AAED;;;GAGG;AACH,MAAM,OAAO,aAAa;IACxB;;OAEG;IACI,MAAM,CAAC,iCAAiC,CAC7C,YAAoB,EACpB,OAAsB,EACtB,SAA2C;QAE3C,OAAO,IAAI,CAAC,4BAA4B,CAAC,YAAY,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC;IAC7E,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,0BAA0B,CACtC,QAAsB;QAEtB,OAAO,yBAAyB,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IACpD,CAAC;IAEO,MAAM,CAAC,4BAA4B,CACzC,QAAwD;QAExD,IACE,QAAQ,YAAY,sBAAsB;YAC1C,OAAO,QAAQ,KAAK,QAAQ;YAE5B,OAAO,QAAQ,CAAC;QAElB,OAAO,QAAQ,EAAE,CAAC;IACpB,CAAC;IAED,+EAA+E;IACxE,MAAM,CAAC,gBAAgB,CAC5B,IAAgC;QAEhC,mDAAmD;QACnD,OAAO,UAAU,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IACnE,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,4BAA4B,CACxC,YAAoB,EACpB,OAAmB,EACnB,SAAsC;QAEtC,MAAM,EAAE,SAAS,EAAE,WAAW,EAAE,IAAI,EAAE,YAAY,EAAE,GAAG,aAAa,EAAE,GACpE,SAAS,IAAI,EAAE,CAAC;QAClB,MAAM,QAAQ,GAAgB;YAC5B,EAAE,EAAE,OAAO,CAAC,EAAE;YACd,YAAY;YACZ,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,IAAI,EACF,YAAY,EAAE,GAAG,CAAC,UAAU,CAAC,YAAY,CAAC,IAAI,8CAA8C;gBAC5F,YAAY,EAAE,GAAG,CAAC,UAAU,CAAC,sBAAsB,CAAC,IAAI,8CAA8C;gBACtG,IAAI;gBACJ,OAAO,CAAC,QAAQ;YAClB,KAAK,EAAE,IAAI,CAAC,4BAA4B,CAAC,OAAO,CAAC,QAAQ,CAAC;YAC1D,KAAK,EAAE,SAAS,IAAI,OAAO,CAAC,SAAS;YACrC,WAAW,EAAE,WAAW,IAAI,OAAO,CAAC,WAAW;SAChD,CAAC;QAEF,IAAI,OAAO,YAAY,cAAc,IAAI,OAAO,YAAY,WAAW,EAAE,CAAC;YACxE,OAAO;gBACL,GAAG,QAAQ;gBACX,OAAO,EAAE,OAAO,CAAC,OAAO;gBACxB,GAAG,aAAa;aACjB,CAAC;QACJ,CAAC;aAAM,IAAI,OAAO,YAAY,aAAa,EAAE,CAAC;YAC5C,OAAO;gBACL,GAAG,QAAQ;gBACX,YAAY,EAAE,OAAO,CAAC,cAAc;gBACpC,GAAG,aAAa;aACjB,CAAC;QACJ,CAAC;aAAM,IAAI,OAAO,YAAY,YAAY,EAAE,CAAC;YAC3C,OAAO;gBACL,GAAG,QAAQ;gBACX,UAAU,EAAE,OAAO,CAAC,UAAU;gBAC9B,KAAK,EAAE,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC,KAAK,CAAC;gBACrD,QAAQ,EAAE,KAAK;gBACf,GAAG,aAAa;aACjB,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,0CAA0C,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC;QAC1E,CAAC;IACH,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,8BAA8B,CAC1C,QAAsB,EACtB,oBAAoB,GAAG,EAAE,EACzB,SAAsC;QAEtC,OAAO,yBAAyB,CAC9B,QAAQ,EACR,IAAI,EACJ,oBAAoB,EACpB,SAAS,CACV,CAAC;IACJ,CAAC;CACF;AAED,gBAAgB;AAChB,MAAM,UAAU,0BAA0B,CACxC,OAAqC,EACrC,SAAsC;IAEtC,MAAM,IAAI,GAAG,aAAa,CAAC,4BAA4B,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IACpE,MAAM,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC;IAClC,OAAO;QACL,GAAG,IAAI;QACP,GAAG,SAAS;KACb,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,UAAU,yBAAyB,CACvC,OAAqB,EACrB,SAAqC;IAErC,MAAM,IAAI,GAAG,aAAa,CAAC,4BAA4B,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IACpE,MAAM,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC;IACjC,OAAO;QACL,GAAG,IAAI;QACP,GAAG,SAAS;KACb,CAAC;AACJ,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Toolbar\n */\nimport type * as React from \"react\";\nimport type {\n  ActionButton,\n  CommonToolbarItem,\n  CustomButtonDefinition,\n  GroupButton,\n  StringGetter,\n} from \"@itwin/appui-abstract\";\nimport { ConditionalStringValue } from \"@itwin/appui-abstract\";\nimport { assert } from \"@itwin/core-bentley\";\nimport { IconHelper } from \"@itwin/core-react\";\nimport type { AnyItemDef } from \"../shared/AnyItemDef\";\nimport { CommandItemDef } from \"../shared/CommandItemDef\";\nimport { CustomItemDef } from \"../shared/CustomItemDef\";\nimport { ToolItemDef } from \"../shared/ToolItemDef\";\nimport { GroupItemDef } from \"./GroupItem\";\nimport type {\n  ToolbarActionItem,\n  ToolbarCustomItem,\n  ToolbarGroupItem,\n  ToolbarItem,\n} from \"./ToolbarItem\";\nimport { isToolbarActionItem, isToolbarGroupItem } from \"./ToolbarItem\";\nimport type { ToolbarItemUtilities } from \"./ToolbarItemUtilities\";\n\n/* eslint-disable deprecation/deprecation */\n\n/**\n * Common implementation for `constructChildToolbarItems` and `createToolbarItemsFromItemDefs`.\n * @param itemDefs List of itemDefs to convert.\n * @param allowCustom false if we are building children and don't support custom items.\n * @param startingItemPriority defaults to 10.\n * @param overrides Single override to apply to each itemDefs.\n * @returns ToolbarItem[] or (ToolbarActionItem | ToolbarGroupItem) if allowCustom is false.\n */\nfunction constructToolbarItemArray<T extends boolean>(\n  itemDefs: AnyItemDef[],\n  allowCustom: T,\n  startingItemPriority = 10,\n  overrides?: Partial<CommonToolbarItem>\n) {\n  let priority = startingItemPriority;\n  const items = [];\n  for (const itemDef of itemDefs) {\n    const item = ToolbarHelper.createToolbarItemFromItemDef(\n      priority,\n      itemDef,\n      overrides\n    );\n    priority = priority + 10;\n    if (allowCustom || isToolbarActionItem(item) || isToolbarGroupItem(item))\n      items.push(item);\n  }\n  return items as T extends true\n    ? Array<ToolbarItem>\n    : Array<ToolbarActionItem | ToolbarGroupItem>;\n}\n\n/** Helper functions for defining a Toolbar items used in `Toolbar`, `ToolbarComposer` and `UiItemsProvider`.\n * @public\n * @deprecated in 4.15.0. Use {@link ToolbarItemUtilities} instead.\n */\nexport class ToolbarHelper {\n  /** Construct ToolbarCustomItem definitions given a CustomItemDef.\n   * @deprecated in 4.15.0. Use {@link ToolbarItemUtilities.createCustomItem} instead.\n   */\n  public static createCustomDefinitionToolbarItem(\n    itemPriority: number,\n    itemDef: CustomItemDef,\n    overrides?: Partial<CustomButtonDefinition>\n  ): ToolbarCustomItem {\n    return this.createToolbarItemFromItemDef(itemPriority, itemDef, overrides);\n  }\n\n  /** Construct ToolbarActionItem and ToolbarGroupItem definitions given an array of ItemDefs.\n   * @deprecated in 4.15.0. Use {@link ToolbarItemUtilities} instead.\n   */\n  public static constructChildToolbarItems(\n    itemDefs: AnyItemDef[]\n  ): Array<ToolbarActionItem | ToolbarGroupItem> {\n    return constructToolbarItemArray(itemDefs, false);\n  }\n\n  private static getStringOrConditionalString(\n    inString: string | StringGetter | ConditionalStringValue\n  ): string | ConditionalStringValue {\n    if (\n      inString instanceof ConditionalStringValue ||\n      typeof inString === \"string\"\n    )\n      return inString;\n\n    return inString();\n  }\n\n  /** @deprecated in 4.15.0. Use {@link @itwin/core-react#IconHelper} instead. */\n  public static getIconReactNode(\n    item: ActionButton | GroupButton\n  ): React.ReactNode {\n    // eslint-disable-next-line deprecation/deprecation\n    return IconHelper.getIconReactNode(item.icon, item.internalData);\n  }\n\n  /** Helper method to creates a generic toolbar item entry.\n   * @deprecated in 4.15.0. Use {@link ToolbarItemUtilities} instead.\n   */\n  public static createToolbarItemFromItemDef(\n    itemPriority: number,\n    itemDef: AnyItemDef,\n    overrides?: Partial<CommonToolbarItem>\n  ): ToolbarItem {\n    const { badgeType, description, icon, internalData, ...itemOverrides } =\n      overrides ?? {};\n    const itemBase: ToolbarItem = {\n      id: itemDef.id,\n      itemPriority,\n      isActive: itemDef.isActive,\n      isHidden: itemDef.isHidden,\n      isDisabled: itemDef.isDisabled,\n      icon:\n        internalData?.get(IconHelper.reactIconKey) ?? // eslint-disable-line deprecation/deprecation\n        internalData?.get(IconHelper.conditionalIconItemKey) ?? // eslint-disable-line deprecation/deprecation\n        icon ??\n        itemDef.iconSpec,\n      label: this.getStringOrConditionalString(itemDef.rawLabel),\n      badge: badgeType ?? itemDef.badgeType,\n      description: description ?? itemDef.description,\n    };\n\n    if (itemDef instanceof CommandItemDef || itemDef instanceof ToolItemDef) {\n      return {\n        ...itemBase,\n        execute: itemDef.execute,\n        ...itemOverrides,\n      };\n    } else if (itemDef instanceof CustomItemDef) {\n      return {\n        ...itemBase,\n        panelContent: itemDef.popupPanelNode,\n        ...itemOverrides,\n      };\n    } else if (itemDef instanceof GroupItemDef) {\n      return {\n        ...itemBase,\n        panelLabel: itemDef.panelLabel,\n        items: this.constructChildToolbarItems(itemDef.items),\n        isActive: false,\n        ...itemOverrides,\n      };\n    } else {\n      throw new Error(`Invalid Item type encountered, item id=${itemDef.id}`);\n    }\n  }\n\n  /** Helper method to creates a generic toolbar item entry list.\n   * @deprecated in 4.15.0. Use {@link ToolbarItemUtilities} instead.\n   */\n  public static createToolbarItemsFromItemDefs(\n    itemDefs: AnyItemDef[],\n    startingItemPriority = 10,\n    overrides?: Partial<CommonToolbarItem>\n  ): ToolbarItem[] {\n    return constructToolbarItemArray(\n      itemDefs,\n      true,\n      startingItemPriority,\n      overrides\n    );\n  }\n}\n\n/** @internal */\nexport function itemDefToToolbarActionItem(\n  itemDef: ToolItemDef | CommandItemDef,\n  overrides?: Partial<ToolbarActionItem>\n): ToolbarActionItem {\n  const item = ToolbarHelper.createToolbarItemFromItemDef(0, itemDef);\n  assert(isToolbarActionItem(item));\n  return {\n    ...item,\n    ...overrides,\n  };\n}\n\n/** @internal */\nexport function itemDefToToolbarGroupItem(\n  itemDef: GroupItemDef,\n  overrides?: Partial<ToolbarGroupItem>\n): ToolbarGroupItem {\n  const item = ToolbarHelper.createToolbarItemFromItemDef(0, itemDef);\n  assert(isToolbarGroupItem(item));\n  return {\n    ...item,\n    ...overrides,\n  };\n}\n"]}

package/lib/esm/appui-react/toolbar/ToolbarItem.d.ts

@@ -46,8 +46,7 @@ export interface CommonToolbarItem {
     /** Priority within a toolbar or group. */
     readonly itemPriority: number;
     /** Describes layout specific configuration of a toolbar item.
-     * @note Only used by `get*` methods of [[UiItemsProvider]].
-     * @alpha
+     * @note Only used by {@link UiItemsProvider.getToolbarItems}.
      */
     readonly layouts?: ToolbarItemLayouts;
 }
@@ -107,14 +106,14 @@ export declare function isToolbarGroupItem(item: ToolbarItem): item is ToolbarGr
  */
 export declare function isToolbarCustomItem(item: ToolbarItem): item is ToolbarCustomItem;
 /** Describes toolbar item configuration specific for each layout.
- * @alpha
+ * @public
  */
 export interface ToolbarItemLayouts {
     /** Toolbar item configuration in a standard layout. */
     readonly standard?: StandardLayoutToolbarItem;
 }
 /** Describes toolbar item configuration specific to a standard layout.
- * @alpha
+ * @public
  */
 export interface StandardLayoutToolbarItem {
     /** Describes toolbar usage. */

package/lib/esm/appui-react/toolbar/ToolbarItem.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ToolbarItem.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/ToolbarItem.ts"],"names":[],"mappings":"AAIA;;GAEG;;AAEH,OAAO,KAAK,EACV,uBAAuB,EACvB,sBAAsB,EACvB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE7D;;GAEG;AACH,oBAAY,YAAY;IACtB,yGAAyG;IACzG,mBAAmB,IAAI;IACvB,8EAA8E;IAC9E,cAAc,IAAI;CACnB;AAED;;GAEG;AACH,oBAAY,kBAAkB;IAC5B,0BAA0B;IAC1B,UAAU,IAAI;IACd,wBAAwB;IACxB,QAAQ,IAAI;CACb;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,iIAAiI;IACjI,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,0DAA0D;IAC1D,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC;IAC3B,2BAA2B;IAC3B,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACvD,uEAAuE;IACvE,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAC5B,6FAA6F;IAC7F,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,GAAG,uBAAuB,CAAC;IACtD,+FAA+F;IAC/F,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,GAAG,uBAAuB,CAAC;IACxD;;;OAGG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,0CAA0C;IAC1C,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B;;;OAGG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,kBAAkB,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,iBAAiB;IAC1D,sHAAsH;IACtH,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IACxB,wEAAwE;IACxE,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAChD,kDAAkD;IAClD,QAAQ,CAAC,OAAO,EAAE,MAAM,IAAI,CAAC;IAC7B,qDAAqD;IACrD,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,iBAAiB;IACzD,qHAAqH;IACrH,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IACxB,yFAAyF;IACzF,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAChD,yDAAyD;IACzD,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACtD,4BAA4B;IAC5B,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC,iBAAiB,GAAG,gBAAgB,CAAC,CAAC;IACpE,qDAAqD;IACrD,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,iBAAiB;IAC1D,qHAAqH;IACrH,QAAQ,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC;IACzB,yFAAyF;IACzF,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACjD,oDAAoD;IACpD,QAAQ,CAAC,YAAY,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GACnB,iBAAiB,GACjB,gBAAgB,GAChB,iBAAiB,CAAC;AAEtB;;GAEG;AACH,wBAAgB,mBAAmB,CACjC,IAAI,EAAE,WAAW,GAChB,IAAI,IAAI,iBAAiB,CAE3B;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,WAAW,GAChB,IAAI,IAAI,gBAAgB,CAE1B;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CACjC,IAAI,EAAE,WAAW,GAChB,IAAI,IAAI,iBAAiB,CAE3B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,uDAAuD;IACvD,QAAQ,CAAC,QAAQ,CAAC,EAAE,yBAAyB,CAAC;CAC/C;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,+BAA+B;IAC/B,QAAQ,CAAC,KAAK,EAAE,YAAY,CAAC;IAC7B,qCAAqC;IACrC,QAAQ,CAAC,WAAW,EAAE,kBAAkB,CAAC;CAC1C"}
+{"version":3,"file":"ToolbarItem.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/ToolbarItem.ts"],"names":[],"mappings":"AAIA;;GAEG;;AAEH,OAAO,KAAK,EACV,uBAAuB,EACvB,sBAAsB,EACvB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAG7D;;GAEG;AACH,oBAAY,YAAY;IACtB,yGAAyG;IACzG,mBAAmB,IAAI;IACvB,8EAA8E;IAC9E,cAAc,IAAI;CACnB;AAED;;GAEG;AACH,oBAAY,kBAAkB;IAC5B,0BAA0B;IAC1B,UAAU,IAAI;IACd,wBAAwB;IACxB,QAAQ,IAAI;CACb;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,iIAAiI;IACjI,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,0DAA0D;IAC1D,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC;IAC3B,2BAA2B;IAC3B,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACvD,uEAAuE;IACvE,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAC5B,6FAA6F;IAC7F,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,GAAG,uBAAuB,CAAC;IACtD,+FAA+F;IAC/F,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,GAAG,uBAAuB,CAAC;IACxD;;;OAGG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,0CAA0C;IAC1C,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,kBAAkB,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,iBAAiB;IAC1D,sHAAsH;IACtH,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IACxB,wEAAwE;IACxE,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAChD,kDAAkD;IAClD,QAAQ,CAAC,OAAO,EAAE,MAAM,IAAI,CAAC;IAC7B,qDAAqD;IACrD,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,iBAAiB;IACzD,qHAAqH;IACrH,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IACxB,yFAAyF;IACzF,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAChD,yDAAyD;IACzD,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACtD,4BAA4B;IAC5B,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC,iBAAiB,GAAG,gBAAgB,CAAC,CAAC;IACpE,qDAAqD;IACrD,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,iBAAiB;IAC1D,qHAAqH;IACrH,QAAQ,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC;IACzB,yFAAyF;IACzF,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACjD,oDAAoD;IACpD,QAAQ,CAAC,YAAY,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GACnB,iBAAiB,GACjB,gBAAgB,GAChB,iBAAiB,CAAC;AAEtB;;GAEG;AACH,wBAAgB,mBAAmB,CACjC,IAAI,EAAE,WAAW,GAChB,IAAI,IAAI,iBAAiB,CAE3B;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,WAAW,GAChB,IAAI,IAAI,gBAAgB,CAE1B;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CACjC,IAAI,EAAE,WAAW,GAChB,IAAI,IAAI,iBAAiB,CAE3B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,uDAAuD;IACvD,QAAQ,CAAC,QAAQ,CAAC,EAAE,yBAAyB,CAAC;CAC/C;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,+BAA+B;IAC/B,QAAQ,CAAC,KAAK,EAAE,YAAY,CAAC;IAC7B,qCAAqC;IACrC,QAAQ,CAAC,WAAW,EAAE,kBAAkB,CAAC;CAC1C"}

package/lib/esm/appui-react/toolbar/ToolbarItem.js.map

@@ -1 +1 @@
-{"version":3,"file":"ToolbarItem.js","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/ToolbarItem.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAQH;;GAEG;AACH,MAAM,CAAN,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,yGAAyG;IACzG,6EAAuB,CAAA;IACvB,8EAA8E;IAC9E,mEAAkB,CAAA;AACpB,CAAC,EALW,YAAY,KAAZ,YAAY,QAKvB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,0BAA0B;IAC1B,uEAAc,CAAA;IACd,wBAAwB;IACxB,mEAAY,CAAA;AACd,CAAC,EALW,kBAAkB,KAAlB,kBAAkB,QAK7B;AAkFD;;GAEG;AACH,MAAM,UAAU,mBAAmB,CACjC,IAAiB;IAEjB,OAAO,SAAS,IAAI,IAAI,CAAC;AAC3B,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAChC,IAAiB;IAEjB,OAAO,OAAO,IAAI,IAAI,CAAC;AACzB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,mBAAmB,CACjC,IAAiB;IAEjB,OAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;AACjE,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Toolbar\n */\n\nimport type {\n  ConditionalBooleanValue,\n  ConditionalStringValue,\n} from \"@itwin/appui-abstract\";\nimport type { BadgeType, IconSpec } from \"@itwin/core-react\";\n\n/** Used to specify the usage of the toolbar which determine the toolbar position.\n * @public\n */\nexport enum ToolbarUsage {\n  /** Contains tools to Create Update and Delete content - in AppUI this is in top left of content area. */\n  ContentManipulation = 0,\n  /** Manipulate view/camera - in AppUI this is in top right of content area. */\n  ViewNavigation = 1,\n}\n\n/** Used to specify the orientation of the toolbar.\n * @public\n */\nexport enum ToolbarOrientation {\n  /** Horizontal toolbar. */\n  Horizontal = 0,\n  /** Vertical toolbar. */\n  Vertical = 1,\n}\n\n/** Describes the data needed to insert a UI items into an existing set of UI items.\n * @public\n */\nexport interface CommonToolbarItem {\n  /** Require uniqueId for the item. To ensure uniqueness it is suggested that a namespace prefix of the extension name be used. */\n  readonly id: string;\n  /** Describes badge. Renders no badge if not specified. */\n  readonly badge?: BadgeType;\n  /** Optional description */\n  readonly description?: string | ConditionalStringValue;\n  /** Defines if the item is active (shown with an active stripe/bar). */\n  readonly isActive?: boolean;\n  /** Describes if the item is visible or hidden. The default is for the item to be visible. */\n  readonly isHidden?: boolean | ConditionalBooleanValue;\n  /** Describes if the item is enabled or disabled. The default is for the item to be enabled. */\n  readonly isDisabled?: boolean | ConditionalBooleanValue;\n  /** Specifies the item's grouping value. Items are sorted by group and then item priority. When\n   * group priority changes a separator is inserted. It is recommended using values 10 through 100, incrementing by 10. This\n   * allows extensions enough gaps to insert their own groups. If the value is not specified a groupPriority of 0 is used.\n   */\n  readonly groupPriority?: number;\n  /** Priority within a toolbar or group. */\n  readonly itemPriority: number;\n  /** Describes layout specific configuration of a toolbar item.\n   * @note Only used by `get*` methods of [[UiItemsProvider]].\n   * @alpha\n   */\n  readonly layouts?: ToolbarItemLayouts;\n}\n\n/** Describes the data needed to insert an action button into a toolbar.\n * @public\n */\nexport interface ToolbarActionItem extends CommonToolbarItem {\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix  to imported symbol Id. */\n  readonly icon: IconSpec;\n  /** label, shown as tool tip on a button or an item label in a group. */\n  readonly label: string | ConditionalStringValue;\n  /** function to run when the button is pressed. */\n  readonly execute: () => void;\n  /** Optional parent tool group to add the tool to. */\n  readonly parentGroupItemId?: string;\n}\n\n/** Describes the data needed to insert a group button into a toolbar.\n * @public\n */\nexport interface ToolbarGroupItem extends CommonToolbarItem {\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix to imported symbol Id. */\n  readonly icon: IconSpec;\n  /** label, shown as tool tip on group button or a group button label in a group panel. */\n  readonly label: string | ConditionalStringValue;\n  /** label shown as the title in at top of group panel. */\n  readonly panelLabel?: string | ConditionalStringValue;\n  /** children of the group */\n  readonly items: ReadonlyArray<ToolbarActionItem | ToolbarGroupItem>;\n  /** Optional parent tool group to add the tool to. */\n  readonly parentGroupItemId?: string;\n}\n\n/** Describes the data needed to insert a custom button into a toolbar.\n * @public\n */\nexport interface ToolbarCustomItem extends CommonToolbarItem {\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix to imported symbol Id. */\n  readonly icon?: IconSpec;\n  /** label, shown as tool tip on group button or a group button label in a group panel. */\n  readonly label?: string | ConditionalStringValue;\n  /** defines the content to display in popup panel */\n  readonly panelContent?: React.ReactNode;\n}\n\n/** Any Button Type that can be inserted into a toolbar.\n * @public\n */\nexport type ToolbarItem =\n  | ToolbarActionItem\n  | ToolbarGroupItem\n  | ToolbarCustomItem;\n\n/** ToolbarActionItem type guard.\n * @public\n */\nexport function isToolbarActionItem(\n  item: ToolbarItem\n): item is ToolbarActionItem {\n  return \"execute\" in item;\n}\n\n/** ToolbarGroupItem type guard.\n * @public\n */\nexport function isToolbarGroupItem(\n  item: ToolbarItem\n): item is ToolbarGroupItem {\n  return \"items\" in item;\n}\n\n/** ToolbarCustomItem type guard.\n * @public\n */\nexport function isToolbarCustomItem(\n  item: ToolbarItem\n): item is ToolbarCustomItem {\n  return !isToolbarActionItem(item) && !isToolbarGroupItem(item);\n}\n\n/** Describes toolbar item configuration specific for each layout.\n * @alpha\n */\nexport interface ToolbarItemLayouts {\n  /** Toolbar item configuration in a standard layout. */\n  readonly standard?: StandardLayoutToolbarItem;\n}\n\n/** Describes toolbar item configuration specific to a standard layout.\n * @alpha\n */\nexport interface StandardLayoutToolbarItem {\n  /** Describes toolbar usage. */\n  readonly usage: ToolbarUsage;\n  /** Describes toolbar orientation. */\n  readonly orientation: ToolbarOrientation;\n}\n"]}
+{"version":3,"file":"ToolbarItem.js","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/ToolbarItem.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AASH;;GAEG;AACH,MAAM,CAAN,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,yGAAyG;IACzG,6EAAuB,CAAA;IACvB,8EAA8E;IAC9E,mEAAkB,CAAA;AACpB,CAAC,EALW,YAAY,KAAZ,YAAY,QAKvB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,0BAA0B;IAC1B,uEAAc,CAAA;IACd,wBAAwB;IACxB,mEAAY,CAAA;AACd,CAAC,EALW,kBAAkB,KAAlB,kBAAkB,QAK7B;AAiFD;;GAEG;AACH,MAAM,UAAU,mBAAmB,CACjC,IAAiB;IAEjB,OAAO,SAAS,IAAI,IAAI,CAAC;AAC3B,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAChC,IAAiB;IAEjB,OAAO,OAAO,IAAI,IAAI,CAAC;AACzB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,mBAAmB,CACjC,IAAiB;IAEjB,OAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;AACjE,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Toolbar\n */\n\nimport type {\n  ConditionalBooleanValue,\n  ConditionalStringValue,\n} from \"@itwin/appui-abstract\";\nimport type { BadgeType, IconSpec } from \"@itwin/core-react\";\nimport { UiItemsProvider } from \"../ui-items-provider/UiItemsProvider\";\n\n/** Used to specify the usage of the toolbar which determine the toolbar position.\n * @public\n */\nexport enum ToolbarUsage {\n  /** Contains tools to Create Update and Delete content - in AppUI this is in top left of content area. */\n  ContentManipulation = 0,\n  /** Manipulate view/camera - in AppUI this is in top right of content area. */\n  ViewNavigation = 1,\n}\n\n/** Used to specify the orientation of the toolbar.\n * @public\n */\nexport enum ToolbarOrientation {\n  /** Horizontal toolbar. */\n  Horizontal = 0,\n  /** Vertical toolbar. */\n  Vertical = 1,\n}\n\n/** Describes the data needed to insert a UI items into an existing set of UI items.\n * @public\n */\nexport interface CommonToolbarItem {\n  /** Require uniqueId for the item. To ensure uniqueness it is suggested that a namespace prefix of the extension name be used. */\n  readonly id: string;\n  /** Describes badge. Renders no badge if not specified. */\n  readonly badge?: BadgeType;\n  /** Optional description */\n  readonly description?: string | ConditionalStringValue;\n  /** Defines if the item is active (shown with an active stripe/bar). */\n  readonly isActive?: boolean;\n  /** Describes if the item is visible or hidden. The default is for the item to be visible. */\n  readonly isHidden?: boolean | ConditionalBooleanValue;\n  /** Describes if the item is enabled or disabled. The default is for the item to be enabled. */\n  readonly isDisabled?: boolean | ConditionalBooleanValue;\n  /** Specifies the item's grouping value. Items are sorted by group and then item priority. When\n   * group priority changes a separator is inserted. It is recommended using values 10 through 100, incrementing by 10. This\n   * allows extensions enough gaps to insert their own groups. If the value is not specified a groupPriority of 0 is used.\n   */\n  readonly groupPriority?: number;\n  /** Priority within a toolbar or group. */\n  readonly itemPriority: number;\n  /** Describes layout specific configuration of a toolbar item.\n   * @note Only used by {@link UiItemsProvider.getToolbarItems}.\n   */\n  readonly layouts?: ToolbarItemLayouts;\n}\n\n/** Describes the data needed to insert an action button into a toolbar.\n * @public\n */\nexport interface ToolbarActionItem extends CommonToolbarItem {\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix  to imported symbol Id. */\n  readonly icon: IconSpec;\n  /** label, shown as tool tip on a button or an item label in a group. */\n  readonly label: string | ConditionalStringValue;\n  /** function to run when the button is pressed. */\n  readonly execute: () => void;\n  /** Optional parent tool group to add the tool to. */\n  readonly parentGroupItemId?: string;\n}\n\n/** Describes the data needed to insert a group button into a toolbar.\n * @public\n */\nexport interface ToolbarGroupItem extends CommonToolbarItem {\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix to imported symbol Id. */\n  readonly icon: IconSpec;\n  /** label, shown as tool tip on group button or a group button label in a group panel. */\n  readonly label: string | ConditionalStringValue;\n  /** label shown as the title in at top of group panel. */\n  readonly panelLabel?: string | ConditionalStringValue;\n  /** children of the group */\n  readonly items: ReadonlyArray<ToolbarActionItem | ToolbarGroupItem>;\n  /** Optional parent tool group to add the tool to. */\n  readonly parentGroupItemId?: string;\n}\n\n/** Describes the data needed to insert a custom button into a toolbar.\n * @public\n */\nexport interface ToolbarCustomItem extends CommonToolbarItem {\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix to imported symbol Id. */\n  readonly icon?: IconSpec;\n  /** label, shown as tool tip on group button or a group button label in a group panel. */\n  readonly label?: string | ConditionalStringValue;\n  /** defines the content to display in popup panel */\n  readonly panelContent?: React.ReactNode;\n}\n\n/** Any Button Type that can be inserted into a toolbar.\n * @public\n */\nexport type ToolbarItem =\n  | ToolbarActionItem\n  | ToolbarGroupItem\n  | ToolbarCustomItem;\n\n/** ToolbarActionItem type guard.\n * @public\n */\nexport function isToolbarActionItem(\n  item: ToolbarItem\n): item is ToolbarActionItem {\n  return \"execute\" in item;\n}\n\n/** ToolbarGroupItem type guard.\n * @public\n */\nexport function isToolbarGroupItem(\n  item: ToolbarItem\n): item is ToolbarGroupItem {\n  return \"items\" in item;\n}\n\n/** ToolbarCustomItem type guard.\n * @public\n */\nexport function isToolbarCustomItem(\n  item: ToolbarItem\n): item is ToolbarCustomItem {\n  return !isToolbarActionItem(item) && !isToolbarGroupItem(item);\n}\n\n/** Describes toolbar item configuration specific for each layout.\n * @public\n */\nexport interface ToolbarItemLayouts {\n  /** Toolbar item configuration in a standard layout. */\n  readonly standard?: StandardLayoutToolbarItem;\n}\n\n/** Describes toolbar item configuration specific to a standard layout.\n * @public\n */\nexport interface StandardLayoutToolbarItem {\n  /** Describes toolbar usage. */\n  readonly usage: ToolbarUsage;\n  /** Describes toolbar orientation. */\n  readonly orientation: ToolbarOrientation;\n}\n"]}

package/lib/esm/appui-react/toolbar/ToolbarItemUtilities.d.ts

@@ -1,8 +1,9 @@
 /** @packageDocumentation
  * @module Toolbar
  */
+import { type ToolType } from "@itwin/core-frontend";
 import type { ToolbarActionItem, ToolbarCustomItem, ToolbarGroupItem } from "./ToolbarItem";
-/** Helper class to create toolbar items.
+/** Helper namespace to create toolbar items.
  * @beta
  */
 export declare namespace ToolbarItemUtilities {
@@ -12,5 +13,7 @@ export declare namespace ToolbarItemUtilities {
     function createGroupItem(id: string, itemPriority: number, icon: ToolbarGroupItem["icon"], label: ToolbarGroupItem["label"], items: ToolbarGroupItem["items"], overrides?: Partial<ToolbarGroupItem>): ToolbarGroupItem;
     /** Creates a custom item. */
     function createCustomItem(id: string, itemPriority: number, icon: ToolbarCustomItem["icon"], label: ToolbarCustomItem["label"], panelContent?: ToolbarCustomItem["panelContent"], overrides?: Partial<ToolbarCustomItem>): ToolbarCustomItem;
+    /** Creates an action item from the specified tool type. */
+    function createForTool(toolType: ToolType, overrides?: Partial<ToolbarActionItem>): ToolbarActionItem;
 }
 //# sourceMappingURL=ToolbarItemUtilities.d.ts.map