@itwin/components-react 4.17.0 → 5.0.0-dev.2

package/lib/components-react/editors/DateTimeEditor.js

@@ -0,0 +1,252 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module PropertyEditors
+ */
+import "./DateTimeEditor.scss";
+import classnames from "classnames";
+import * as React from "react";
+import { AlternateDateFormats, PropertyValueFormat, TimeDisplay, } from "@itwin/appui-abstract";
+import { PropertyEditorBase } from "./PropertyEditorManager.js";
+import { PopupButton, PopupContent, PopupOkCancelButtons, } from "./PopupButton.js";
+import { TimeField } from "../datepicker/TimeField.js";
+import { DatePicker } from "../datepicker/DatePicker.js";
+import { TypeConverterManager } from "../converters/TypeConverterManager.js";
+import { DateTimeTypeConverterBase } from "../converters/DateTimeTypeConverter.js";
+import { Text } from "@itwin/itwinui-react";
+import { adjustDateToTimezone } from "../common/DateUtils.js";
+/** DateTimeEditor React component that is a property editor for selection of date and time.
+ * @internal
+ */
+export class DateTimeEditor extends React.PureComponent {
+    constructor() {
+        super(...arguments);
+        this._isMounted = false;
+        this._enterKey = false;
+        this._divElement = React.createRef();
+        this.state = {
+            value: new Date(),
+            editInUtc: false,
+        };
+        this._handleChange = (newValue) => {
+            if (this._isMounted && this.state.typeConverter) {
+                if (this.state.editInUtc) {
+                    newValue = adjustDateToTimezone(newValue, newValue.getTimezoneOffset() * -1);
+                }
+                void this.processDateChange(this.state.typeConverter, newValue);
+            }
+        };
+        this._handleTimeChange = (time) => {
+            // Combine new time into selected Date
+            if (this.state.editInUtc) {
+                const newWorkingDate = adjustDateToTimezone(this.state.value, 0);
+                newWorkingDate.setUTCHours(time.hours, time.minutes, time.seconds);
+                this._handleChange(newWorkingDate);
+            }
+            else {
+                const newWorkingDate = new Date(this.state.value.getTime());
+                newWorkingDate.setHours(time.hours, time.minutes, time.seconds);
+                this._handleChange(newWorkingDate);
+            }
+        };
+        this._handleEnter = async () => {
+            this._enterKey = true;
+            await this._handleCommit();
+        };
+        this._handleClose = async () => {
+            if (this._enterKey) {
+                this._enterKey = false;
+            }
+            else {
+                if (this.props.onCancel)
+                    this.props.onCancel();
+            }
+        };
+        this._handleOk = async (_event) => {
+            await this._handleCommit();
+        };
+        this._handleCancel = (_event) => {
+            if (this.props.onCancel) {
+                this.props.onCancel();
+            }
+        };
+        this._handleCommit = async () => {
+            if (this.props.propertyRecord && this.props.onCommit) {
+                const propertyValue = await this.getPropertyValue();
+                if (propertyValue !== undefined) {
+                    this.props.onCommit({
+                        propertyRecord: this.props.propertyRecord,
+                        newValue: propertyValue,
+                    });
+                }
+            }
+        };
+    }
+    async getPropertyValue() {
+        const record = this.props.propertyRecord;
+        let propertyValue;
+        if (record && record.value.valueFormat === PropertyValueFormat.Primitive) {
+            propertyValue = {
+                valueFormat: PropertyValueFormat.Primitive,
+                value: this.state.value,
+                displayValue: this.state.displayValue,
+            };
+        }
+        return propertyValue;
+    }
+    get htmlElement() {
+        return this._divElement.current;
+    }
+    get hasFocus() {
+        let containsFocus = false;
+        if (this.htmlElement)
+            containsFocus = this.htmlElement.contains(document.activeElement);
+        return containsFocus;
+    }
+    async processDateChange(typeConverter, newValue) {
+        if (this.props.propertyRecord) {
+            const displayValue = await typeConverter.convertPropertyToString(this.props.propertyRecord.property, newValue);
+            this.setState({
+                value: newValue,
+                displayValue,
+            });
+        }
+    }
+    componentDidMount() {
+        this._isMounted = true;
+        void this.setStateFromProps();
+    }
+    componentWillUnmount() {
+        this._isMounted = false;
+    }
+    componentDidUpdate(prevProps) {
+        if (this.props.propertyRecord !== prevProps.propertyRecord) {
+            void this.setStateFromProps();
+        }
+    }
+    async setStateFromProps() {
+        const record = this.props.propertyRecord;
+        let initialValue;
+        let typeConverter;
+        let timeDisplay;
+        let alternateDateFormat = AlternateDateFormats.None;
+        let editInUtc = false;
+        if (this.props.showTime)
+            timeDisplay = TimeDisplay.H12MC;
+        if (record && record.value.valueFormat === PropertyValueFormat.Primitive) {
+            if (record.value.value instanceof Date)
+                initialValue = new Date(record.value.value);
+            else if (typeof record.value.value === "string")
+                initialValue = new Date(record.value.value);
+            else if (record.value.value === undefined)
+                initialValue = new Date();
+            typeConverter = TypeConverterManager.getConverter(record.property.typename, record.property.converter?.name);
+            const options = record.property.converter?.options;
+            if (options) {
+                if ("alternateDateFormat" in options) {
+                    if (DateTimeTypeConverterBase.isAlternateDateFormats(options.alternateDateFormat)) {
+                        timeDisplay = TimeDisplay.H24MS;
+                        alternateDateFormat = options.alternateDateFormat;
+                    }
+                }
+                if ("timeDisplay" in options && this.props.showTime) {
+                    timeDisplay = options.timeDisplay;
+                    // use 24 hr time display if alternateDateFormat is defined
+                    if (alternateDateFormat &&
+                        timeDisplay !== TimeDisplay.H24MS &&
+                        timeDisplay !== TimeDisplay.H24M)
+                        timeDisplay = TimeDisplay.H24MS;
+                }
+                if (alternateDateFormat) {
+                    editInUtc = true;
+                    if (this.props.showTime) {
+                        if (alternateDateFormat === AlternateDateFormats.IsoShort) {
+                            alternateDateFormat = AlternateDateFormats.IsoDateTime;
+                        }
+                        if (alternateDateFormat === AlternateDateFormats.UtcShort) {
+                            alternateDateFormat = AlternateDateFormats.UtcDateTime;
+                        }
+                        if (alternateDateFormat === AlternateDateFormats.UtcShortWithDay) {
+                            alternateDateFormat = AlternateDateFormats.UtcDateTimeWithDay;
+                        }
+                    }
+                    else {
+                        timeDisplay = undefined;
+                        if (alternateDateFormat === AlternateDateFormats.IsoDateTime)
+                            alternateDateFormat = AlternateDateFormats.IsoShort;
+                        if (alternateDateFormat === AlternateDateFormats.UtcDateTime)
+                            alternateDateFormat = AlternateDateFormats.UtcShort;
+                        if (alternateDateFormat === AlternateDateFormats.UtcDateTimeWithDay)
+                            alternateDateFormat = AlternateDateFormats.UtcShortWithDay;
+                    }
+                }
+            }
+        }
+        if (!initialValue) {
+            throw new Error("Bad Value");
+        }
+        if (!typeConverter) {
+            throw new Error("Unable to determine TypeConverter");
+        }
+        const isDisabled = record && !!record.isDisabled;
+        const displayValue = await typeConverter.convertPropertyToString(record.property, initialValue);
+        if (this._isMounted)
+            this.setState({
+                value: initialValue,
+                isDisabled,
+                timeDisplay,
+                typeConverter,
+                displayValue,
+                editInUtc,
+            });
+    }
+    render() {
+        const date = this.state.editInUtc
+            ? adjustDateToTimezone(this.state.value, 0)
+            : this.state.value;
+        const timeSpec = {
+            hours: date.getHours(),
+            minutes: date.getMinutes(),
+            seconds: date.getSeconds(),
+        };
+        const className = classnames("components-cell-editor", "components-datetime-editor", this.props.className);
+        return (React.createElement("div", { className: className, ref: this._divElement },
+            React.createElement(PopupButton, { label: this.state.displayValue, onClose: this._handleClose, onEnter: this._handleEnter, setFocus: this.props.setFocus },
+                React.createElement(PopupContent, null,
+                    React.createElement(React.Fragment, null,
+                        React.createElement("div", { className: "components-date-picker-calendar-popup-panel", "data-testid": "components-date-picker-calendar-popup-panel" },
+                            React.createElement(DatePicker // eslint-disable-line deprecation/deprecation
+                            , { selected: date, onDateChange: this._handleChange, showFocusOutline: false }),
+                            this.state.timeDisplay && (React.createElement("div", { className: "time-container" },
+                                React.createElement(Text, { variant: "body", className: "time-label" }, "Time"),
+                                React.createElement(TimeField, { time: timeSpec, timeDisplay: this.state.timeDisplay, onTimeChange: this._handleTimeChange }))))),
+                    React.createElement(PopupOkCancelButtons, { onOk: this._handleOk, onCancel: this._handleCancel })))));
+    }
+}
+/** DateTime Property Editor registered for the "number" type name and "DateTime" editor name.
+ * It uses the [[DateTimeEditor]] React component.
+ * @internal
+ */
+export class ShortDateTimePropertyEditor extends PropertyEditorBase {
+    get reactNode() {
+        return React.createElement(DateTimeEditor, { showTime: false });
+    }
+    get containerHandlesTab() {
+        return false;
+    }
+}
+/** DateTime Property Editor registered for the "number" type name and "DateTime" editor name.
+ * It uses the [[DateTimeEditor]] React component.
+ * @internal
+ */
+export class DateTimePropertyEditor extends PropertyEditorBase {
+    get reactNode() {
+        return React.createElement(DateTimeEditor, { showTime: true });
+    }
+    get containerHandlesTab() {
+        return false;
+    }
+}
+//# sourceMappingURL=DateTimeEditor.js.map

package/lib/components-react/editors/DateTimeEditor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DateTimeEditor.js","sourceRoot":"","sources":["../../../src/components-react/editors/DateTimeEditor.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,uBAAuB,CAAC;AAC/B,OAAO,UAAU,MAAM,YAAY,CAAC;AACpC,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EACL,oBAAoB,EACpB,mBAAmB,EACnB,WAAW,GACZ,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EACL,WAAW,EACX,YAAY,EACZ,oBAAoB,GACrB,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAEvD,OAAO,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AACzD,OAAO,EAAE,oBAAoB,EAAE,MAAM,uCAAuC,CAAC;AAC7E,OAAO,EAAE,yBAAyB,EAAE,MAAM,wCAAwC,CAAC;AACnF,OAAO,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAC5C,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAmB9D;;GAEG;AACH,MAAM,OAAO,cACX,SAAQ,KAAK,CAAC,aAAuD;IADvE;;QAIU,eAAU,GAAG,KAAK,CAAC;QACnB,cAAS,GAAG,KAAK,CAAC;QAClB,gBAAW,GAAG,KAAK,CAAC,SAAS,EAAkB,CAAC;QAE/B,UAAK,GAAkC;YAC9D,KAAK,EAAE,IAAI,IAAI,EAAE;YACjB,SAAS,EAAE,KAAK;SACjB,CAAC;QA4CM,kBAAa,GAAG,CAAC,QAAc,EAAQ,EAAE;YAC/C,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE,CAAC;gBAChD,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC;oBACzB,QAAQ,GAAG,oBAAoB,CAC7B,QAAQ,EACR,QAAQ,CAAC,iBAAiB,EAAE,GAAG,CAAC,CAAC,CAClC,CAAC;gBACJ,CAAC;gBAED,KAAK,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;YAClE,CAAC;QACH,CAAC,CAAC;QAEM,sBAAiB,GAAG,CAAC,IAAc,EAAQ,EAAE;YACnD,sCAAsC;YACtC,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC;gBACzB,MAAM,cAAc,GAAG,oBAAoB,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;gBACjE,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;gBACnE,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;YACrC,CAAC;iBAAM,CAAC;gBACN,MAAM,cAAc,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;gBAC5D,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;gBAChE,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;YACrC,CAAC;QACH,CAAC,CAAC;QAkHM,iBAAY,GAAG,KAAK,IAAmB,EAAE;YAC/C,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;YACtB,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;QAC7B,CAAC,CAAC;QAEM,iBAAY,GAAG,KAAK,IAAmB,EAAE;YAC/C,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;gBACnB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;YACzB,CAAC;iBAAM,CAAC;gBACN,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ;oBAAE,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;YACjD,CAAC;QACH,CAAC,CAAC;QAEM,cAAS,GAAG,KAAK,EAAE,MAAwB,EAAiB,EAAE;YACpE,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;QAC7B,CAAC,CAAC;QAEM,kBAAa,GAAG,CAAC,MAAwB,EAAQ,EAAE;YACzD,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;gBACxB,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;YACxB,CAAC;QACH,CAAC,CAAC;QAEM,kBAAa,GAAG,KAAK,IAAmB,EAAE;YAChD,IAAI,IAAI,CAAC,KAAK,CAAC,cAAc,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;gBACrD,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBACpD,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;oBAChC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;wBAClB,cAAc,EAAE,IAAI,CAAC,KAAK,CAAC,cAAc;wBACzC,QAAQ,EAAE,aAAa;qBACxB,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;QACH,CAAC,CAAC;IA4DJ,CAAC;IAjRQ,KAAK,CAAC,gBAAgB;QAC3B,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC;QACzC,IAAI,aAAwC,CAAC;QAE7C,IAAI,MAAM,IAAI,MAAM,CAAC,KAAK,CAAC,WAAW,KAAK,mBAAmB,CAAC,SAAS,EAAE,CAAC;YACzE,aAAa,GAAG;gBACd,WAAW,EAAE,mBAAmB,CAAC,SAAS;gBAC1C,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK;gBACvB,YAAY,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY;aACtC,CAAC;QACJ,CAAC;QAED,OAAO,aAAa,CAAC;IACvB,CAAC;IAED,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC;IAClC,CAAC;IAED,IAAW,QAAQ;QACjB,IAAI,aAAa,GAAG,KAAK,CAAC;QAC1B,IAAI,IAAI,CAAC,WAAW;YAClB,aAAa,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;QACpE,OAAO,aAAa,CAAC;IACvB,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAC5B,aAA4B,EAC5B,QAAc;QAEd,IAAI,IAAI,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC;YAC9B,MAAM,YAAY,GAAG,MAAM,aAAa,CAAC,uBAAuB,CAC9D,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,QAAQ,EAClC,QAAQ,CACT,CAAC;YACF,IAAI,CAAC,QAAQ,CAAC;gBACZ,KAAK,EAAE,QAAQ;gBACf,YAAY;aACb,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IA4Be,iBAAiB;QAC/B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QACvB,KAAK,IAAI,CAAC,iBAAiB,EAAE,CAAC;IAChC,CAAC;IAEe,oBAAoB;QAClC,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;IAC1B,CAAC;IAEe,kBAAkB,CAAC,SAA8B;QAC/D,IAAI,IAAI,CAAC,KAAK,CAAC,cAAc,KAAK,SAAS,CAAC,cAAc,EAAE,CAAC;YAC3D,KAAK,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAChC,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,iBAAiB;QAC7B,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC;QACzC,IAAI,YAA8B,CAAC;QACnC,IAAI,aAAwC,CAAC;QAC7C,IAAI,WAAoC,CAAC;QACzC,IAAI,mBAAmB,GAAG,oBAAoB,CAAC,IAAI,CAAC;QACpD,IAAI,SAAS,GAAG,KAAK,CAAC;QAEtB,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ;YAAE,WAAW,GAAG,WAAW,CAAC,KAAK,CAAC;QAEzD,IAAI,MAAM,IAAI,MAAM,CAAC,KAAK,CAAC,WAAW,KAAK,mBAAmB,CAAC,SAAS,EAAE,CAAC;YACzE,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,YAAY,IAAI;gBACpC,YAAY,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;iBACzC,IAAI,OAAO,MAAM,CAAC,KAAK,CAAC,KAAK,KAAK,QAAQ;gBAC7C,YAAY,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;iBACzC,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,KAAK,SAAS;gBAAE,YAAY,GAAG,IAAI,IAAI,EAAE,CAAC;YAErE,aAAa,GAAG,oBAAoB,CAAC,YAAY,CAC/C,MAAM,CAAC,QAAQ,CAAC,QAAQ,EACxB,MAAM,CAAC,QAAQ,CAAC,SAAS,EAAE,IAAI,CAChC,CAAC;YAEF,MAAM,OAAO,GAAG,MAAM,CAAC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;YACnD,IAAI,OAAO,EAAE,CAAC;gBACZ,IAAI,qBAAqB,IAAI,OAAO,EAAE,CAAC;oBACrC,IACE,yBAAyB,CAAC,sBAAsB,CAC9C,OAAO,CAAC,mBAAmB,CAC5B,EACD,CAAC;wBACD,WAAW,GAAG,WAAW,CAAC,KAAK,CAAC;wBAChC,mBAAmB,GAAG,OAAO,CAAC,mBAAmB,CAAC;oBACpD,CAAC;gBACH,CAAC;gBAED,IAAI,aAAa,IAAI,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;oBACpD,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;oBAClC,2DAA2D;oBAC3D,IACE,mBAAmB;wBACnB,WAAW,KAAK,WAAW,CAAC,KAAK;wBACjC,WAAW,KAAK,WAAW,CAAC,IAAI;wBAEhC,WAAW,GAAG,WAAW,CAAC,KAAK,CAAC;gBACpC,CAAC;gBAED,IAAI,mBAAmB,EAAE,CAAC;oBACxB,SAAS,GAAG,IAAI,CAAC;oBAEjB,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;wBACxB,IAAI,mBAAmB,KAAK,oBAAoB,CAAC,QAAQ,EAAE,CAAC;4BAC1D,mBAAmB,GAAG,oBAAoB,CAAC,WAAW,CAAC;wBACzD,CAAC;wBACD,IAAI,mBAAmB,KAAK,oBAAoB,CAAC,QAAQ,EAAE,CAAC;4BAC1D,mBAAmB,GAAG,oBAAoB,CAAC,WAAW,CAAC;wBACzD,CAAC;wBACD,IAAI,mBAAmB,KAAK,oBAAoB,CAAC,eAAe,EAAE,CAAC;4BACjE,mBAAmB,GAAG,oBAAoB,CAAC,kBAAkB,CAAC;wBAChE,CAAC;oBACH,CAAC;yBAAM,CAAC;wBACN,WAAW,GAAG,SAAS,CAAC;wBACxB,IAAI,mBAAmB,KAAK,oBAAoB,CAAC,WAAW;4BAC1D,mBAAmB,GAAG,oBAAoB,CAAC,QAAQ,CAAC;wBACtD,IAAI,mBAAmB,KAAK,oBAAoB,CAAC,WAAW;4BAC1D,mBAAmB,GAAG,oBAAoB,CAAC,QAAQ,CAAC;wBACtD,IAAI,mBAAmB,KAAK,oBAAoB,CAAC,kBAAkB;4BACjE,mBAAmB,GAAG,oBAAoB,CAAC,eAAe,CAAC;oBAC/D,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,WAAW,CAAC,CAAC;QAC/B,CAAC;QAED,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACvD,CAAC;QAED,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC;QACjD,MAAM,YAAY,GAAG,MAAM,aAAa,CAAC,uBAAuB,CAC9D,MAAO,CAAC,QAAQ,EAChB,YAAY,CACb,CAAC;QAEF,IAAI,IAAI,CAAC,UAAU;YACjB,IAAI,CAAC,QAAQ,CAAC;gBACZ,KAAK,EAAE,YAAY;gBACnB,UAAU;gBACV,WAAW;gBACX,aAAa;gBACb,YAAY;gBACZ,SAAS;aACV,CAAC,CAAC;IACP,CAAC;IAqCe,MAAM;QACpB,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS;YAC/B,CAAC,CAAC,oBAAoB,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC;YAC3C,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC;QACrB,MAAM,QAAQ,GAAa;YACzB,KAAK,EAAE,IAAI,CAAC,QAAQ,EAAE;YACtB,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE;YAC1B,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE;SAC3B,CAAC;QAEF,MAAM,SAAS,GAAG,UAAU,CAC1B,wBAAwB,EACxB,4BAA4B,EAC5B,IAAI,CAAC,KAAK,CAAC,SAAS,CACrB,CAAC;QAEF,OAAO,CACL,6BAAK,SAAS,EAAE,SAAS,EAAE,GAAG,EAAE,IAAI,CAAC,WAAW;YAC9C,oBAAC,WAAW,IACV,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY,EAC9B,OAAO,EAAE,IAAI,CAAC,YAAY,EAC1B,OAAO,EAAE,IAAI,CAAC,YAAY,EAC1B,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ;gBAE7B,oBAAC,YAAY;oBACX;wBACE,6BACE,SAAS,EAAC,6CAA6C,iBAC3C,6CAA6C;4BAEzD,oBAAC,UAAU,CAAC,8CAA8C;gCACxD,QAAQ,EAAE,IAAI,EACd,YAAY,EAAE,IAAI,CAAC,aAAa,EAChC,gBAAgB,EAAE,KAAK,GACvB;4BACD,IAAI,CAAC,KAAK,CAAC,WAAW,IAAI,CACzB,6BAAK,SAAS,EAAC,gBAAgB;gCAC7B,oBAAC,IAAI,IAAC,OAAO,EAAC,MAAM,EAAC,SAAS,EAAC,YAAY,IACxC,MAAM,CACF;gCACP,oBAAC,SAAS,IACR,IAAI,EAAE,QAAQ,EACd,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,WAAW,EACnC,YAAY,EAAE,IAAI,CAAC,iBAAiB,GACpC,CACE,CACP,CACG,CACL;oBACH,oBAAC,oBAAoB,IACnB,IAAI,EAAE,IAAI,CAAC,SAAS,EACpB,QAAQ,EAAE,IAAI,CAAC,aAAa,GAC5B,CACW,CACH,CACV,CACP,CAAC;IACJ,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,2BAA4B,SAAQ,kBAAkB;IACjE,IAAW,SAAS;QAClB,OAAO,oBAAC,cAAc,IAAC,QAAQ,EAAE,KAAK,GAAI,CAAC;IAC7C,CAAC;IACD,IAAoB,mBAAmB;QACrC,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,sBAAuB,SAAQ,kBAAkB;IAC5D,IAAW,SAAS;QAClB,OAAO,oBAAC,cAAc,IAAC,QAAQ,EAAE,IAAI,GAAI,CAAC;IAC5C,CAAC;IACD,IAAoB,mBAAmB;QACrC,OAAO,KAAK,CAAC;IACf,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 PropertyEditors\n */\n\nimport \"./DateTimeEditor.scss\";\nimport classnames from \"classnames\";\nimport * as React from \"react\";\nimport type { PropertyValue } from \"@itwin/appui-abstract\";\nimport {\n  AlternateDateFormats,\n  PropertyValueFormat,\n  TimeDisplay,\n} from \"@itwin/appui-abstract\";\nimport type { PropertyEditorProps, TypeEditor } from \"./EditorContainer.js\";\nimport { PropertyEditorBase } from \"./PropertyEditorManager.js\";\nimport {\n  PopupButton,\n  PopupContent,\n  PopupOkCancelButtons,\n} from \"./PopupButton.js\";\nimport type { TimeSpec } from \"../datepicker/TimeField.js\";\nimport { TimeField } from \"../datepicker/TimeField.js\";\nimport type { TypeConverter } from \"../converters/TypeConverter.js\";\nimport { DatePicker } from \"../datepicker/DatePicker.js\";\nimport { TypeConverterManager } from \"../converters/TypeConverterManager.js\";\nimport { DateTimeTypeConverterBase } from \"../converters/DateTimeTypeConverter.js\";\nimport { Text } from \"@itwin/itwinui-react\";\nimport { adjustDateToTimezone } from \"../common/DateUtils.js\";\n\n// cSpell:ignore datepicker\n\n/** @internal */\ninterface DateTimeEditorState {\n  value: Date;\n  displayValue?: string;\n  timeDisplay?: TimeDisplay;\n  isDisabled?: boolean;\n  typeConverter?: TypeConverter;\n  editInUtc: boolean;\n}\n\n/** @internal */\ninterface DateTimeEditorProps extends PropertyEditorProps {\n  showTime?: boolean;\n}\n\n/** DateTimeEditor React component that is a property editor for selection of date and time.\n * @internal\n */\nexport class DateTimeEditor\n  extends React.PureComponent<DateTimeEditorProps, DateTimeEditorState>\n  implements TypeEditor\n{\n  private _isMounted = false;\n  private _enterKey = false;\n  private _divElement = React.createRef<HTMLDivElement>();\n\n  public override readonly state: Readonly<DateTimeEditorState> = {\n    value: new Date(),\n    editInUtc: false,\n  };\n\n  public async getPropertyValue(): Promise<PropertyValue | undefined> {\n    const record = this.props.propertyRecord;\n    let propertyValue: PropertyValue | undefined;\n\n    if (record && record.value.valueFormat === PropertyValueFormat.Primitive) {\n      propertyValue = {\n        valueFormat: PropertyValueFormat.Primitive,\n        value: this.state.value,\n        displayValue: this.state.displayValue,\n      };\n    }\n\n    return propertyValue;\n  }\n\n  public get htmlElement(): HTMLElement | null {\n    return this._divElement.current;\n  }\n\n  public get hasFocus(): boolean {\n    let containsFocus = false;\n    if (this.htmlElement)\n      containsFocus = this.htmlElement.contains(document.activeElement);\n    return containsFocus;\n  }\n\n  public async processDateChange(\n    typeConverter: TypeConverter,\n    newValue: Date\n  ): Promise<void> {\n    if (this.props.propertyRecord) {\n      const displayValue = await typeConverter.convertPropertyToString(\n        this.props.propertyRecord.property,\n        newValue\n      );\n      this.setState({\n        value: newValue,\n        displayValue,\n      });\n    }\n  }\n\n  private _handleChange = (newValue: Date): void => {\n    if (this._isMounted && this.state.typeConverter) {\n      if (this.state.editInUtc) {\n        newValue = adjustDateToTimezone(\n          newValue,\n          newValue.getTimezoneOffset() * -1\n        );\n      }\n\n      void this.processDateChange(this.state.typeConverter, newValue);\n    }\n  };\n\n  private _handleTimeChange = (time: TimeSpec): void => {\n    // Combine new time into selected Date\n    if (this.state.editInUtc) {\n      const newWorkingDate = adjustDateToTimezone(this.state.value, 0);\n      newWorkingDate.setUTCHours(time.hours, time.minutes, time.seconds);\n      this._handleChange(newWorkingDate);\n    } else {\n      const newWorkingDate = new Date(this.state.value.getTime());\n      newWorkingDate.setHours(time.hours, time.minutes, time.seconds);\n      this._handleChange(newWorkingDate);\n    }\n  };\n\n  public override componentDidMount() {\n    this._isMounted = true;\n    void this.setStateFromProps();\n  }\n\n  public override componentWillUnmount() {\n    this._isMounted = false;\n  }\n\n  public override componentDidUpdate(prevProps: PropertyEditorProps) {\n    if (this.props.propertyRecord !== prevProps.propertyRecord) {\n      void this.setStateFromProps();\n    }\n  }\n\n  private async setStateFromProps() {\n    const record = this.props.propertyRecord;\n    let initialValue: Date | undefined;\n    let typeConverter: TypeConverter | undefined;\n    let timeDisplay: TimeDisplay | undefined;\n    let alternateDateFormat = AlternateDateFormats.None;\n    let editInUtc = false;\n\n    if (this.props.showTime) timeDisplay = TimeDisplay.H12MC;\n\n    if (record && record.value.valueFormat === PropertyValueFormat.Primitive) {\n      if (record.value.value instanceof Date)\n        initialValue = new Date(record.value.value);\n      else if (typeof record.value.value === \"string\")\n        initialValue = new Date(record.value.value);\n      else if (record.value.value === undefined) initialValue = new Date();\n\n      typeConverter = TypeConverterManager.getConverter(\n        record.property.typename,\n        record.property.converter?.name\n      );\n\n      const options = record.property.converter?.options;\n      if (options) {\n        if (\"alternateDateFormat\" in options) {\n          if (\n            DateTimeTypeConverterBase.isAlternateDateFormats(\n              options.alternateDateFormat\n            )\n          ) {\n            timeDisplay = TimeDisplay.H24MS;\n            alternateDateFormat = options.alternateDateFormat;\n          }\n        }\n\n        if (\"timeDisplay\" in options && this.props.showTime) {\n          timeDisplay = options.timeDisplay;\n          // use 24 hr time display if alternateDateFormat is defined\n          if (\n            alternateDateFormat &&\n            timeDisplay !== TimeDisplay.H24MS &&\n            timeDisplay !== TimeDisplay.H24M\n          )\n            timeDisplay = TimeDisplay.H24MS;\n        }\n\n        if (alternateDateFormat) {\n          editInUtc = true;\n\n          if (this.props.showTime) {\n            if (alternateDateFormat === AlternateDateFormats.IsoShort) {\n              alternateDateFormat = AlternateDateFormats.IsoDateTime;\n            }\n            if (alternateDateFormat === AlternateDateFormats.UtcShort) {\n              alternateDateFormat = AlternateDateFormats.UtcDateTime;\n            }\n            if (alternateDateFormat === AlternateDateFormats.UtcShortWithDay) {\n              alternateDateFormat = AlternateDateFormats.UtcDateTimeWithDay;\n            }\n          } else {\n            timeDisplay = undefined;\n            if (alternateDateFormat === AlternateDateFormats.IsoDateTime)\n              alternateDateFormat = AlternateDateFormats.IsoShort;\n            if (alternateDateFormat === AlternateDateFormats.UtcDateTime)\n              alternateDateFormat = AlternateDateFormats.UtcShort;\n            if (alternateDateFormat === AlternateDateFormats.UtcDateTimeWithDay)\n              alternateDateFormat = AlternateDateFormats.UtcShortWithDay;\n          }\n        }\n      }\n    }\n\n    if (!initialValue) {\n      throw new Error(\"Bad Value\");\n    }\n\n    if (!typeConverter) {\n      throw new Error(\"Unable to determine TypeConverter\");\n    }\n\n    const isDisabled = record && !!record.isDisabled;\n    const displayValue = await typeConverter.convertPropertyToString(\n      record!.property,\n      initialValue\n    );\n\n    if (this._isMounted)\n      this.setState({\n        value: initialValue,\n        isDisabled,\n        timeDisplay,\n        typeConverter,\n        displayValue,\n        editInUtc,\n      });\n  }\n\n  private _handleEnter = async (): Promise<void> => {\n    this._enterKey = true;\n    await this._handleCommit();\n  };\n\n  private _handleClose = async (): Promise<void> => {\n    if (this._enterKey) {\n      this._enterKey = false;\n    } else {\n      if (this.props.onCancel) this.props.onCancel();\n    }\n  };\n\n  private _handleOk = async (_event: React.MouseEvent): Promise<void> => {\n    await this._handleCommit();\n  };\n\n  private _handleCancel = (_event: React.MouseEvent): void => {\n    if (this.props.onCancel) {\n      this.props.onCancel();\n    }\n  };\n\n  private _handleCommit = async (): Promise<void> => {\n    if (this.props.propertyRecord && this.props.onCommit) {\n      const propertyValue = await this.getPropertyValue();\n      if (propertyValue !== undefined) {\n        this.props.onCommit({\n          propertyRecord: this.props.propertyRecord,\n          newValue: propertyValue,\n        });\n      }\n    }\n  };\n\n  public override render(): React.ReactNode {\n    const date = this.state.editInUtc\n      ? adjustDateToTimezone(this.state.value, 0)\n      : this.state.value;\n    const timeSpec: TimeSpec = {\n      hours: date.getHours(),\n      minutes: date.getMinutes(),\n      seconds: date.getSeconds(),\n    };\n\n    const className = classnames(\n      \"components-cell-editor\",\n      \"components-datetime-editor\",\n      this.props.className\n    );\n\n    return (\n      <div className={className} ref={this._divElement}>\n        <PopupButton\n          label={this.state.displayValue}\n          onClose={this._handleClose}\n          onEnter={this._handleEnter}\n          setFocus={this.props.setFocus}\n        >\n          <PopupContent>\n            <>\n              <div\n                className=\"components-date-picker-calendar-popup-panel\"\n                data-testid=\"components-date-picker-calendar-popup-panel\"\n              >\n                <DatePicker // eslint-disable-line deprecation/deprecation\n                  selected={date}\n                  onDateChange={this._handleChange}\n                  showFocusOutline={false}\n                />\n                {this.state.timeDisplay && (\n                  <div className=\"time-container\">\n                    <Text variant=\"body\" className=\"time-label\">\n                      {\"Time\"}\n                    </Text>\n                    <TimeField\n                      time={timeSpec}\n                      timeDisplay={this.state.timeDisplay}\n                      onTimeChange={this._handleTimeChange}\n                    />\n                  </div>\n                )}\n              </div>\n            </>\n            <PopupOkCancelButtons\n              onOk={this._handleOk}\n              onCancel={this._handleCancel}\n            />\n          </PopupContent>\n        </PopupButton>\n      </div>\n    );\n  }\n}\n\n/** DateTime Property Editor registered for the \"number\" type name and \"DateTime\" editor name.\n * It uses the [[DateTimeEditor]] React component.\n * @internal\n */\nexport class ShortDateTimePropertyEditor extends PropertyEditorBase {\n  public get reactNode(): React.ReactNode {\n    return <DateTimeEditor showTime={false} />;\n  }\n  public override get containerHandlesTab(): boolean {\n    return false;\n  }\n}\n\n/** DateTime Property Editor registered for the \"number\" type name and \"DateTime\" editor name.\n * It uses the [[DateTimeEditor]] React component.\n * @internal\n */\nexport class DateTimePropertyEditor extends PropertyEditorBase {\n  public get reactNode(): React.ReactNode {\n    return <DateTimeEditor showTime={true} />;\n  }\n  public override get containerHandlesTab(): boolean {\n    return false;\n  }\n}\n"]}

package/lib/components-react/editors/EditorContainer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EditorContainer.d.ts","sourceRoot":"","sources":["../../../src/components-react/editors/EditorContainer.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,wBAAwB,CAAC;AAChC,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,KAAK,EAGV,cAAc,EACd,aAAa,EACd,MAAM,uBAAuB,CAAC;AAE/B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAOrD;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,kCAAkC;IAClC,cAAc,EAAE,cAAc,CAAC;IAC/B,sCAAsC;IACtC,QAAQ,EAAE,aAAa,CAAC;CACzB;AAED;;GAEG;AAEH,MAAM,WAAW,mBAAoB,SAAQ,WAAW;IACtD,kCAAkC;IAClC,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,yBAAyB;IACzB,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,mBAAmB,KAAK,IAAI,CAAC;IAC/C,yBAAyB;IACzB,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAC;IACtB,uBAAuB;IACvB,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,KAAK,IAAI,CAAC;IAC3C,6DAA6D;IAC7D,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED;;;GAGG;AAEH,MAAM,WAAW,oBAAqB,SAAQ,WAAW;IACvD,kCAAkC;IAClC,cAAc,EAAE,cAAc,CAAC;IAC/B,mBAAmB;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,yBAAyB;IACzB,QAAQ,EAAE,CAAC,IAAI,EAAE,mBAAmB,KAAK,IAAI,CAAC;IAC9C,yBAAyB;IACzB,QAAQ,EAAE,MAAM,IAAI,CAAC;IACrB,6DAA6D;IAC7D,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB,gBAAgB;IAChB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;;OAGG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC;AAMD;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,gBAAgB,EAAE,MAAM,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC,CAAC;IAC3D,WAAW,EAAE,WAAW,GAAG,IAAI,CAAC;IAChC,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AAEH,wBAAgB,eAAe,CAAC,KAAK,EAAE,oBAAoB,qBAmL1D"}

package/lib/components-react/editors/EditorContainer.js

@@ -0,0 +1,204 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module PropertyEditors
+ */
+import "./EditorContainer.scss";
+import * as React from "react";
+import { Key } from "ts-key-enum";
+import { PropertyValueFormat, UiAdmin } from "@itwin/appui-abstract";
+import { PropertyEditorManager } from "./PropertyEditorManager.js";
+/** EditorContainer React component used by the Tree and PropertyGrid for cell editing.
+ * @public
+ */
+// eslint-disable-next-line deprecation/deprecation
+export function EditorContainer(props) {
+    const { ignoreEditorBlur, title, shouldCommitOnChange, propertyRecord, setFocus, onCommit, onCancel, ...rest } = props;
+    const editorRef = React.useRef();
+    const propertyEditorRef = React.useRef();
+    const handleClick = (e) => e.stopPropagation();
+    const handleContainerBlur = (e) => e.stopPropagation();
+    const handleEditorCommit = (args) => void commit(args);
+    const handleContainerCommit = async () => {
+        const newValue = editorRef && (await editorRef.current?.getPropertyValue());
+        if (newValue === undefined)
+            return;
+        void commit({
+            propertyRecord,
+            newValue,
+        });
+    };
+    const onPressEscape = (e) => {
+        if (!propertyEditorRef.current?.containerHandlesEscape)
+            return;
+        e.stopPropagation();
+        onCancel();
+    };
+    const onPressEnter = (e) => {
+        if (!propertyEditorRef.current?.containerHandlesEnter)
+            return;
+        if (editorRef?.current?.hasFocus)
+            e.stopPropagation();
+        void handleContainerCommit();
+    };
+    const onPressTab = (e) => {
+        if (!propertyEditorRef.current?.containerHandlesTab)
+            return;
+        e.stopPropagation();
+        e.preventDefault();
+        void handleContainerCommit();
+    };
+    const handleKeyDown = (e) => {
+        switch (e.key) {
+            case Key.Escape.valueOf():
+                onPressEscape(e);
+                break;
+            case Key.Enter.valueOf():
+                onPressEnter(e);
+                break;
+            case Key.Tab.valueOf():
+                onPressTab(e);
+                break;
+            default:
+                if (propertyEditorRef.current?.containerStopsKeydownPropagation)
+                    e.stopPropagation();
+        }
+    };
+    const handleEditorBlur = () => {
+        if (ignoreEditorBlur)
+            return;
+        if (!propertyEditorRef.current?.containerHandlesBlur)
+            return;
+        void handleContainerCommit();
+    };
+    const isNewValueValid = async (value) => {
+        if (!propertyEditorRef.current)
+            return false;
+        if (!propertyRecord)
+            return false;
+        const validateResult = await propertyEditorRef.current.validateValue(value, propertyRecord);
+        if (validateResult.encounteredError) {
+            displayOutputMessage(validateResult.errorMessage);
+            return false;
+        }
+        return true;
+    };
+    const displayOutputMessage = (errorMessage) => {
+        if (!errorMessage)
+            return;
+        if (!editorRef)
+            return;
+        const htmlElement = editorRef.current?.htmlElement;
+        if (htmlElement)
+            UiAdmin.messagePresenter.displayInputFieldMessage(htmlElement, errorMessage.severity, errorMessage.briefMessage, errorMessage.detailedMessage);
+        else
+            UiAdmin.messagePresenter.displayMessage(errorMessage.severity, errorMessage.briefMessage, errorMessage.detailedMessage, errorMessage.messageType);
+    };
+    const commit = async (args) => {
+        const oldValue = args.propertyRecord.value;
+        const newValue = args.newValue;
+        if (!shouldCommit(oldValue, newValue)) {
+            return;
+        }
+        const isValid = await isNewValueValid(newValue);
+        if (!isValid)
+            return;
+        if (propertyEditorRef.current && args.propertyRecord) {
+            const commitResult = await propertyEditorRef.current.commitValue(newValue, args.propertyRecord);
+            if (commitResult.encounteredError) {
+                displayOutputMessage(commitResult.errorMessage);
+                return;
+            }
+        }
+        onCommit(args);
+    };
+    const editorProps = {
+        ref: (ref) => {
+            editorRef.current = ref ?? undefined;
+        },
+        onCommit: handleEditorCommit,
+        onCancel,
+        onBlur: handleEditorBlur,
+        setFocus: setFocus !== undefined ? setFocus : true,
+        propertyRecord,
+        shouldCommitOnChange,
+        ...rest,
+    };
+    const propDescription = propertyRecord.property;
+    const editorName = propDescription.editor !== undefined
+        ? propDescription.editor.name
+        : undefined;
+    propertyEditorRef.current = PropertyEditorManager.createEditor(propDescription.typename, editorName, propDescription.dataController);
+    const clonedNode = React.isValidElement(propertyEditorRef.current.reactNode)
+        ? React.cloneElement(propertyEditorRef.current.reactNode, editorProps)
+        : undefined;
+    return (React.createElement("span", { className: "components-editor-container", onBlur: handleContainerBlur, onKeyDown: handleKeyDown, onClick: handleClick, onContextMenu: handleClick, title: title, "data-testid": "editor-container", role: "presentation" }, clonedNode));
+}
+function arePrimitiveValuesEqual(oldValue, newValue) {
+    if (typeof oldValue !== typeof newValue) {
+        return false;
+    }
+    // directly compare simple types
+    if (typeof newValue !== "object" || newValue instanceof Date) {
+        return newValue === oldValue;
+    }
+    // compare all members of arrays
+    if (newValue instanceof Array) {
+        if (!(oldValue instanceof Array)) {
+            return false;
+        }
+        if (newValue.length !== oldValue.length) {
+            return false;
+        }
+        for (let i = 0; i < newValue.length; i++) {
+            if (oldValue[i] !== newValue[i]) {
+                return false;
+            }
+        }
+        return true;
+    }
+    // compare `Point2d` and `Point3d` types
+    if ("x" in newValue) {
+        if (typeof oldValue !== "object" || !("x" in oldValue)) {
+            return false;
+        }
+        if ("z" in newValue) {
+            if (!("z" in oldValue)) {
+                return false;
+            }
+            return (newValue.x === oldValue.x &&
+                newValue.y === oldValue.y &&
+                newValue.z === oldValue.z);
+        }
+        else if ("z" in oldValue) {
+            return false;
+        }
+        return newValue.x === oldValue.x && newValue.y === oldValue.y;
+    }
+    // compare instance keys
+    if ("className" in newValue) {
+        if (typeof oldValue !== "object" || !("className" in oldValue)) {
+            return false;
+        }
+        return (oldValue.className === newValue.className && oldValue.id === newValue.id);
+    }
+    return false;
+}
+function shouldCommit(oldValue, newValue) {
+    if (oldValue.valueFormat !== newValue.valueFormat ||
+        newValue.valueFormat !== PropertyValueFormat.Primitive) {
+        return true;
+    }
+    const oldPrimitiveValue = oldValue;
+    if (!oldPrimitiveValue.value && !newValue.value) {
+        return false;
+    }
+    if ((!oldPrimitiveValue.value && newValue.value) ||
+        (oldPrimitiveValue.value && !newValue.value)) {
+        return true;
+    }
+    return !arePrimitiveValuesEqual(oldPrimitiveValue.value, newValue.value);
+}
+//# sourceMappingURL=EditorContainer.js.map

package/lib/components-react/editors/EditorContainer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EditorContainer.js","sourceRoot":"","sources":["../../../src/components-react/editors/EditorContainer.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,wBAAwB,CAAC;AAChC,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,GAAG,EAAE,MAAM,aAAa,CAAC;AAOlC,OAAO,EAAE,mBAAmB,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAMrE,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAyEnE;;GAEG;AACH,mDAAmD;AACnD,MAAM,UAAU,eAAe,CAAC,KAA2B;IACzD,MAAM,EACJ,gBAAgB,EAChB,KAAK,EACL,oBAAoB,EACpB,cAAc,EACd,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,GAAG,IAAI,EACR,GAAG,KAAK,CAAC;IAEV,MAAM,SAAS,GAAG,KAAK,CAAC,MAAM,EAA0B,CAAC;IACzD,MAAM,iBAAiB,GAAG,KAAK,CAAC,MAAM,EAAkC,CAAC;IAEzE,MAAM,WAAW,GAAG,CAAC,CAAmB,EAAE,EAAE,CAAC,CAAC,CAAC,eAAe,EAAE,CAAC;IACjE,MAAM,mBAAmB,GAAG,CAAC,CAAmB,EAAE,EAAE,CAAC,CAAC,CAAC,eAAe,EAAE,CAAC;IACzE,MAAM,kBAAkB,GAAG,CAAC,IAAyB,EAAE,EAAE,CAAC,KAAK,MAAM,CAAC,IAAI,CAAC,CAAC;IAE5E,MAAM,qBAAqB,GAAG,KAAK,IAAI,EAAE;QACvC,MAAM,QAAQ,GAAG,SAAS,IAAI,CAAC,MAAM,SAAS,CAAC,OAAO,EAAE,gBAAgB,EAAE,CAAC,CAAC;QAC5E,IAAI,QAAQ,KAAK,SAAS;YAAE,OAAO;QACnC,KAAK,MAAM,CAAC;YACV,cAAc;YACd,QAAQ;SACT,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,MAAM,aAAa,GAAG,CAAC,CAAsB,EAAE,EAAE;QAC/C,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,sBAAsB;YAAE,OAAO;QAC/D,CAAC,CAAC,eAAe,EAAE,CAAC;QACpB,QAAQ,EAAE,CAAC;IACb,CAAC,CAAC;IAEF,MAAM,YAAY,GAAG,CAAC,CAAsB,EAAE,EAAE;QAC9C,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,qBAAqB;YAAE,OAAO;QAC9D,IAAI,SAAS,EAAE,OAAO,EAAE,QAAQ;YAAE,CAAC,CAAC,eAAe,EAAE,CAAC;QACtD,KAAK,qBAAqB,EAAE,CAAC;IAC/B,CAAC,CAAC;IAEF,MAAM,UAAU,GAAG,CAAC,CAAsB,EAAE,EAAE;QAC5C,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,mBAAmB;YAAE,OAAO;QAC5D,CAAC,CAAC,eAAe,EAAE,CAAC;QACpB,CAAC,CAAC,cAAc,EAAE,CAAC;QACnB,KAAK,qBAAqB,EAAE,CAAC;IAC/B,CAAC,CAAC;IAEF,MAAM,aAAa,GAAG,CAAC,CAAsB,EAAE,EAAE;QAC/C,QAAQ,CAAC,CAAC,GAAG,EAAE,CAAC;YACd,KAAK,GAAG,CAAC,MAAM,CAAC,OAAO,EAAE;gBACvB,aAAa,CAAC,CAAC,CAAC,CAAC;gBACjB,MAAM;YACR,KAAK,GAAG,CAAC,KAAK,CAAC,OAAO,EAAE;gBACtB,YAAY,CAAC,CAAC,CAAC,CAAC;gBAChB,MAAM;YACR,KAAK,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE;gBACpB,UAAU,CAAC,CAAC,CAAC,CAAC;gBACd,MAAM;YACR;gBACE,IAAI,iBAAiB,CAAC,OAAO,EAAE,gCAAgC;oBAC7D,CAAC,CAAC,eAAe,EAAE,CAAC;QAC1B,CAAC;IACH,CAAC,CAAC;IAEF,MAAM,gBAAgB,GAAG,GAAG,EAAE;QAC5B,IAAI,gBAAgB;YAAE,OAAO;QAC7B,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,oBAAoB;YAAE,OAAO;QAC7D,KAAK,qBAAqB,EAAE,CAAC;IAC/B,CAAC,CAAC;IAEF,MAAM,eAAe,GAAG,KAAK,EAAE,KAAoB,EAAE,EAAE;QACrD,IAAI,CAAC,iBAAiB,CAAC,OAAO;YAAE,OAAO,KAAK,CAAC;QAC7C,IAAI,CAAC,cAAc;YAAE,OAAO,KAAK,CAAC;QAElC,MAAM,cAAc,GAAG,MAAM,iBAAiB,CAAC,OAAO,CAAC,aAAa,CAClE,KAAK,EACL,cAAc,CACf,CAAC;QAEF,IAAI,cAAc,CAAC,gBAAgB,EAAE,CAAC;YACpC,oBAAoB,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC;YAClD,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;IAEF,MAAM,oBAAoB,GAAG,CAC3B,YAA2C,EAC3C,EAAE;QACF,IAAI,CAAC,YAAY;YAAE,OAAO;QAC1B,IAAI,CAAC,SAAS;YAAE,OAAO;QAEvB,MAAM,WAAW,GAAG,SAAS,CAAC,OAAO,EAAE,WAAW,CAAC;QACnD,IAAI,WAAW;YACb,OAAO,CAAC,gBAAgB,CAAC,wBAAwB,CAC/C,WAAW,EACX,YAAY,CAAC,QAAQ,EACrB,YAAY,CAAC,YAAY,EACzB,YAAY,CAAC,eAAe,CAC7B,CAAC;;YAEF,OAAO,CAAC,gBAAgB,CAAC,cAAc,CACrC,YAAY,CAAC,QAAQ,EACrB,YAAY,CAAC,YAAY,EACzB,YAAY,CAAC,eAAe,EAC5B,YAAY,CAAC,WAAW,CACzB,CAAC;IACN,CAAC,CAAC;IAEF,MAAM,MAAM,GAAG,KAAK,EAAE,IAAyB,EAAE,EAAE;QACjD,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC;QAC3C,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAE/B,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,CAAC;YACtC,OAAO;QACT,CAAC;QAED,MAAM,OAAO,GAAG,MAAM,eAAe,CAAC,QAAQ,CAAC,CAAC;QAChD,IAAI,CAAC,OAAO;YAAE,OAAO;QAErB,IAAI,iBAAiB,CAAC,OAAO,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACrD,MAAM,YAAY,GAAG,MAAM,iBAAiB,CAAC,OAAO,CAAC,WAAW,CAC9D,QAAQ,EACR,IAAI,CAAC,cAAc,CACpB,CAAC;YACF,IAAI,YAAY,CAAC,gBAAgB,EAAE,CAAC;gBAClC,oBAAoB,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;gBAChD,OAAO;YACT,CAAC;QACH,CAAC;QAED,QAAQ,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC,CAAC;IAEF,MAAM,WAAW,GAAe;QAC9B,GAAG,EAAE,CAAC,GAAG,EAAE,EAAE;YACX,SAAS,CAAC,OAAO,GAAG,GAAG,IAAI,SAAS,CAAC;QACvC,CAAC;QACD,QAAQ,EAAE,kBAAkB;QAC5B,QAAQ;QACR,MAAM,EAAE,gBAAgB;QACxB,QAAQ,EAAE,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI;QAClD,cAAc;QACd,oBAAoB;QACpB,GAAG,IAAI;KACR,CAAC;IAEF,MAAM,eAAe,GAAG,cAAc,CAAC,QAAQ,CAAC;IAEhD,MAAM,UAAU,GACd,eAAe,CAAC,MAAM,KAAK,SAAS;QAClC,CAAC,CAAC,eAAe,CAAC,MAAM,CAAC,IAAI;QAC7B,CAAC,CAAC,SAAS,CAAC;IAEhB,iBAAiB,CAAC,OAAO,GAAG,qBAAqB,CAAC,YAAY,CAC5D,eAAe,CAAC,QAAQ,EACxB,UAAU,EACV,eAAe,CAAC,cAAc,CAC/B,CAAC;IAEF,MAAM,UAAU,GAAG,KAAK,CAAC,cAAc,CAAC,iBAAiB,CAAC,OAAO,CAAC,SAAS,CAAC;QAC1E,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,iBAAiB,CAAC,OAAO,CAAC,SAAS,EAAE,WAAW,CAAC;QACtE,CAAC,CAAC,SAAS,CAAC;IAEd,OAAO,CACL,8BACE,SAAS,EAAC,6BAA6B,EACvC,MAAM,EAAE,mBAAmB,EAC3B,SAAS,EAAE,aAAa,EACxB,OAAO,EAAE,WAAW,EACpB,aAAa,EAAE,WAAW,EAC1B,KAAK,EAAE,KAAK,iBACA,kBAAkB,EAC9B,IAAI,EAAC,cAAc,IAElB,UAAU,CACN,CACR,CAAC;AACJ,CAAC;AAED,SAAS,uBAAuB,CAC9B,QAA0B,EAC1B,QAA0B;IAE1B,IAAI,OAAO,QAAQ,KAAK,OAAO,QAAQ,EAAE,CAAC;QACxC,OAAO,KAAK,CAAC;IACf,CAAC;IACD,gCAAgC;IAChC,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,YAAY,IAAI,EAAE,CAAC;QAC7D,OAAO,QAAQ,KAAK,QAAQ,CAAC;IAC/B,CAAC;IACD,gCAAgC;IAChC,IAAI,QAAQ,YAAY,KAAK,EAAE,CAAC;QAC9B,IAAI,CAAC,CAAC,QAAQ,YAAY,KAAK,CAAC,EAAE,CAAC;YACjC,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IAAI,QAAQ,CAAC,MAAM,KAAK,QAAQ,CAAC,MAAM,EAAE,CAAC;YACxC,OAAO,KAAK,CAAC;QACf,CAAC;QACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACzC,IAAI,QAAQ,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;gBAChC,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IACD,wCAAwC;IACxC,IAAI,GAAG,IAAI,QAAQ,EAAE,CAAC;QACpB,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,CAAC,CAAC,GAAG,IAAI,QAAQ,CAAC,EAAE,CAAC;YACvD,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IAAI,GAAG,IAAI,QAAQ,EAAE,CAAC;YACpB,IAAI,CAAC,CAAC,GAAG,IAAI,QAAQ,CAAC,EAAE,CAAC;gBACvB,OAAO,KAAK,CAAC;YACf,CAAC;YACD,OAAO,CACL,QAAQ,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAC;gBACzB,QAAQ,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAC;gBACzB,QAAQ,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAC,CAC1B,CAAC;QACJ,CAAC;aAAM,IAAI,GAAG,IAAI,QAAQ,EAAE,CAAC;YAC3B,OAAO,KAAK,CAAC;QACf,CAAC;QACD,OAAO,QAAQ,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAC,IAAI,QAAQ,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC;IAChE,CAAC;IACD,wBAAwB;IACxB,IAAI,WAAW,IAAI,QAAQ,EAAE,CAAC;QAC5B,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,CAAC,CAAC,WAAW,IAAI,QAAQ,CAAC,EAAE,CAAC;YAC/D,OAAO,KAAK,CAAC;QACf,CAAC;QACD,OAAO,CACL,QAAQ,CAAC,SAAS,KAAK,QAAQ,CAAC,SAAS,IAAI,QAAQ,CAAC,EAAE,KAAK,QAAQ,CAAC,EAAE,CACzE,CAAC;IACJ,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,YAAY,CAAC,QAAuB,EAAE,QAAuB;IACpE,IACE,QAAQ,CAAC,WAAW,KAAK,QAAQ,CAAC,WAAW;QAC7C,QAAQ,CAAC,WAAW,KAAK,mBAAmB,CAAC,SAAS,EACtD,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,iBAAiB,GAAG,QAA0B,CAAC;IACrD,IAAI,CAAC,iBAAiB,CAAC,KAAK,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;QAChD,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IACE,CAAC,CAAC,iBAAiB,CAAC,KAAK,IAAI,QAAQ,CAAC,KAAK,CAAC;QAC5C,CAAC,iBAAiB,CAAC,KAAK,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAC5C,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,CAAC,uBAAuB,CAAC,iBAAiB,CAAC,KAAM,EAAE,QAAQ,CAAC,KAAM,CAAC,CAAC;AAC7E,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 PropertyEditors\n */\n\nimport \"./EditorContainer.scss\";\nimport * as React from \"react\";\nimport { Key } from \"ts-key-enum\";\nimport type {\n  Primitives,\n  PrimitiveValue,\n  PropertyRecord,\n  PropertyValue,\n} from \"@itwin/appui-abstract\";\nimport { PropertyValueFormat, UiAdmin } from \"@itwin/appui-abstract\";\nimport type { CommonProps } from \"@itwin/core-react\";\nimport type {\n  AsyncErrorMessage,\n  PropertyEditorBase,\n} from \"./PropertyEditorManager.js\";\nimport { PropertyEditorManager } from \"./PropertyEditorManager.js\";\n\n/** Arguments for the Property Updated event callback\n * @public\n */\nexport interface PropertyUpdatedArgs {\n  /** The property being updated. */\n  propertyRecord: PropertyRecord;\n  /** The new value for the property. */\n  newValue: PropertyValue;\n}\n\n/** Properties for a property editor component\n * @public\n */\n// eslint-disable-next-line deprecation/deprecation\nexport interface PropertyEditorProps extends CommonProps {\n  /** The property being updated. */\n  propertyRecord?: PropertyRecord;\n  /** Handler for commit */\n  onCommit?: (args: PropertyUpdatedArgs) => void;\n  /** Handler for cancel */\n  onCancel?: () => void;\n  /** Handler for blur */\n  onBlur?: (event: React.FocusEvent) => void;\n  /** Indicates whether the Property Editor should set focus */\n  setFocus?: boolean;\n  /**\n   * Indicates whether value change should call onCommit().\n   * @internal\n   */\n  shouldCommitOnChange?: boolean;\n}\n\n/** [[EditorContainer]] React component properties\n * @public\n * @deprecated in 4.17.0. Use `React.ComponentProps<typeof EditorContainer>`\n */\n// eslint-disable-next-line deprecation/deprecation\nexport interface EditorContainerProps extends CommonProps {\n  /** The property being updated. */\n  propertyRecord: PropertyRecord;\n  /** Tooltip text */\n  title?: string;\n  /** Handler for commit */\n  onCommit: (args: PropertyUpdatedArgs) => void;\n  /** Handler for cancel */\n  onCancel: () => void;\n  /** Indicates whether the Property Editor should set focus */\n  setFocus?: boolean;\n\n  /** @internal */\n  ignoreEditorBlur?: boolean;\n  /**\n   * Indicates whether value change should call onCommit().\n   * @internal\n   */\n  shouldCommitOnChange?: boolean;\n}\n\ninterface CloneProps extends PropertyEditorProps {\n  ref: (ref: TypeEditor | null) => void;\n}\n\n/** Interface implemented by React based type editors\n * @public\n */\nexport interface TypeEditor {\n  getPropertyValue: () => Promise<PropertyValue | undefined>;\n  htmlElement: HTMLElement | null;\n  hasFocus: boolean;\n}\n\n/** EditorContainer React component used by the Tree and PropertyGrid for cell editing.\n * @public\n */\n// eslint-disable-next-line deprecation/deprecation\nexport function EditorContainer(props: EditorContainerProps) {\n  const {\n    ignoreEditorBlur,\n    title,\n    shouldCommitOnChange,\n    propertyRecord,\n    setFocus,\n    onCommit,\n    onCancel,\n    ...rest\n  } = props;\n\n  const editorRef = React.useRef<TypeEditor | undefined>();\n  const propertyEditorRef = React.useRef<PropertyEditorBase | undefined>();\n\n  const handleClick = (e: React.MouseEvent) => e.stopPropagation();\n  const handleContainerBlur = (e: React.FocusEvent) => e.stopPropagation();\n  const handleEditorCommit = (args: PropertyUpdatedArgs) => void commit(args);\n\n  const handleContainerCommit = async () => {\n    const newValue = editorRef && (await editorRef.current?.getPropertyValue());\n    if (newValue === undefined) return;\n    void commit({\n      propertyRecord,\n      newValue,\n    });\n  };\n\n  const onPressEscape = (e: React.KeyboardEvent) => {\n    if (!propertyEditorRef.current?.containerHandlesEscape) return;\n    e.stopPropagation();\n    onCancel();\n  };\n\n  const onPressEnter = (e: React.KeyboardEvent) => {\n    if (!propertyEditorRef.current?.containerHandlesEnter) return;\n    if (editorRef?.current?.hasFocus) e.stopPropagation();\n    void handleContainerCommit();\n  };\n\n  const onPressTab = (e: React.KeyboardEvent) => {\n    if (!propertyEditorRef.current?.containerHandlesTab) return;\n    e.stopPropagation();\n    e.preventDefault();\n    void handleContainerCommit();\n  };\n\n  const handleKeyDown = (e: React.KeyboardEvent) => {\n    switch (e.key) {\n      case Key.Escape.valueOf():\n        onPressEscape(e);\n        break;\n      case Key.Enter.valueOf():\n        onPressEnter(e);\n        break;\n      case Key.Tab.valueOf():\n        onPressTab(e);\n        break;\n      default:\n        if (propertyEditorRef.current?.containerStopsKeydownPropagation)\n          e.stopPropagation();\n    }\n  };\n\n  const handleEditorBlur = () => {\n    if (ignoreEditorBlur) return;\n    if (!propertyEditorRef.current?.containerHandlesBlur) return;\n    void handleContainerCommit();\n  };\n\n  const isNewValueValid = async (value: PropertyValue) => {\n    if (!propertyEditorRef.current) return false;\n    if (!propertyRecord) return false;\n\n    const validateResult = await propertyEditorRef.current.validateValue(\n      value,\n      propertyRecord\n    );\n\n    if (validateResult.encounteredError) {\n      displayOutputMessage(validateResult.errorMessage);\n      return false;\n    }\n\n    return true;\n  };\n\n  const displayOutputMessage = (\n    errorMessage: AsyncErrorMessage | undefined\n  ) => {\n    if (!errorMessage) return;\n    if (!editorRef) return;\n\n    const htmlElement = editorRef.current?.htmlElement;\n    if (htmlElement)\n      UiAdmin.messagePresenter.displayInputFieldMessage(\n        htmlElement,\n        errorMessage.severity,\n        errorMessage.briefMessage,\n        errorMessage.detailedMessage\n      );\n    else\n      UiAdmin.messagePresenter.displayMessage(\n        errorMessage.severity,\n        errorMessage.briefMessage,\n        errorMessage.detailedMessage,\n        errorMessage.messageType\n      );\n  };\n\n  const commit = async (args: PropertyUpdatedArgs) => {\n    const oldValue = args.propertyRecord.value;\n    const newValue = args.newValue;\n\n    if (!shouldCommit(oldValue, newValue)) {\n      return;\n    }\n\n    const isValid = await isNewValueValid(newValue);\n    if (!isValid) return;\n\n    if (propertyEditorRef.current && args.propertyRecord) {\n      const commitResult = await propertyEditorRef.current.commitValue(\n        newValue,\n        args.propertyRecord\n      );\n      if (commitResult.encounteredError) {\n        displayOutputMessage(commitResult.errorMessage);\n        return;\n      }\n    }\n\n    onCommit(args);\n  };\n\n  const editorProps: CloneProps = {\n    ref: (ref) => {\n      editorRef.current = ref ?? undefined;\n    },\n    onCommit: handleEditorCommit,\n    onCancel,\n    onBlur: handleEditorBlur,\n    setFocus: setFocus !== undefined ? setFocus : true,\n    propertyRecord,\n    shouldCommitOnChange,\n    ...rest,\n  };\n\n  const propDescription = propertyRecord.property;\n\n  const editorName =\n    propDescription.editor !== undefined\n      ? propDescription.editor.name\n      : undefined;\n\n  propertyEditorRef.current = PropertyEditorManager.createEditor(\n    propDescription.typename,\n    editorName,\n    propDescription.dataController\n  );\n\n  const clonedNode = React.isValidElement(propertyEditorRef.current.reactNode)\n    ? React.cloneElement(propertyEditorRef.current.reactNode, editorProps)\n    : undefined;\n\n  return (\n    <span\n      className=\"components-editor-container\"\n      onBlur={handleContainerBlur}\n      onKeyDown={handleKeyDown}\n      onClick={handleClick}\n      onContextMenu={handleClick}\n      title={title}\n      data-testid=\"editor-container\"\n      role=\"presentation\"\n    >\n      {clonedNode}\n    </span>\n  );\n}\n\nfunction arePrimitiveValuesEqual(\n  oldValue: Primitives.Value,\n  newValue: Primitives.Value\n): boolean {\n  if (typeof oldValue !== typeof newValue) {\n    return false;\n  }\n  // directly compare simple types\n  if (typeof newValue !== \"object\" || newValue instanceof Date) {\n    return newValue === oldValue;\n  }\n  // compare all members of arrays\n  if (newValue instanceof Array) {\n    if (!(oldValue instanceof Array)) {\n      return false;\n    }\n    if (newValue.length !== oldValue.length) {\n      return false;\n    }\n    for (let i = 0; i < newValue.length; i++) {\n      if (oldValue[i] !== newValue[i]) {\n        return false;\n      }\n    }\n    return true;\n  }\n  // compare `Point2d` and `Point3d` types\n  if (\"x\" in newValue) {\n    if (typeof oldValue !== \"object\" || !(\"x\" in oldValue)) {\n      return false;\n    }\n    if (\"z\" in newValue) {\n      if (!(\"z\" in oldValue)) {\n        return false;\n      }\n      return (\n        newValue.x === oldValue.x &&\n        newValue.y === oldValue.y &&\n        newValue.z === oldValue.z\n      );\n    } else if (\"z\" in oldValue) {\n      return false;\n    }\n    return newValue.x === oldValue.x && newValue.y === oldValue.y;\n  }\n  // compare instance keys\n  if (\"className\" in newValue) {\n    if (typeof oldValue !== \"object\" || !(\"className\" in oldValue)) {\n      return false;\n    }\n    return (\n      oldValue.className === newValue.className && oldValue.id === newValue.id\n    );\n  }\n  return false;\n}\n\nfunction shouldCommit(oldValue: PropertyValue, newValue: PropertyValue) {\n  if (\n    oldValue.valueFormat !== newValue.valueFormat ||\n    newValue.valueFormat !== PropertyValueFormat.Primitive\n  ) {\n    return true;\n  }\n  const oldPrimitiveValue = oldValue as PrimitiveValue;\n  if (!oldPrimitiveValue.value && !newValue.value) {\n    return false;\n  }\n  if (\n    (!oldPrimitiveValue.value && newValue.value) ||\n    (oldPrimitiveValue.value && !newValue.value)\n  ) {\n    return true;\n  }\n  return !arePrimitiveValuesEqual(oldPrimitiveValue.value!, newValue.value!);\n}\n"]}

package/lib/components-react/editors/EnumButtonGroupEditor.d.ts

@@ -0,0 +1,40 @@
+/** @packageDocumentation
+ * @module PropertyEditors
+ */
+import "./EnumButtonGroupEditor.scss";
+import * as React from "react";
+import type { EnumerationChoice, IconDefinition, PropertyValue } from "@itwin/appui-abstract";
+import type { PropertyEditorProps, TypeEditor } from "./EditorContainer.js";
+import { PropertyEditorBase } from "./PropertyEditorManager.js";
+/** @internal */
+interface EnumButtonGroupEditorState {
+    selectValue: string | number;
+    enumIcons: IconDefinition[];
+    choices: EnumerationChoice[];
+}
+/** EnumButtonGroupEditor React component that is a property editor with select input
+ * @public
+ */
+export declare class EnumButtonGroupEditor extends React.Component<PropertyEditorProps, EnumButtonGroupEditorState> implements TypeEditor {
+    private _btnRefs;
+    private _divElement;
+    readonly state: Readonly<EnumButtonGroupEditorState>;
+    getPropertyValue(): Promise<PropertyValue | undefined>;
+    get htmlElement(): HTMLElement | null;
+    get hasFocus(): boolean;
+    componentDidMount(): void;
+    componentDidUpdate(prevProps: PropertyEditorProps): void;
+    private setStateFromProps;
+    private _handleButtonClick;
+    private getButton;
+    render(): React.JSX.Element;
+}
+/** Enum Property Button Group Editor registered for the "enum" type name and the "enum-buttongroup" editor name.
+ * It uses the [[EnumButtonGroupEditor]] React component.
+ * @public
+ */
+export declare class EnumPropertyButtonGroupEditor extends PropertyEditorBase {
+    get reactNode(): React.ReactNode;
+}
+export {};
+//# sourceMappingURL=EnumButtonGroupEditor.d.ts.map

package/lib/components-react/editors/EnumButtonGroupEditor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EnumButtonGroupEditor.d.ts","sourceRoot":"","sources":["../../../src/components-react/editors/EnumButtonGroupEditor.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,8BAA8B,CAAC;AAEtC,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,KAAK,EAEV,iBAAiB,EACjB,cAAc,EAGd,aAAa,EACd,MAAM,uBAAuB,CAAC;AAM/B,OAAO,KAAK,EAAE,mBAAmB,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAC5E,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAKhE,gBAAgB;AAChB,UAAU,0BAA0B;IAClC,WAAW,EAAE,MAAM,GAAG,MAAM,CAAC;IAC7B,SAAS,EAAE,cAAc,EAAE,CAAC;IAC5B,OAAO,EAAE,iBAAiB,EAAE,CAAC;CAC9B;AAED;;GAEG;AACH,qBAAa,qBACX,SAAQ,KAAK,CAAC,SAAS,CAAC,mBAAmB,EAAE,0BAA0B,CACvE,YAAW,UAAU;IAErB,OAAO,CAAC,QAAQ,CAAiD;IACjE,OAAO,CAAC,WAAW,CAAqC;IAExD,SAAyB,KAAK,EAAE,QAAQ,CAAC,0BAA0B,CAAC,CAIlE;IAEW,gBAAgB,IAAI,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC;IAenE,IAAW,WAAW,IAAI,WAAW,GAAG,IAAI,CAE3C;IAED,IAAW,QAAQ,IAAI,OAAO,CAK7B;IAEe,iBAAiB;IAIjB,kBAAkB,CAAC,SAAS,EAAE,mBAAmB;YAMnD,iBAAiB;IA0D/B,OAAO,CAAC,kBAAkB,CAoBxB;IAEF,OAAO,CAAC,SAAS;IAkCD,MAAM;CAkBvB;AAED;;;GAGG;AACH,qBAAa,6BAA8B,SAAQ,kBAAkB;IACnE,IAAW,SAAS,IAAI,KAAK,CAAC,SAAS,CAEtC;CACF"}