Introduce @itwin/quantity-formatting-react

.github/CODEOWNERS

@@ -46,3 +46,6 @@
 
 /packages/itwin/map-layers  @itwin/viewer-components-reviewers @mdastous-bentley @eringram
 /change/@itwin-map-layers*  @itwin/viewer-components-reviewers @mdastous-bentley @eringram
+
+/packages/itwin/quantity-formatting  @itwin/viewer-components-reviewers @itwin/itwinjs-core-presentation @hl662
+/change/@itwin-quantity-formatting-react*  @itwin/viewer-components-reviewers @itwin/itwinjs-core-presentation

apps/test-viewer/package.json

@@ -41,6 +41,7 @@
     "@itwin/presentation-hierarchies-react": "^1.8.1",
     "@itwin/presentation-shared": "^1.2.2",
     "@itwin/property-grid-react": "workspace:*",
+    "@itwin/quantity-formatting-react": "workspace:*",
     "@itwin/reports-config-widget-react": "workspace:*",
     "@itwin/tree-widget-react": "workspace:*",
     "@itwin/unified-selection": "^1.4.1",

apps/test-viewer/scripts/linkWorkspaceDeps.cjs

@@ -43,6 +43,10 @@ const packages = [
     name: "@itwin/one-click-lca-react",
     dir: "one-click-lca-widget",
   },
+  {
+    name:"@itwin/quantity-formatting-react",
+    dir: "quantity-formatting"
+  }
 ];
 
 linkPackages();

apps/test-viewer/src/UiProvidersConfig.tsx

@@ -39,6 +39,7 @@ import {
   TreeWidgetComponent,
 } from "@itwin/tree-widget-react";
 import { RepositoriesTreeComponent } from "./components/repositories-tree/RepositoriesTree";
+import { QuantityFormatUiItemsProvider } from "./components/QuantityFormatUiItemsProvider";
 import { useViewerOptionsContext } from "./components/ViewerOptions";
 import { unifiedSelectionStorage } from "./SelectionStorage";
 
@@ -47,6 +48,7 @@ import type { ClientPrefix } from "@itwin/grouping-mapping-widget";
 import type { SelectableTreeDefinition } from "@itwin/tree-widget-react";
 import type { UiItemsProvider } from "@itwin/appui-react";
 import type { ComponentPropsWithRef } from "react";
+import { QuantityFormatting } from "@itwin/quantity-formatting-react";
 
 export interface UiProvidersConfig {
   initialize: () => Promise<void>;
@@ -324,6 +326,13 @@ const configuredUiItems = new Map<string, UiItem>([
       createUiItemsProviders: () => [new OneClickLCAProvider()],
     },
   ],
+  [
+    "quantity-formatting",
+    {
+      initialize: async () => QuantityFormatting.startup(),
+      createUiItemsProviders: () => [new QuantityFormatUiItemsProvider()],
+    },
+  ],
 ]);
 
 function ModelsTreeWithOption(props: ComponentPropsWithRef<typeof ModelsTreeComponent>) {

apps/test-viewer/src/components/QuantityFormatUiItemsProvider.tsx

@@ -0,0 +1,107 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+
+import React, { useCallback, useState } from "react";
+import { StagePanelLocation, StagePanelSection } from "@itwin/appui-react";
+import { QuantityFormatPanel } from "@itwin/quantity-formatting-react";
+import { IModelApp } from "@itwin/core-frontend";
+import type { FormatProps } from "@itwin/core-quantity";
+import { Button, Modal, ModalButtonBar } from "@itwin/itwinui-react";
+
+import type { UiItemsProvider, Widget } from "@itwin/appui-react";
+
+/** Widget component that shows a button to open the Quantity Format Panel in a modal */
+const QuantityFormatWidget: React.FC = () => {
+  // Initial format definition with basic decimal format
+  const [formatDefinition, setFormatDefinition] = useState<FormatProps>({
+    precision: 4,
+    type: "Decimal",
+    composite: {
+      units: [{ name: "Units.M", label: "m" }],
+    },
+  });
+
+  const [isModalOpen, setIsModalOpen] = useState(false);
+
+  const handleFormatChange = useCallback((newFormat: FormatProps) => {
+    setFormatDefinition(newFormat);
+  }, []);
+
+  const handleOpenModal = useCallback(() => {
+    setIsModalOpen(true);
+  }, []);
+
+  const handleCloseModal = useCallback(() => {
+    setIsModalOpen(false);
+  }, []);
+
+  const handleApply = useCallback(() => {
+    // Here you could apply the format changes to the active iModel
+    console.log("Applied format changes:", formatDefinition);
+    setIsModalOpen(false);
+  }, [formatDefinition]);
+
+  // Memoize the unitsProvider to prevent unnecessary re-renders
+  const memoizedUnitsProvider = React.useMemo(() => IModelApp.quantityFormatter.unitsProvider, []);
+
+  return (
+    <>
+      <div style={{ padding: "16px" }}>
+        <Button
+          onClick={handleOpenModal}
+          styleType="high-visibility"
+          size="large"
+          style={{ width: "100%" }}
+        >
+          Configure Quantity Format
+        </Button>
+      </div>
+
+      <Modal
+        isOpen={isModalOpen}
+        onClose={handleCloseModal}
+        title="Quantity Format Settings"
+        style={{ width: "600px", maxWidth: "90vw" }}
+      >
+        <div style={{ padding: "16px", height: "1200px", overflow: "auto" }}>
+          <QuantityFormatPanel
+            formatDefinition={formatDefinition}
+            unitsProvider={memoizedUnitsProvider}
+            onFormatChange={handleFormatChange}
+          />
+        </div>
+
+        <ModalButtonBar>
+          <Button styleType="default" onClick={handleCloseModal}>
+            Cancel
+          </Button>
+          <Button styleType="high-visibility" onClick={handleApply}>
+            Apply
+          </Button>
+        </ModalButtonBar>
+      </Modal>
+    </>
+  );
+};
+
+/** UiItemsProvider that adds a quantity format widget to the side panel */
+export class QuantityFormatUiItemsProvider implements UiItemsProvider {
+  public readonly id = "QuantityFormatUiItemsProvider";
+
+  public provideWidgets(_stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection): ReadonlyArray<Widget> {
+    const widgets: Widget[] = [];
+    if (location === StagePanelLocation.Right && section === StagePanelSection.End && stageUsage === "General") {
+      const quantityFormatWidget: Widget = {
+        id: "quantity-format",
+        label: "Quantity Format",
+        content: <QuantityFormatWidget />,
+      };
+
+      widgets.push(quantityFormatWidget);
+    }
+
+    return widgets;
+  }
+}

change/@itwin-quantity-formatting-react-904f8951-1da2-4b9f-99bb-e0c3b0559228.json

@@ -0,0 +1,7 @@
+{
+  "type": "minor",
+  "comment": "Add @itwin/quantity-formatting-react package",
+  "packageName": "@itwin/quantity-formatting-react",
+  "email": "50554904+hl662@users.noreply.github.com",
+  "dependentChangeType": "patch"
+}

packages/itwin/measure-tools/LICENSE.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright © 2021-2024 Bentley Systems, Incorporated. All rights reserved.
+Copyright © 2021-2025 Bentley Systems, Incorporated. All rights reserved.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

packages/itwin/quantity-formatting/.npmignore

@@ -0,0 +1,11 @@
+# start off ignoring everything, and then add back only the files we want
+*
+!lib/**/*.d.ts
+!lib/**/*.js
+!lib/**/*.js.map
+!lib/**/*.*css
+!lib/public/**/*
+!CHANGELOG.md
+
+# ignore some stuff again
+lib/**/test/**

packages/itwin/quantity-formatting/LICENSE.md

@@ -0,0 +1,9 @@
+# MIT License
+
+Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

packages/itwin/quantity-formatting/README.md

@@ -0,0 +1,48 @@
+# @itwin/quantity-formatting-react
+
+React components for quantity formatting in iTwin.js applications.
+
+## Description
+
+This package provides React components for working with quantities and their formatting in iTwin.js applications. It includes components for input, display, and conversion of quantities with proper unit handling.
+
+**Key Features:**
+- **QuantityFormatPanelV2**: Modern quantity format panel with improved UX
+- **FormatPanelV2**: Flexible format panel with primary/secondary option organization
+- **FormatSampleV2**: Real-time preview of quantity formatting
+- **Comprehensive Format Support**: Support for Decimal, Fractional, Scientific, Station, Azimuth, Bearing, and Ratio formats
+- **Modular Architecture**: Organized into panels and internal components for reusability
+
+## Main Components
+- `QuantityFormatPanelV2` - Main panel for quantity format configuration
+- `FormatPanelV2` - Core format panel with expandable advanced options
+- `FormatSampleV2` - Live preview component for formatted values
+
+## Installation
+
+```bash
+npm install @itwin/quantity-formatting-react
+```
+
+## Usage
+
+```typescript
+import {
+  QuantityFormatPanelV2,
+  FormatPanelV2,
+  FormatSampleV2
+} from "@itwin/quantity-formatting-react";
+
+// Use the QuantityFormatPanelV2 component
+<QuantityFormatPanelV2
+  formatDefinition={formatProps}
+  unitsProvider={unitsProvider}
+  onFormatChange={(newFormat) => console.log(newFormat)}
+  showSample={true}
+  initialMagnitude={1234.56}
+/>
+```
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE.md](./LICENSE.md) file for details.

packages/itwin/quantity-formatting/eslint.config.js

@@ -0,0 +1,24 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+import iTwinPlugin from "@itwin/eslint-plugin";
+
+export default [
+  {
+    files: ["**/*.{ts,tsx}"],
+    ...iTwinPlugin.configs.uiConfig,
+    rules: {
+      "@itwin/no-internal": [
+        "warn",
+        {
+          tag: [
+            "internal",
+            "alpha",
+          ],
+        },
+      ],
+      "@typescript-eslint/consistent-type-imports": "error",
+    },
+  },
+];