@itwin/components-react 4.0.0-dev.12 → 4.0.0-dev.14

package/lib/esm/components-react/UiComponents.d.ts

@@ -1,36 +1,36 @@
-/** @packageDocumentation
- * @module Common
- */
-import { Localization } from "@itwin/core-common";
-/**
- * Manages the localization service for the components-react package.
- * @public
- */
-export declare class UiComponents {
-    private static _initialized;
-    private static _localization?;
-    /**
-     * Registers the localization service namespace for UiComponents. Also initializes UiCore.
-     * @param localization The internationalization service created by the host application.
-     */
-    static initialize(localization: Localization): Promise<void>;
-    /** Unregisters the UiComponents localization namespace */
-    static terminate(): void;
-    /** Determines if UiComponents has been initialized */
-    static get initialized(): boolean;
-    /** The internationalization service created by the host application.
-     * @internal
-     */
-    static get localization(): Localization;
-    /** The internationalization service namespace. */
-    static get localizationNamespace(): string;
-    /** @internal */
-    static get packageName(): string;
-    /** Calls localization.getLocalizedStringWithNamespace with the "UiComponents" namespace. Do NOT include the namespace in the key.
-     * @internal
-     */
-    static translate(key: string | string[]): string;
-    /** @internal */
-    static loggerCategory(obj: any): string;
-}
+/** @packageDocumentation
+ * @module Common
+ */
+import { Localization } from "@itwin/core-common";
+/**
+ * Manages the localization service for the components-react package.
+ * @public
+ */
+export declare class UiComponents {
+    private static _initialized;
+    private static _localization?;
+    /**
+     * Registers the localization service namespace for UiComponents. Also initializes UiCore.
+     * @param localization The internationalization service created by the host application.
+     */
+    static initialize(localization: Localization): Promise<void>;
+    /** Unregisters the UiComponents localization namespace */
+    static terminate(): void;
+    /** Determines if UiComponents has been initialized */
+    static get initialized(): boolean;
+    /** The internationalization service created by the host application.
+     * @internal
+     */
+    static get localization(): Localization;
+    /** The internationalization service namespace. */
+    static get localizationNamespace(): string;
+    /** @internal */
+    static get packageName(): string;
+    /** Calls localization.getLocalizedStringWithNamespace with the "UiComponents" namespace. Do NOT include the namespace in the key.
+     * @internal
+     */
+    static translate(key: string | string[]): string;
+    /** @internal */
+    static loggerCategory(obj: any): string;
+}
 //# sourceMappingURL=UiComponents.d.ts.map

package/lib/esm/components-react/UiComponents.js

@@ -1,76 +1,77 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Common
- */
-import { enablePatches } from "immer";
-import { Logger } from "@itwin/core-bentley";
-import { getClassName, UiError } from "@itwin/appui-abstract";
-import { UiCore } from "@itwin/core-react";
-/**
- * Manages the localization service for the components-react package.
- * @public
- */
-export class UiComponents {
-    /**
-     * Registers the localization service namespace for UiComponents. Also initializes UiCore.
-     * @param localization The internationalization service created by the host application.
-     */
-    static async initialize(localization) {
-        if (UiComponents._initialized) {
-            Logger.logInfo(UiComponents.loggerCategory(UiComponents), `UiComponents.initialize already called`);
-            return;
-        }
-        enablePatches();
-        UiComponents._localization = localization;
-        await UiComponents._localization.registerNamespace(UiComponents.localizationNamespace);
-        await UiCore.initialize(UiComponents._localization);
-        UiComponents._initialized = true;
-    }
-    /** Unregisters the UiComponents localization namespace */
-    static terminate() {
-        if (UiComponents._localization)
-            UiComponents._localization.unregisterNamespace(UiComponents.localizationNamespace);
-        UiComponents._localization = undefined;
-        UiCore.terminate();
-        UiComponents._initialized = false;
-    }
-    /** Determines if UiComponents has been initialized */
-    static get initialized() { return UiComponents._initialized; }
-    /** The internationalization service created by the host application.
-     * @internal
-     */
-    static get localization() {
-        if (!UiComponents._localization)
-            throw new UiError(UiComponents.loggerCategory(this), "_localization: UiComponents.initialize has not been called. Unable to return Localization object.");
-        return UiComponents._localization;
-    }
-    /** The internationalization service namespace. */
-    static get localizationNamespace() {
-        return "UiComponents";
-    }
-    /** @internal */
-    static get packageName() {
-        return "components-react";
-    }
-    /** Calls localization.getLocalizedStringWithNamespace with the "UiComponents" namespace. Do NOT include the namespace in the key.
-     * @internal
-     */
-    static translate(key) {
-        if (!UiComponents.initialized) {
-            Logger.logError(UiComponents.loggerCategory(this), `translate: UiComponents.initialize has not been called. Returning blank string.`);
-            return "";
-        }
-        return UiComponents.localization.getLocalizedString(key, { ns: UiComponents.localizationNamespace });
-    }
-    /** @internal */
-    static loggerCategory(obj) {
-        const className = getClassName(obj);
-        const category = UiComponents.packageName + (className ? `.${className}` : "");
-        return category;
-    }
-}
-UiComponents._initialized = false;
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Common
+ */
+import { enablePatches } from "immer";
+import { Logger } from "@itwin/core-bentley";
+import { getClassName, UiError } from "@itwin/appui-abstract";
+import { UiCore } from "@itwin/core-react";
+/**
+ * Manages the localization service for the components-react package.
+ * @public
+ */
+class UiComponents {
+    /**
+     * Registers the localization service namespace for UiComponents. Also initializes UiCore.
+     * @param localization The internationalization service created by the host application.
+     */
+    static async initialize(localization) {
+        if (UiComponents._initialized) {
+            Logger.logInfo(UiComponents.loggerCategory(UiComponents), `UiComponents.initialize already called`);
+            return;
+        }
+        enablePatches();
+        UiComponents._localization = localization;
+        await UiComponents._localization.registerNamespace(UiComponents.localizationNamespace);
+        await UiCore.initialize(UiComponents._localization);
+        UiComponents._initialized = true;
+    }
+    /** Unregisters the UiComponents localization namespace */
+    static terminate() {
+        if (UiComponents._localization)
+            UiComponents._localization.unregisterNamespace(UiComponents.localizationNamespace);
+        UiComponents._localization = undefined;
+        UiCore.terminate();
+        UiComponents._initialized = false;
+    }
+    /** Determines if UiComponents has been initialized */
+    static get initialized() { return UiComponents._initialized; }
+    /** The internationalization service created by the host application.
+     * @internal
+     */
+    static get localization() {
+        if (!UiComponents._localization)
+            throw new UiError(UiComponents.loggerCategory(this), "_localization: UiComponents.initialize has not been called. Unable to return Localization object.");
+        return UiComponents._localization;
+    }
+    /** The internationalization service namespace. */
+    static get localizationNamespace() {
+        return "UiComponents";
+    }
+    /** @internal */
+    static get packageName() {
+        return "components-react";
+    }
+    /** Calls localization.getLocalizedStringWithNamespace with the "UiComponents" namespace. Do NOT include the namespace in the key.
+     * @internal
+     */
+    static translate(key) {
+        if (!UiComponents.initialized) {
+            Logger.logError(UiComponents.loggerCategory(this), `translate: UiComponents.initialize has not been called. Returning blank string.`);
+            return "";
+        }
+        return UiComponents.localization.getLocalizedString(key, { ns: UiComponents.localizationNamespace });
+    }
+    /** @internal */
+    static loggerCategory(obj) {
+        const className = getClassName(obj);
+        const category = UiComponents.packageName + (className ? `.${className}` : "");
+        return category;
+    }
+}
+UiComponents._initialized = false;
+export { UiComponents };
 //# sourceMappingURL=UiComponents.js.map

package/lib/esm/components-react/UiComponents.js.map

@@ -1 +1 @@
-{"version":3,"file":"UiComponents.js","sourceRoot":"","sources":["../../../src/components-react/UiComponents.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAE7C,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAE3C;;;GAGG;AACH,MAAM,OAAO,YAAY;IAIvB;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,YAA0B;QACvD,IAAI,YAAY,CAAC,YAAY,EAAE;YAC7B,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,YAAY,CAAC,EAAE,wCAAwC,CAAC,CAAC;YACpG,OAAO;SACR;QAED,aAAa,EAAE,CAAC;QAChB,YAAY,CAAC,aAAa,GAAG,YAAY,CAAC;QAC1C,MAAM,YAAY,CAAC,aAAa,CAAC,iBAAiB,CAAC,YAAY,CAAC,qBAAqB,CAAC,CAAC;QAEvF,MAAM,MAAM,CAAC,UAAU,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;QACpD,YAAY,CAAC,YAAY,GAAG,IAAI,CAAC;IACnC,CAAC;IAED,0DAA0D;IACnD,MAAM,CAAC,SAAS;QACrB,IAAI,YAAY,CAAC,aAAa;YAC5B,YAAY,CAAC,aAAa,CAAC,mBAAmB,CAAC,YAAY,CAAC,qBAAqB,CAAC,CAAC;QACrF,YAAY,CAAC,aAAa,GAAG,SAAS,CAAC;QAEvC,MAAM,CAAC,SAAS,EAAE,CAAC;QACnB,YAAY,CAAC,YAAY,GAAG,KAAK,CAAC;IACpC,CAAC;IAED,sDAAsD;IAC/C,MAAM,KAAK,WAAW,KAAc,OAAO,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC;IAE9E;;OAEG;IACI,MAAM,KAAK,YAAY;QAC5B,IAAI,CAAC,YAAY,CAAC,aAAa;YAC7B,MAAM,IAAI,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,mGAAmG,CAAC,CAAC;QAC5J,OAAO,YAAY,CAAC,aAAa,CAAC;IACpC,CAAC;IAED,kDAAkD;IAC3C,MAAM,KAAK,qBAAqB;QACrC,OAAO,cAAc,CAAC;IACxB,CAAC;IAED,gBAAgB;IACT,MAAM,KAAK,WAAW;QAC3B,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,SAAS,CAAC,GAAsB;QAC5C,IAAI,CAAC,YAAY,CAAC,WAAW,EAAE;YAC7B,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,iFAAiF,CAAC,CAAC;YACtI,OAAO,EAAE,CAAC;SACX;QACD,OAAO,YAAY,CAAC,YAAY,CAAC,kBAAkB,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE,YAAY,CAAC,qBAAqB,EAAE,CAAC,CAAC;IACvG,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,cAAc,CAAC,GAAQ;QACnC,MAAM,SAAS,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC;QACpC,MAAM,QAAQ,GAAG,YAAY,CAAC,WAAW,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC/E,OAAO,QAAQ,CAAC;IAClB,CAAC;;AArEc,yBAAY,GAAG,KAAK,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Common\r\n */\r\n\r\nimport { enablePatches } from \"immer\";\r\nimport { Logger } from \"@itwin/core-bentley\";\r\nimport { Localization } from \"@itwin/core-common\";\r\nimport { getClassName, UiError } from \"@itwin/appui-abstract\";\r\nimport { UiCore } from \"@itwin/core-react\";\r\n\r\n/**\r\n * Manages the localization service for the components-react package.\r\n * @public\r\n */\r\nexport class UiComponents {\r\n  private static _initialized = false;\r\n  private static _localization?: Localization;\r\n\r\n  /**\r\n   * Registers the localization service namespace for UiComponents. Also initializes UiCore.\r\n   * @param localization The internationalization service created by the host application.\r\n   */\r\n  public static async initialize(localization: Localization): Promise<void> {\r\n    if (UiComponents._initialized) {\r\n      Logger.logInfo(UiComponents.loggerCategory(UiComponents), `UiComponents.initialize already called`);\r\n      return;\r\n    }\r\n\r\n    enablePatches();\r\n    UiComponents._localization = localization;\r\n    await UiComponents._localization.registerNamespace(UiComponents.localizationNamespace);\r\n\r\n    await UiCore.initialize(UiComponents._localization);\r\n    UiComponents._initialized = true;\r\n  }\r\n\r\n  /** Unregisters the UiComponents localization namespace */\r\n  public static terminate() {\r\n    if (UiComponents._localization)\r\n      UiComponents._localization.unregisterNamespace(UiComponents.localizationNamespace);\r\n    UiComponents._localization = undefined;\r\n\r\n    UiCore.terminate();\r\n    UiComponents._initialized = false;\r\n  }\r\n\r\n  /** Determines if UiComponents has been initialized */\r\n  public static get initialized(): boolean { return UiComponents._initialized; }\r\n\r\n  /** The internationalization service created by the host application.\r\n   * @internal\r\n   */\r\n  public static get localization(): Localization {\r\n    if (!UiComponents._localization)\r\n      throw new UiError(UiComponents.loggerCategory(this), \"_localization: UiComponents.initialize has not been called. Unable to return Localization object.\");\r\n    return UiComponents._localization;\r\n  }\r\n\r\n  /** The internationalization service namespace. */\r\n  public static get localizationNamespace(): string {\r\n    return \"UiComponents\";\r\n  }\r\n\r\n  /** @internal */\r\n  public static get packageName(): string {\r\n    return \"components-react\";\r\n  }\r\n\r\n  /** Calls localization.getLocalizedStringWithNamespace with the \"UiComponents\" namespace. Do NOT include the namespace in the key.\r\n   * @internal\r\n   */\r\n  public static translate(key: string | string[]): string {\r\n    if (!UiComponents.initialized) {\r\n      Logger.logError(UiComponents.loggerCategory(this), `translate: UiComponents.initialize has not been called. Returning blank string.`);\r\n      return \"\";\r\n    }\r\n    return UiComponents.localization.getLocalizedString(key, { ns: UiComponents.localizationNamespace });\r\n  }\r\n\r\n  /** @internal */\r\n  public static loggerCategory(obj: any): string {\r\n    const className = getClassName(obj);\r\n    const category = UiComponents.packageName + (className ? `.${className}` : \"\");\r\n    return category;\r\n  }\r\n\r\n}\r\n"]}
+{"version":3,"file":"UiComponents.js","sourceRoot":"","sources":["../../../src/components-react/UiComponents.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAE7C,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAE3C;;;GAGG;AACH,MAAa,YAAY;IAIvB;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,YAA0B;QACvD,IAAI,YAAY,CAAC,YAAY,EAAE;YAC7B,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,YAAY,CAAC,EAAE,wCAAwC,CAAC,CAAC;YACpG,OAAO;SACR;QAED,aAAa,EAAE,CAAC;QAChB,YAAY,CAAC,aAAa,GAAG,YAAY,CAAC;QAC1C,MAAM,YAAY,CAAC,aAAa,CAAC,iBAAiB,CAAC,YAAY,CAAC,qBAAqB,CAAC,CAAC;QAEvF,MAAM,MAAM,CAAC,UAAU,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;QACpD,YAAY,CAAC,YAAY,GAAG,IAAI,CAAC;IACnC,CAAC;IAED,0DAA0D;IACnD,MAAM,CAAC,SAAS;QACrB,IAAI,YAAY,CAAC,aAAa;YAC5B,YAAY,CAAC,aAAa,CAAC,mBAAmB,CAAC,YAAY,CAAC,qBAAqB,CAAC,CAAC;QACrF,YAAY,CAAC,aAAa,GAAG,SAAS,CAAC;QAEvC,MAAM,CAAC,SAAS,EAAE,CAAC;QACnB,YAAY,CAAC,YAAY,GAAG,KAAK,CAAC;IACpC,CAAC;IAED,sDAAsD;IAC/C,MAAM,KAAK,WAAW,KAAc,OAAO,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC;IAE9E;;OAEG;IACI,MAAM,KAAK,YAAY;QAC5B,IAAI,CAAC,YAAY,CAAC,aAAa;YAC7B,MAAM,IAAI,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,mGAAmG,CAAC,CAAC;QAC5J,OAAO,YAAY,CAAC,aAAa,CAAC;IACpC,CAAC;IAED,kDAAkD;IAC3C,MAAM,KAAK,qBAAqB;QACrC,OAAO,cAAc,CAAC;IACxB,CAAC;IAED,gBAAgB;IACT,MAAM,KAAK,WAAW;QAC3B,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,SAAS,CAAC,GAAsB;QAC5C,IAAI,CAAC,YAAY,CAAC,WAAW,EAAE;YAC7B,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,iFAAiF,CAAC,CAAC;YACtI,OAAO,EAAE,CAAC;SACX;QACD,OAAO,YAAY,CAAC,YAAY,CAAC,kBAAkB,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE,YAAY,CAAC,qBAAqB,EAAE,CAAC,CAAC;IACvG,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,cAAc,CAAC,GAAQ;QACnC,MAAM,SAAS,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC;QACpC,MAAM,QAAQ,GAAG,YAAY,CAAC,WAAW,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC/E,OAAO,QAAQ,CAAC;IAClB,CAAC;;AArEc,yBAAY,GAAG,KAAK,CAAC;SADzB,YAAY","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Common\r\n */\r\n\r\nimport { enablePatches } from \"immer\";\r\nimport { Logger } from \"@itwin/core-bentley\";\r\nimport { Localization } from \"@itwin/core-common\";\r\nimport { getClassName, UiError } from \"@itwin/appui-abstract\";\r\nimport { UiCore } from \"@itwin/core-react\";\r\n\r\n/**\r\n * Manages the localization service for the components-react package.\r\n * @public\r\n */\r\nexport class UiComponents {\r\n  private static _initialized = false;\r\n  private static _localization?: Localization;\r\n\r\n  /**\r\n   * Registers the localization service namespace for UiComponents. Also initializes UiCore.\r\n   * @param localization The internationalization service created by the host application.\r\n   */\r\n  public static async initialize(localization: Localization): Promise<void> {\r\n    if (UiComponents._initialized) {\r\n      Logger.logInfo(UiComponents.loggerCategory(UiComponents), `UiComponents.initialize already called`);\r\n      return;\r\n    }\r\n\r\n    enablePatches();\r\n    UiComponents._localization = localization;\r\n    await UiComponents._localization.registerNamespace(UiComponents.localizationNamespace);\r\n\r\n    await UiCore.initialize(UiComponents._localization);\r\n    UiComponents._initialized = true;\r\n  }\r\n\r\n  /** Unregisters the UiComponents localization namespace */\r\n  public static terminate() {\r\n    if (UiComponents._localization)\r\n      UiComponents._localization.unregisterNamespace(UiComponents.localizationNamespace);\r\n    UiComponents._localization = undefined;\r\n\r\n    UiCore.terminate();\r\n    UiComponents._initialized = false;\r\n  }\r\n\r\n  /** Determines if UiComponents has been initialized */\r\n  public static get initialized(): boolean { return UiComponents._initialized; }\r\n\r\n  /** The internationalization service created by the host application.\r\n   * @internal\r\n   */\r\n  public static get localization(): Localization {\r\n    if (!UiComponents._localization)\r\n      throw new UiError(UiComponents.loggerCategory(this), \"_localization: UiComponents.initialize has not been called. Unable to return Localization object.\");\r\n    return UiComponents._localization;\r\n  }\r\n\r\n  /** The internationalization service namespace. */\r\n  public static get localizationNamespace(): string {\r\n    return \"UiComponents\";\r\n  }\r\n\r\n  /** @internal */\r\n  public static get packageName(): string {\r\n    return \"components-react\";\r\n  }\r\n\r\n  /** Calls localization.getLocalizedStringWithNamespace with the \"UiComponents\" namespace. Do NOT include the namespace in the key.\r\n   * @internal\r\n   */\r\n  public static translate(key: string | string[]): string {\r\n    if (!UiComponents.initialized) {\r\n      Logger.logError(UiComponents.loggerCategory(this), `translate: UiComponents.initialize has not been called. Returning blank string.`);\r\n      return \"\";\r\n    }\r\n    return UiComponents.localization.getLocalizedString(key, { ns: UiComponents.localizationNamespace });\r\n  }\r\n\r\n  /** @internal */\r\n  public static loggerCategory(obj: any): string {\r\n    const className = getClassName(obj);\r\n    const category = UiComponents.packageName + (className ? `.${className}` : \"\");\r\n    return category;\r\n  }\r\n\r\n}\r\n"]}

package/lib/esm/components-react/common/DateUtils.d.ts

@@ -1,59 +1,59 @@
-/** @packageDocumentation
- * @module Common
- */
-/**
- * Define formatting options for use when component are generating a formatted date string calling `Date.toLocaleTimeString()`.
- * @public
- */
-export interface DateFormatOptions {
-    locales?: string | string[] | undefined;
-    options?: Intl.DateTimeFormatOptions | undefined;
-}
-/**
- * Adjust a Date object to show time in one time zone as if it is in the local time zone.
- * This is useful when showing sunrise and sunset times for a project location in a different time zone
- * and the time displayed should appear as if the user is seeing clock in project location.
- * Example 1:
- * If you have a UTC time for London (UTC +0100) and you want to display it in Eastern-US (UTC -0400) as if you were in London.
- * ```ts
- *   londonDate = new Date("July 22, 2018 07:22:13 +0100");
- *   in Eastern-US londonDate will show as '7/22/2018, 2:22:13 AM'
- *   adjustedDate = adjustDateToTimezone(londonDate, 1*60);
- *   in location Eastern-US adjustedDate will show as '7/22/2018, 7:22:13 AM'
- * ```
- * Example 2:
- * If you have a UTC time for your location (UTC -0400) and you want to display the time as if you are in Western-US (UTC -0700).
- * ```ts
- *   easternDate = new Date("July 22, 2018 07:22:13 -0400");
- *   adjustedDate = adjustDateToTimezone(easternDate, -7*60);
- *   in location Eastern-US adjustedDate will show as '7/22/2018, 7:22:13 AM'
- * ```
- *
- * The utcOffset must be the time in minutes between the UTC and the desired time zone at the date specified by inDateTime.
- * For example, if you want the time offset to New York, NY and the date is during Daylight Saving Time, utcOffset should be -240 (-4 * 60).
- * If the date falls during Standard Time in New York, utcOffset will be -300 (-5 * 60).
- *
- * @param inDateTime date/time at project location
- * @param utcOffset UTC offset in  minutes
- * @public
- */
-export declare function adjustDateToTimezone(inDateTime: Date, utcOffset: number): Date;
-/**
- * Format a date in a display string, optionally converting to time zone, if specified by timeZoneOffset
- * @param date Date object to format
- * @param timeZoneOffset optional: offset from UTC to use for conversion
- * @param formatOptions optional: allow locale and format for output Date string. If not defined current locale options are used.
- * @returns formatted date string
- * @public
- */
-export declare const toDateString: (date: Date, timeZoneOffset?: number | undefined, formatOptions?: DateFormatOptions | undefined) => string;
-/**
- * Format the time included in a date, optionally converting to time zone, if specified
- * @param date Date object
- * @param timeZoneOffset optional: offset from UTC to use for conversion
- * @param formatOptions optional: allow locale and format for output Time string. If not defined current locale options are used.
- * @returns formatted time string
- * @public
- */
-export declare const toTimeString: (date: Date, timeZoneOffset?: number | undefined, formatOptions?: DateFormatOptions | undefined) => string;
+/** @packageDocumentation
+ * @module Common
+ */
+/**
+ * Define formatting options for use when component are generating a formatted date string calling `Date.toLocaleTimeString()`.
+ * @public
+ */
+export interface DateFormatOptions {
+    locales?: string | string[] | undefined;
+    options?: Intl.DateTimeFormatOptions | undefined;
+}
+/**
+ * Adjust a Date object to show time in one time zone as if it is in the local time zone.
+ * This is useful when showing sunrise and sunset times for a project location in a different time zone
+ * and the time displayed should appear as if the user is seeing clock in project location.
+ * Example 1:
+ * If you have a UTC time for London (UTC +0100) and you want to display it in Eastern-US (UTC -0400) as if you were in London.
+ * ```ts
+ *   londonDate = new Date("July 22, 2018 07:22:13 +0100");
+ *   in Eastern-US londonDate will show as '7/22/2018, 2:22:13 AM'
+ *   adjustedDate = adjustDateToTimezone(londonDate, 1*60);
+ *   in location Eastern-US adjustedDate will show as '7/22/2018, 7:22:13 AM'
+ * ```
+ * Example 2:
+ * If you have a UTC time for your location (UTC -0400) and you want to display the time as if you are in Western-US (UTC -0700).
+ * ```ts
+ *   easternDate = new Date("July 22, 2018 07:22:13 -0400");
+ *   adjustedDate = adjustDateToTimezone(easternDate, -7*60);
+ *   in location Eastern-US adjustedDate will show as '7/22/2018, 7:22:13 AM'
+ * ```
+ *
+ * The utcOffset must be the time in minutes between the UTC and the desired time zone at the date specified by inDateTime.
+ * For example, if you want the time offset to New York, NY and the date is during Daylight Saving Time, utcOffset should be -240 (-4 * 60).
+ * If the date falls during Standard Time in New York, utcOffset will be -300 (-5 * 60).
+ *
+ * @param inDateTime date/time at project location
+ * @param utcOffset UTC offset in  minutes
+ * @public
+ */
+export declare function adjustDateToTimezone(inDateTime: Date, utcOffset: number): Date;
+/**
+ * Format a date in a display string, optionally converting to time zone, if specified by timeZoneOffset
+ * @param date Date object to format
+ * @param timeZoneOffset optional: offset from UTC to use for conversion
+ * @param formatOptions optional: allow locale and format for output Date string. If not defined current locale options are used.
+ * @returns formatted date string
+ * @public
+ */
+export declare const toDateString: (date: Date, timeZoneOffset?: number, formatOptions?: DateFormatOptions) => string;
+/**
+ * Format the time included in a date, optionally converting to time zone, if specified
+ * @param date Date object
+ * @param timeZoneOffset optional: offset from UTC to use for conversion
+ * @param formatOptions optional: allow locale and format for output Time string. If not defined current locale options are used.
+ * @returns formatted time string
+ * @public
+ */
+export declare const toTimeString: (date: Date, timeZoneOffset?: number, formatOptions?: DateFormatOptions) => string;
 //# sourceMappingURL=DateUtils.d.ts.map

package/lib/esm/components-react/common/DateUtils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DateUtils.d.ts","sourceRoot":"","sources":["../../../../src/components-react/common/DateUtils.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC;IACxC,OAAO,CAAC,EAAE,IAAI,CAAC,qBAAqB,GAAG,SAAS,CAAC;CAClD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,QAEvE;AACD;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,SAAU,IAAI,+FAMtC,CAAC;AACF;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,SAAU,IAAI,+FAMtC,CAAC"}
+{"version":3,"file":"DateUtils.d.ts","sourceRoot":"","sources":["../../../../src/components-react/common/DateUtils.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC;IACxC,OAAO,CAAC,EAAE,IAAI,CAAC,qBAAqB,GAAG,SAAS,CAAC;CAClD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,QAEvE;AACD;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,SAAU,IAAI,mBAAmB,MAAM,kBAAkB,iBAAiB,WAMlG,CAAC;AACF;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,SAAU,IAAI,mBAAmB,MAAM,kBAAkB,iBAAiB,WAMlG,CAAC"}

package/lib/esm/components-react/common/DateUtils.js

@@ -1,69 +1,69 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Common
- */
-/**
- * Adjust a Date object to show time in one time zone as if it is in the local time zone.
- * This is useful when showing sunrise and sunset times for a project location in a different time zone
- * and the time displayed should appear as if the user is seeing clock in project location.
- * Example 1:
- * If you have a UTC time for London (UTC +0100) and you want to display it in Eastern-US (UTC -0400) as if you were in London.
- * ```ts
- *   londonDate = new Date("July 22, 2018 07:22:13 +0100");
- *   in Eastern-US londonDate will show as '7/22/2018, 2:22:13 AM'
- *   adjustedDate = adjustDateToTimezone(londonDate, 1*60);
- *   in location Eastern-US adjustedDate will show as '7/22/2018, 7:22:13 AM'
- * ```
- * Example 2:
- * If you have a UTC time for your location (UTC -0400) and you want to display the time as if you are in Western-US (UTC -0700).
- * ```ts
- *   easternDate = new Date("July 22, 2018 07:22:13 -0400");
- *   adjustedDate = adjustDateToTimezone(easternDate, -7*60);
- *   in location Eastern-US adjustedDate will show as '7/22/2018, 7:22:13 AM'
- * ```
- *
- * The utcOffset must be the time in minutes between the UTC and the desired time zone at the date specified by inDateTime.
- * For example, if you want the time offset to New York, NY and the date is during Daylight Saving Time, utcOffset should be -240 (-4 * 60).
- * If the date falls during Standard Time in New York, utcOffset will be -300 (-5 * 60).
- *
- * @param inDateTime date/time at project location
- * @param utcOffset UTC offset in  minutes
- * @public
- */
-export function adjustDateToTimezone(inDateTime, utcOffset) {
-    return new Date(inDateTime.getTime() + (inDateTime.getTimezoneOffset() + utcOffset) * 60000);
-}
-/**
- * Format a date in a display string, optionally converting to time zone, if specified by timeZoneOffset
- * @param date Date object to format
- * @param timeZoneOffset optional: offset from UTC to use for conversion
- * @param formatOptions optional: allow locale and format for output Date string. If not defined current locale options are used.
- * @returns formatted date string
- * @public
- */
-export const toDateString = (date, timeZoneOffset, formatOptions) => {
-    if (formatOptions) {
-        return undefined === timeZoneOffset ? date.toLocaleDateString(formatOptions.locales, formatOptions.options) :
-            adjustDateToTimezone(date, timeZoneOffset).toLocaleDateString(formatOptions.locales, formatOptions.options);
-    }
-    return undefined === timeZoneOffset ? date.toLocaleDateString() : adjustDateToTimezone(date, timeZoneOffset).toLocaleDateString();
-};
-/**
- * Format the time included in a date, optionally converting to time zone, if specified
- * @param date Date object
- * @param timeZoneOffset optional: offset from UTC to use for conversion
- * @param formatOptions optional: allow locale and format for output Time string. If not defined current locale options are used.
- * @returns formatted time string
- * @public
- */
-export const toTimeString = (date, timeZoneOffset, formatOptions) => {
-    if (formatOptions) {
-        return undefined === timeZoneOffset ? date.toLocaleTimeString(formatOptions.locales, formatOptions.options) :
-            adjustDateToTimezone(date, timeZoneOffset).toLocaleTimeString(formatOptions.locales, formatOptions.options);
-    }
-    return undefined === timeZoneOffset ? date.toLocaleTimeString() : adjustDateToTimezone(date, timeZoneOffset).toLocaleTimeString();
-};
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Common
+ */
+/**
+ * Adjust a Date object to show time in one time zone as if it is in the local time zone.
+ * This is useful when showing sunrise and sunset times for a project location in a different time zone
+ * and the time displayed should appear as if the user is seeing clock in project location.
+ * Example 1:
+ * If you have a UTC time for London (UTC +0100) and you want to display it in Eastern-US (UTC -0400) as if you were in London.
+ * ```ts
+ *   londonDate = new Date("July 22, 2018 07:22:13 +0100");
+ *   in Eastern-US londonDate will show as '7/22/2018, 2:22:13 AM'
+ *   adjustedDate = adjustDateToTimezone(londonDate, 1*60);
+ *   in location Eastern-US adjustedDate will show as '7/22/2018, 7:22:13 AM'
+ * ```
+ * Example 2:
+ * If you have a UTC time for your location (UTC -0400) and you want to display the time as if you are in Western-US (UTC -0700).
+ * ```ts
+ *   easternDate = new Date("July 22, 2018 07:22:13 -0400");
+ *   adjustedDate = adjustDateToTimezone(easternDate, -7*60);
+ *   in location Eastern-US adjustedDate will show as '7/22/2018, 7:22:13 AM'
+ * ```
+ *
+ * The utcOffset must be the time in minutes between the UTC and the desired time zone at the date specified by inDateTime.
+ * For example, if you want the time offset to New York, NY and the date is during Daylight Saving Time, utcOffset should be -240 (-4 * 60).
+ * If the date falls during Standard Time in New York, utcOffset will be -300 (-5 * 60).
+ *
+ * @param inDateTime date/time at project location
+ * @param utcOffset UTC offset in  minutes
+ * @public
+ */
+export function adjustDateToTimezone(inDateTime, utcOffset) {
+    return new Date(inDateTime.getTime() + (inDateTime.getTimezoneOffset() + utcOffset) * 60000);
+}
+/**
+ * Format a date in a display string, optionally converting to time zone, if specified by timeZoneOffset
+ * @param date Date object to format
+ * @param timeZoneOffset optional: offset from UTC to use for conversion
+ * @param formatOptions optional: allow locale and format for output Date string. If not defined current locale options are used.
+ * @returns formatted date string
+ * @public
+ */
+export const toDateString = (date, timeZoneOffset, formatOptions) => {
+    if (formatOptions) {
+        return undefined === timeZoneOffset ? date.toLocaleDateString(formatOptions.locales, formatOptions.options) :
+            adjustDateToTimezone(date, timeZoneOffset).toLocaleDateString(formatOptions.locales, formatOptions.options);
+    }
+    return undefined === timeZoneOffset ? date.toLocaleDateString() : adjustDateToTimezone(date, timeZoneOffset).toLocaleDateString();
+};
+/**
+ * Format the time included in a date, optionally converting to time zone, if specified
+ * @param date Date object
+ * @param timeZoneOffset optional: offset from UTC to use for conversion
+ * @param formatOptions optional: allow locale and format for output Time string. If not defined current locale options are used.
+ * @returns formatted time string
+ * @public
+ */
+export const toTimeString = (date, timeZoneOffset, formatOptions) => {
+    if (formatOptions) {
+        return undefined === timeZoneOffset ? date.toLocaleTimeString(formatOptions.locales, formatOptions.options) :
+            adjustDateToTimezone(date, timeZoneOffset).toLocaleTimeString(formatOptions.locales, formatOptions.options);
+    }
+    return undefined === timeZoneOffset ? date.toLocaleTimeString() : adjustDateToTimezone(date, timeZoneOffset).toLocaleTimeString();
+};
 //# sourceMappingURL=DateUtils.js.map

package/lib/esm/components-react/common/DelayedSpinner.d.ts

@@ -1,23 +1,23 @@
-/** @packageDocumentation
- * @module Common
- */
-/// <reference types="react" />
-import { ProgressRadialProps } from "@itwin/itwinui-react";
-/** Type for ProgressRadialProps.size */
-declare type RadialSizeType = ProgressRadialProps["size"];
-/**
- * Props for [[DelayedSpinner]] component.
- * @internal
- */
-export interface DelayedSpinnerProps {
-    loadStart?: Date;
-    delay?: number;
-    size?: RadialSizeType;
-}
-/**
- * Spinner that is rendered with delay.
- * @internal
- */
-export declare function DelayedSpinner(props: DelayedSpinnerProps): JSX.Element | null;
-export {};
+/** @packageDocumentation
+ * @module Common
+ */
+/// <reference types="react" />
+import { ProgressRadialProps } from "@itwin/itwinui-react";
+/** Type for ProgressRadialProps.size */
+type RadialSizeType = ProgressRadialProps["size"];
+/**
+ * Props for [[DelayedSpinner]] component.
+ * @internal
+ */
+export interface DelayedSpinnerProps {
+    loadStart?: Date;
+    delay?: number;
+    size?: RadialSizeType;
+}
+/**
+ * Spinner that is rendered with delay.
+ * @internal
+ */
+export declare function DelayedSpinner(props: DelayedSpinnerProps): JSX.Element | null;
+export {};
 //# sourceMappingURL=DelayedSpinner.d.ts.map

package/lib/esm/components-react/common/DelayedSpinner.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DelayedSpinner.d.ts","sourceRoot":"","sources":["../../../../src/components-react/common/DelayedSpinner.tsx"],"names":[],"mappings":"AAIA;;GAEG;;AAGH,OAAO,EAAkB,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAE3E,wCAAwC;AACxC,aAAK,cAAc,GAAG,mBAAmB,CAAC,MAAM,CAAC,CAAC;AAElD;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,cAAc,CAAC;CACvB;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,mBAAmB,sBAmBxD"}
+{"version":3,"file":"DelayedSpinner.d.ts","sourceRoot":"","sources":["../../../../src/components-react/common/DelayedSpinner.tsx"],"names":[],"mappings":"AAIA;;GAEG;;AAGH,OAAO,EAAkB,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAE3E,wCAAwC;AACxC,KAAK,cAAc,GAAG,mBAAmB,CAAC,MAAM,CAAC,CAAC;AAElD;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,cAAc,CAAC;CACvB;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,mBAAmB,sBAmBxD"}