@itwin/components-react 4.17.6 → 5.0.0-dev.3

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

@@ -0,0 +1,167 @@
+/*---------------------------------------------------------------------------------------------
+ * 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 "./TextareaEditor.scss";
+import classnames from "classnames";
+import * as React from "react";
+import { PropertyEditorParamTypes, PropertyValueFormat, } from "@itwin/appui-abstract";
+import { Textarea } from "@itwin/itwinui-react";
+import { TypeConverterManager } from "../converters/TypeConverterManager.js";
+import { PropertyEditorBase } from "./PropertyEditorManager.js";
+import { PopupButton, PopupContent, PopupOkCancelButtons, } from "./PopupButton.js";
+import { UiComponents } from "../UiComponents.js";
+const DEFAULT_ROWS = 3;
+/** TextareaEditor React component that is a property editor with text input
+ * @public
+ */
+export class TextareaEditor extends React.PureComponent {
+    constructor() {
+        super(...arguments);
+        this._isMounted = false;
+        this._divElement = React.createRef();
+        this._textAreaElement = React.createRef();
+        this.state = {
+            inputValue: "",
+            readonly: false,
+            rows: DEFAULT_ROWS,
+        };
+        this._updateTextareaValue = (e) => {
+            if (this._isMounted)
+                this.setState({
+                    inputValue: e.target.value,
+                });
+        };
+        this._handleOk = async (_event) => {
+            if (this.props.propertyRecord && this.props.onCommit) {
+                const propertyValue = await this.getPropertyValue();
+                if (propertyValue !== undefined) {
+                    this.props.onCommit({
+                        propertyRecord: this.props.propertyRecord,
+                        newValue: propertyValue,
+                    });
+                }
+            }
+        };
+        this._handleCancel = (_event) => {
+            if (this.props.onCancel) {
+                this.props.onCancel();
+            }
+        };
+    }
+    async getPropertyValue() {
+        const record = this.props.propertyRecord;
+        let propertyValue;
+        if (record && record.value.valueFormat === PropertyValueFormat.Primitive) {
+            propertyValue = await TypeConverterManager.getConverter(record.property.typename).convertFromStringToPropertyValue(this.state.inputValue, record);
+            propertyValue.displayValue = this.state.inputValue;
+        }
+        return propertyValue;
+    }
+    get htmlElement() {
+        return this._divElement.current;
+    }
+    get hasFocus() {
+        let containsFocus = false;
+        if (this._divElement.current)
+            containsFocus = this._divElement.current.contains(document.activeElement);
+        return containsFocus;
+    }
+    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 = "";
+        if (record && record.value.valueFormat === PropertyValueFormat.Primitive) {
+            const value = record.value.value;
+            initialValue = await TypeConverterManager.getConverter(record.property.typename).convertPropertyToString(record.property, value);
+        }
+        const readonly = record && undefined !== record.isReadonly ? record.isReadonly : false;
+        let size;
+        let maxLength;
+        let rows = DEFAULT_ROWS;
+        const isDisabled = record ? record.isDisabled : undefined;
+        if (record &&
+            record.property &&
+            record.property.editor &&
+            record.property.editor.params) {
+            const editorSizeParams = record.property.editor.params.find((param) => param.type === PropertyEditorParamTypes.InputEditorSize.valueOf());
+            if (editorSizeParams) {
+                if (editorSizeParams.size)
+                    size = editorSizeParams.size;
+                if (editorSizeParams.maxLength)
+                    maxLength = editorSizeParams.maxLength;
+            }
+            const multilineParams = record.property.editor.params.find((param) => param.type === PropertyEditorParamTypes.MultilineText.valueOf());
+            if (multilineParams) {
+                rows = multilineParams.rows;
+            }
+        }
+        if (this._isMounted)
+            this.setState({
+                inputValue: initialValue,
+                readonly,
+                size,
+                maxLength,
+                isDisabled,
+                rows,
+            });
+    }
+    render() {
+        const className = classnames("components-cell-editor", "components-textarea-editor", this.props.className);
+        const minSize = this.state.size ? this.state.size : 8;
+        const style = {
+            ...this.props.style,
+            minWidth: `${minSize * 0.75}em`,
+        };
+        const textareaProps = {
+            className: "components-textarea-editor-textarea",
+            style,
+            rows: this.state.rows,
+            readOnly: this.state.readonly,
+            disabled: this.state.isDisabled,
+            maxLength: this.state.maxLength,
+            value: this.state.inputValue,
+            onChange: this._updateTextareaValue,
+            autoFocus: this.props.setFocus && !this.state.isDisabled,
+        };
+        textareaProps["aria-label"] = UiComponents.translate("editor.textarea");
+        return (React.createElement("div", { className: className, ref: this._divElement },
+            React.createElement(PopupButton, { label: this.state.inputValue, closeOnEnter: false, setFocus: this.props.setFocus, focusTarget: this._textAreaElement },
+                React.createElement(PopupContent, null,
+                    React.createElement(Textarea, { ...textareaProps, "data-testid": "components-textarea-editor", ref: this._textAreaElement }),
+                    React.createElement(PopupOkCancelButtons, { onOk: this._handleOk, onCancel: this._handleCancel })))));
+    }
+}
+/** Textarea Property Editor registered for the "text" and "string" type names and "multi-line" editor name.
+ * It uses the [[TextareaEditor]] React component.
+ * @public
+ */
+export class TextareaPropertyEditor extends PropertyEditorBase {
+    get containerHandlesBlur() {
+        return false;
+    }
+    get containerHandlesEnter() {
+        return false;
+    }
+    get containerHandlesTab() {
+        return false;
+    }
+    get reactNode() {
+        return React.createElement(TextareaEditor, null);
+    }
+}
+//# sourceMappingURL=TextareaEditor.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TextareaEditor.js","sourceRoot":"","sources":["../../../src/components-react/editors/TextareaEditor.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;AAQ/B,OAAO,EACL,wBAAwB,EACxB,mBAAmB,GACpB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,oBAAoB,EAAE,MAAM,uCAAuC,CAAC;AAE7E,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EACL,WAAW,EACX,YAAY,EACZ,oBAAoB,GACrB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAclD,MAAM,YAAY,GAAG,CAAC,CAAC;AAEvB;;GAEG;AACH,MAAM,OAAO,cACX,SAAQ,KAAK,CAAC,aAAuD;IADvE;;QAIU,eAAU,GAAG,KAAK,CAAC;QACnB,gBAAW,GAAG,KAAK,CAAC,SAAS,EAAkB,CAAC;QAChD,qBAAgB,GAAG,KAAK,CAAC,SAAS,EAAuB,CAAC;QAEzC,UAAK,GAAkC;YAC9D,UAAU,EAAE,EAAE;YACd,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,YAAY;SACnB,CAAC;QA2BM,yBAAoB,GAAG,CAC7B,CAAyC,EACzC,EAAE;YACF,IAAI,IAAI,CAAC,UAAU;gBACjB,IAAI,CAAC,QAAQ,CAAC;oBACZ,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC,KAAK;iBAC3B,CAAC,CAAC;QACP,CAAC,CAAC;QAuEM,cAAS,GAAG,KAAK,EAAE,MAAwB,EAAiB,EAAE;YACpE,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;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;IAkDJ,CAAC;IAzKQ,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,MAAM,oBAAoB,CAAC,YAAY,CACrD,MAAM,CAAC,QAAQ,CAAC,QAAQ,CACzB,CAAC,gCAAgC,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;YACjE,aAAgC,CAAC,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC;QACzE,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,CAAC,OAAO;YAC1B,aAAa,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;QAC5E,OAAO,aAAa,CAAC;IACvB,CAAC;IAWe,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,YAAY,GAAG,EAAE,CAAC;QAEtB,IAAI,MAAM,IAAI,MAAM,CAAC,KAAK,CAAC,WAAW,KAAK,mBAAmB,CAAC,SAAS,EAAE,CAAC;YACzE,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;YACjC,YAAY,GAAG,MAAM,oBAAoB,CAAC,YAAY,CACpD,MAAM,CAAC,QAAQ,CAAC,QAAQ,CACzB,CAAC,uBAAuB,CAAC,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QACpD,CAAC;QAED,MAAM,QAAQ,GACZ,MAAM,IAAI,SAAS,KAAK,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC;QACxE,IAAI,IAAwB,CAAC;QAC7B,IAAI,SAA6B,CAAC;QAClC,IAAI,IAAI,GAAW,YAAY,CAAC;QAEhC,MAAM,UAAU,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;QAE1D,IACE,MAAM;YACN,MAAM,CAAC,QAAQ;YACf,MAAM,CAAC,QAAQ,CAAC,MAAM;YACtB,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAC7B,CAAC;YACD,MAAM,gBAAgB,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CACzD,CAAC,KAA2B,EAAE,EAAE,CAC9B,KAAK,CAAC,IAAI,KAAK,wBAAwB,CAAC,eAAe,CAAC,OAAO,EAAE,CAC3C,CAAC;YAC3B,IAAI,gBAAgB,EAAE,CAAC;gBACrB,IAAI,gBAAgB,CAAC,IAAI;oBAAE,IAAI,GAAG,gBAAgB,CAAC,IAAI,CAAC;gBACxD,IAAI,gBAAgB,CAAC,SAAS;oBAAE,SAAS,GAAG,gBAAgB,CAAC,SAAS,CAAC;YACzE,CAAC;YAED,MAAM,eAAe,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CACxD,CAAC,KAA2B,EAAE,EAAE,CAC9B,KAAK,CAAC,IAAI,KAAK,wBAAwB,CAAC,aAAa,CAAC,OAAO,EAAE,CACrC,CAAC;YAC/B,IAAI,eAAe,EAAE,CAAC;gBACpB,IAAI,GAAG,eAAe,CAAC,IAAI,CAAC;YAC9B,CAAC;QACH,CAAC;QAED,IAAI,IAAI,CAAC,UAAU;YACjB,IAAI,CAAC,QAAQ,CAAC;gBACZ,UAAU,EAAE,YAAY;gBACxB,QAAQ;gBACR,IAAI;gBACJ,SAAS;gBACT,UAAU;gBACV,IAAI;aACL,CAAC,CAAC;IACP,CAAC;IAoBe,MAAM;QACpB,MAAM,SAAS,GAAG,UAAU,CAC1B,wBAAwB,EACxB,4BAA4B,EAC5B,IAAI,CAAC,KAAK,CAAC,SAAS,CACrB,CAAC;QACF,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QACtD,MAAM,KAAK,GAAwB;YACjC,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK;YACnB,QAAQ,EAAE,GAAG,OAAO,GAAG,IAAI,IAAI;SAChC,CAAC;QACF,MAAM,aAAa,GAAkB;YACnC,SAAS,EAAE,qCAAqC;YAChD,KAAK;YACL,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI;YACrB,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ;YAC7B,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU;YAC/B,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS;YAC/B,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU;YAC5B,QAAQ,EAAE,IAAI,CAAC,oBAAoB;YACnC,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU;SACzD,CAAC;QAEF,aAAa,CAAC,YAAY,CAAC,GAAG,YAAY,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;QAExE,OAAO,CACL,6BAAK,SAAS,EAAE,SAAS,EAAE,GAAG,EAAE,IAAI,CAAC,WAAW;YAC9C,oBAAC,WAAW,IACV,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,EAC5B,YAAY,EAAE,KAAK,EACnB,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ,EAC7B,WAAW,EAAE,IAAI,CAAC,gBAAgB;gBAElC,oBAAC,YAAY;oBACX,oBAAC,QAAQ,OACH,aAAa,iBACL,4BAA4B,EACxC,GAAG,EAAE,IAAI,CAAC,gBAAgB,GAC1B;oBACF,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,sBAAuB,SAAQ,kBAAkB;IAC5D,IAAoB,oBAAoB;QACtC,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAoB,qBAAqB;QACvC,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAoB,mBAAmB;QACrC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAW,SAAS;QAClB,OAAO,oBAAC,cAAc,OAAG,CAAC;IAC5B,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 \"./TextareaEditor.scss\";\nimport classnames from \"classnames\";\nimport * as React from \"react\";\nimport type {\n  InputEditorSizeParams,\n  MultilineTextEditorParams,\n  PrimitiveValue,\n  PropertyEditorParams,\n  PropertyValue,\n} from \"@itwin/appui-abstract\";\nimport {\n  PropertyEditorParamTypes,\n  PropertyValueFormat,\n} from \"@itwin/appui-abstract\";\nimport { Textarea } from \"@itwin/itwinui-react\";\nimport { TypeConverterManager } from \"../converters/TypeConverterManager.js\";\nimport type { PropertyEditorProps, TypeEditor } from \"./EditorContainer.js\";\nimport { PropertyEditorBase } from \"./PropertyEditorManager.js\";\nimport {\n  PopupButton,\n  PopupContent,\n  PopupOkCancelButtons,\n} from \"./PopupButton.js\";\nimport { UiComponents } from \"../UiComponents.js\";\n\ntype TextareaProps = React.ComponentPropsWithoutRef<typeof Textarea>;\n\n/** @internal */\ninterface TextareaEditorState {\n  inputValue: string;\n  readonly: boolean;\n  isDisabled?: boolean;\n  size?: number;\n  maxLength?: number;\n  rows: number;\n}\n\nconst DEFAULT_ROWS = 3;\n\n/** TextareaEditor React component that is a property editor with text input\n * @public\n */\nexport class TextareaEditor\n  extends React.PureComponent<PropertyEditorProps, TextareaEditorState>\n  implements TypeEditor\n{\n  private _isMounted = false;\n  private _divElement = React.createRef<HTMLDivElement>();\n  private _textAreaElement = React.createRef<HTMLTextAreaElement>();\n\n  public override readonly state: Readonly<TextareaEditorState> = {\n    inputValue: \"\",\n    readonly: false,\n    rows: DEFAULT_ROWS,\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 = await TypeConverterManager.getConverter(\n        record.property.typename\n      ).convertFromStringToPropertyValue(this.state.inputValue, record);\n      (propertyValue as PrimitiveValue).displayValue = this.state.inputValue;\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._divElement.current)\n      containsFocus = this._divElement.current.contains(document.activeElement);\n    return containsFocus;\n  }\n\n  private _updateTextareaValue = (\n    e: React.ChangeEvent<HTMLTextAreaElement>\n  ) => {\n    if (this._isMounted)\n      this.setState({\n        inputValue: e.target.value,\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 = \"\";\n\n    if (record && record.value.valueFormat === PropertyValueFormat.Primitive) {\n      const value = record.value.value;\n      initialValue = await TypeConverterManager.getConverter(\n        record.property.typename\n      ).convertPropertyToString(record.property, value);\n    }\n\n    const readonly =\n      record && undefined !== record.isReadonly ? record.isReadonly : false;\n    let size: number | undefined;\n    let maxLength: number | undefined;\n    let rows: number = DEFAULT_ROWS;\n\n    const isDisabled = record ? record.isDisabled : undefined;\n\n    if (\n      record &&\n      record.property &&\n      record.property.editor &&\n      record.property.editor.params\n    ) {\n      const editorSizeParams = record.property.editor.params.find(\n        (param: PropertyEditorParams) =>\n          param.type === PropertyEditorParamTypes.InputEditorSize.valueOf()\n      ) as InputEditorSizeParams;\n      if (editorSizeParams) {\n        if (editorSizeParams.size) size = editorSizeParams.size;\n        if (editorSizeParams.maxLength) maxLength = editorSizeParams.maxLength;\n      }\n\n      const multilineParams = record.property.editor.params.find(\n        (param: PropertyEditorParams) =>\n          param.type === PropertyEditorParamTypes.MultilineText.valueOf()\n      ) as MultilineTextEditorParams;\n      if (multilineParams) {\n        rows = multilineParams.rows;\n      }\n    }\n\n    if (this._isMounted)\n      this.setState({\n        inputValue: initialValue,\n        readonly,\n        size,\n        maxLength,\n        isDisabled,\n        rows,\n      });\n  }\n\n  private _handleOk = async (_event: React.MouseEvent): 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  private _handleCancel = (_event: React.MouseEvent): void => {\n    if (this.props.onCancel) {\n      this.props.onCancel();\n    }\n  };\n\n  public override render(): React.ReactNode {\n    const className = classnames(\n      \"components-cell-editor\",\n      \"components-textarea-editor\",\n      this.props.className\n    );\n    const minSize = this.state.size ? this.state.size : 8;\n    const style: React.CSSProperties = {\n      ...this.props.style,\n      minWidth: `${minSize * 0.75}em`,\n    };\n    const textareaProps: TextareaProps = {\n      className: \"components-textarea-editor-textarea\",\n      style,\n      rows: this.state.rows,\n      readOnly: this.state.readonly,\n      disabled: this.state.isDisabled,\n      maxLength: this.state.maxLength,\n      value: this.state.inputValue,\n      onChange: this._updateTextareaValue,\n      autoFocus: this.props.setFocus && !this.state.isDisabled,\n    };\n\n    textareaProps[\"aria-label\"] = UiComponents.translate(\"editor.textarea\");\n\n    return (\n      <div className={className} ref={this._divElement}>\n        <PopupButton\n          label={this.state.inputValue}\n          closeOnEnter={false}\n          setFocus={this.props.setFocus}\n          focusTarget={this._textAreaElement}\n        >\n          <PopupContent>\n            <Textarea\n              {...textareaProps}\n              data-testid=\"components-textarea-editor\"\n              ref={this._textAreaElement}\n            />\n            <PopupOkCancelButtons\n              onOk={this._handleOk}\n              onCancel={this._handleCancel}\n            />\n          </PopupContent>\n        </PopupButton>\n      </div>\n    );\n  }\n}\n\n/** Textarea Property Editor registered for the \"text\" and \"string\" type names and \"multi-line\" editor name.\n * It uses the [[TextareaEditor]] React component.\n * @public\n */\nexport class TextareaPropertyEditor extends PropertyEditorBase {\n  public override get containerHandlesBlur(): boolean {\n    return false;\n  }\n  public override get containerHandlesEnter(): boolean {\n    return false;\n  }\n  public override get containerHandlesTab(): boolean {\n    return false;\n  }\n\n  public get reactNode(): React.ReactNode {\n    return <TextareaEditor />;\n  }\n}\n"]}

package/lib/components-react/editors/TextareaEditor.scss

@@ -0,0 +1,13 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+.components-textarea-editor {
+  min-width: 100%;
+  margin: 0;
+}
+
+.components-textarea-editor-textarea {
+  min-width: 150px;
+  margin: 0;
+}

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

@@ -0,0 +1,40 @@
+/** @packageDocumentation
+ * @module PropertyEditors
+ */
+import "./ToggleEditor.scss";
+import * as React from "react";
+import type { PropertyValue } from "@itwin/appui-abstract";
+import type { PropertyEditorProps, TypeEditor } from "./EditorContainer.js";
+import { PropertyEditorBase } from "./PropertyEditorManager.js";
+/** @internal */
+interface ToggleEditorState {
+    toggleValue: boolean;
+    isDisabled?: boolean;
+}
+/** ToggleEditor React component that is a property editor with checkbox input
+ * @public
+ */
+export declare class ToggleEditor extends React.PureComponent<PropertyEditorProps, ToggleEditorState> implements TypeEditor {
+    private _isMounted;
+    private _inputElement;
+    readonly state: Readonly<ToggleEditorState>;
+    getPropertyValue(): Promise<PropertyValue | undefined>;
+    get htmlElement(): HTMLElement | null;
+    get hasFocus(): boolean;
+    private _updateToggleValue;
+    componentDidMount(): void;
+    componentWillUnmount(): void;
+    componentDidUpdate(prevProps: PropertyEditorProps): void;
+    private setStateFromProps;
+    render(): React.JSX.Element;
+}
+/** Toggle Property Editor registered for the "bool" and "boolean" type names and "toggle" editor name.
+ * It uses the [[ToggleEditor]] React component.
+ * @public
+ */
+export declare class TogglePropertyEditor extends PropertyEditorBase {
+    get containerHandlesBlur(): boolean;
+    get reactNode(): React.ReactNode;
+}
+export {};
+//# sourceMappingURL=ToggleEditor.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ToggleEditor.d.ts","sourceRoot":"","sources":["../../../src/components-react/editors/ToggleEditor.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,qBAAqB,CAAC;AAE7B,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAE3D,OAAO,KAAK,EAAE,mBAAmB,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAC5E,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAGhE,gBAAgB;AAChB,UAAU,iBAAiB;IACzB,WAAW,EAAE,OAAO,CAAC;IACrB,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;GAEG;AACH,qBAAa,YACX,SAAQ,KAAK,CAAC,aAAa,CAAC,mBAAmB,EAAE,iBAAiB,CAClE,YAAW,UAAU;IAErB,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,aAAa,CAAuC;IAE5D,SAAyB,KAAK,EAAE,QAAQ,CAAC,iBAAiB,CAAC,CAGzD;IAEW,gBAAgB,IAAI,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC;IAcnE,IAAW,WAAW,IAAI,WAAW,GAAG,IAAI,CAE3C;IAED,IAAW,QAAQ,IAAI,OAAO,CAE7B;IAED,OAAO,CAAC,kBAAkB,CAyBxB;IAEc,iBAAiB;IAKjB,oBAAoB;IAIpB,kBAAkB,CAAC,SAAS,EAAE,mBAAmB;YAMnD,iBAAiB;IAmBf,MAAM;CAuBvB;AAED;;;GAGG;AACH,qBAAa,oBAAqB,SAAQ,kBAAkB;IAC1D,IAAoB,oBAAoB,IAAI,OAAO,CAElD;IAED,IAAW,SAAS,IAAI,KAAK,CAAC,SAAS,CAEtC;CACF"}

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

@@ -0,0 +1,110 @@
+/*---------------------------------------------------------------------------------------------
+ * 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 "./ToggleEditor.scss";
+import classnames from "classnames";
+import * as React from "react";
+import { PropertyValueFormat } from "@itwin/appui-abstract";
+import { PropertyEditorBase } from "./PropertyEditorManager.js";
+import { ToggleSwitch } from "@itwin/itwinui-react";
+/** ToggleEditor React component that is a property editor with checkbox input
+ * @public
+ */
+export class ToggleEditor extends React.PureComponent {
+    constructor() {
+        super(...arguments);
+        this._isMounted = false;
+        this._inputElement = React.createRef();
+        this.state = {
+            toggleValue: false,
+            isDisabled: false,
+        };
+        this._updateToggleValue = (e) => {
+            if (this._isMounted) {
+                if (this._isMounted) {
+                    const toggleValue = !!e.target.checked;
+                    this.setState({
+                        toggleValue,
+                    }, 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.toggleValue,
+                displayValue: "",
+            };
+        }
+        return propertyValue;
+    }
+    get htmlElement() {
+        return this._inputElement.current;
+    }
+    get hasFocus() {
+        return document.activeElement === this._inputElement.current;
+    }
+    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 { propertyRecord } = this.props;
+        let toggleValue = false;
+        let isDisabled = false;
+        if (propertyRecord &&
+            propertyRecord.value.valueFormat === PropertyValueFormat.Primitive) {
+            const primitiveValue = propertyRecord.value.value;
+            toggleValue = primitiveValue;
+        }
+        if (propertyRecord && propertyRecord.isDisabled)
+            isDisabled = propertyRecord.isDisabled;
+        if (this._isMounted)
+            this.setState({ toggleValue, isDisabled });
+    }
+    render() {
+        const className = classnames("components-cell-editor", "components-toggle-editor", this.props.className);
+        const isChecked = this.state.toggleValue;
+        const isDisabled = !!this.state.isDisabled;
+        return (React.createElement(ToggleSwitch, { ref: this._inputElement, onBlur: this.props.onBlur, className: className, style: this.props.style, checked: isChecked, disabled: isDisabled, onChange: this._updateToggleValue, "data-testid": "components-toggle-editor", autoFocus: this.props.setFocus }));
+    }
+}
+/** Toggle Property Editor registered for the "bool" and "boolean" type names and "toggle" editor name.
+ * It uses the [[ToggleEditor]] React component.
+ * @public
+ */
+export class TogglePropertyEditor extends PropertyEditorBase {
+    get containerHandlesBlur() {
+        return false;
+    }
+    get reactNode() {
+        return React.createElement(ToggleEditor, null);
+    }
+}
+//# sourceMappingURL=ToggleEditor.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ToggleEditor.js","sourceRoot":"","sources":["../../../src/components-react/editors/ToggleEditor.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,qBAAqB,CAAC;AAC7B,OAAO,UAAU,MAAM,YAAY,CAAC;AACpC,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAQpD;;GAEG;AACH,MAAM,OAAO,YACX,SAAQ,KAAK,CAAC,aAAqD;IADrE;;QAIU,eAAU,GAAG,KAAK,CAAC;QACnB,kBAAa,GAAG,KAAK,CAAC,SAAS,EAAoB,CAAC;QAEnC,UAAK,GAAgC;YAC5D,WAAW,EAAE,KAAK;YAClB,UAAU,EAAE,KAAK;SAClB,CAAC;QAwBM,uBAAkB,GAAG,CAC3B,CAAsC,EACjC,EAAE;YACP,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;gBACpB,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;oBACpB,MAAM,WAAW,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC;oBAEvC,IAAI,CAAC,QAAQ,CACX;wBACE,WAAW;qBACZ,EACD,KAAK,IAAI,EAAE;wBACT,IAAI,IAAI,CAAC,KAAK,CAAC,cAAc,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;4BACrD,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;4BACpD,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;gCAChC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;oCAClB,cAAc,EAAE,IAAI,CAAC,KAAK,CAAC,cAAc;oCACzC,QAAQ,EAAE,aAAa;iCACxB,CAAC,CAAC;4BACL,CAAC;wBACH,CAAC;oBACH,CAAC,CACF,CAAC;gBACJ,CAAC;YACH,CAAC;QACH,CAAC,CAAC;IA2DJ,CAAC;IA1GQ,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,WAAW;gBAC7B,YAAY,EAAE,EAAE;aACjB,CAAC;QACJ,CAAC;QACD,OAAO,aAAa,CAAC;IACvB,CAAC;IAED,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC;IACpC,CAAC;IAED,IAAW,QAAQ;QACjB,OAAO,QAAQ,CAAC,aAAa,KAAK,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC;IAC/D,CAAC;IA6Be,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,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QACtC,IAAI,WAAW,GAAG,KAAK,CAAC;QACxB,IAAI,UAAU,GAAG,KAAK,CAAC;QAEvB,IACE,cAAc;YACd,cAAc,CAAC,KAAK,CAAC,WAAW,KAAK,mBAAmB,CAAC,SAAS,EAClE,CAAC;YACD,MAAM,cAAc,GAAG,cAAc,CAAC,KAAK,CAAC,KAAK,CAAC;YAClD,WAAW,GAAG,cAAyB,CAAC;QAC1C,CAAC;QAED,IAAI,cAAc,IAAI,cAAc,CAAC,UAAU;YAC7C,UAAU,GAAG,cAAc,CAAC,UAAU,CAAC;QAEzC,IAAI,IAAI,CAAC,UAAU;YAAE,IAAI,CAAC,QAAQ,CAAC,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC,CAAC;IAClE,CAAC;IAEe,MAAM;QACpB,MAAM,SAAS,GAAG,UAAU,CAC1B,wBAAwB,EACxB,0BAA0B,EAC1B,IAAI,CAAC,KAAK,CAAC,SAAS,CACrB,CAAC;QACF,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC;QACzC,MAAM,UAAU,GAAG,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC;QAE3C,OAAO,CACL,oBAAC,YAAY,IACX,GAAG,EAAE,IAAI,CAAC,aAAa,EACvB,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,EACzB,SAAS,EAAE,SAAS,EACpB,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,EACvB,OAAO,EAAE,SAAS,EAClB,QAAQ,EAAE,UAAU,EACpB,QAAQ,EAAE,IAAI,CAAC,kBAAkB,iBACrB,0BAA0B,EACtC,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ,GAC9B,CACH,CAAC;IACJ,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,oBAAqB,SAAQ,kBAAkB;IAC1D,IAAoB,oBAAoB;QACtC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAW,SAAS;QAClB,OAAO,oBAAC,YAAY,OAAG,CAAC;IAC1B,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 \"./ToggleEditor.scss\";\nimport classnames from \"classnames\";\nimport * as React from \"react\";\nimport type { PropertyValue } from \"@itwin/appui-abstract\";\nimport { PropertyValueFormat } from \"@itwin/appui-abstract\";\nimport type { PropertyEditorProps, TypeEditor } from \"./EditorContainer.js\";\nimport { PropertyEditorBase } from \"./PropertyEditorManager.js\";\nimport { ToggleSwitch } from \"@itwin/itwinui-react\";\n\n/** @internal */\ninterface ToggleEditorState {\n  toggleValue: boolean;\n  isDisabled?: boolean;\n}\n\n/** ToggleEditor React component that is a property editor with checkbox input\n * @public\n */\nexport class ToggleEditor\n  extends React.PureComponent<PropertyEditorProps, ToggleEditorState>\n  implements TypeEditor\n{\n  private _isMounted = false;\n  private _inputElement = React.createRef<HTMLInputElement>();\n\n  public override readonly state: Readonly<ToggleEditorState> = {\n    toggleValue: false,\n    isDisabled: 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.toggleValue,\n        displayValue: \"\",\n      };\n    }\n    return propertyValue;\n  }\n\n  public get htmlElement(): HTMLElement | null {\n    return this._inputElement.current;\n  }\n\n  public get hasFocus(): boolean {\n    return document.activeElement === this._inputElement.current;\n  }\n\n  private _updateToggleValue = (\n    e: React.ChangeEvent<HTMLInputElement>\n  ): any => {\n    if (this._isMounted) {\n      if (this._isMounted) {\n        const toggleValue = !!e.target.checked;\n\n        this.setState(\n          {\n            toggleValue,\n          },\n          async () => {\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      }\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 { propertyRecord } = this.props;\n    let toggleValue = false;\n    let isDisabled = false;\n\n    if (\n      propertyRecord &&\n      propertyRecord.value.valueFormat === PropertyValueFormat.Primitive\n    ) {\n      const primitiveValue = propertyRecord.value.value;\n      toggleValue = primitiveValue as boolean;\n    }\n\n    if (propertyRecord && propertyRecord.isDisabled)\n      isDisabled = propertyRecord.isDisabled;\n\n    if (this._isMounted) this.setState({ toggleValue, isDisabled });\n  }\n\n  public override render() {\n    const className = classnames(\n      \"components-cell-editor\",\n      \"components-toggle-editor\",\n      this.props.className\n    );\n    const isChecked = this.state.toggleValue;\n    const isDisabled = !!this.state.isDisabled;\n\n    return (\n      <ToggleSwitch\n        ref={this._inputElement}\n        onBlur={this.props.onBlur}\n        className={className}\n        style={this.props.style}\n        checked={isChecked}\n        disabled={isDisabled}\n        onChange={this._updateToggleValue}\n        data-testid=\"components-toggle-editor\"\n        autoFocus={this.props.setFocus} // eslint-disable-line jsx-a11y/no-autofocus\n      />\n    );\n  }\n}\n\n/** Toggle Property Editor registered for the \"bool\" and \"boolean\" type names and \"toggle\" editor name.\n * It uses the [[ToggleEditor]] React component.\n * @public\n */\nexport class TogglePropertyEditor extends PropertyEditorBase {\n  public override get containerHandlesBlur(): boolean {\n    return false;\n  }\n\n  public get reactNode(): React.ReactNode {\n    return <ToggleEditor />;\n  }\n}\n"]}

package/lib/components-react/editors/ToggleEditor.scss

@@ -0,0 +1,17 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+.components-property-list--horizontal {
+  .components-toggle-editor {
+    margin-left: var(--iui-size-2xs); // Clear the resizer in the PropertyGrid
+    padding: 1px 0;
+  }
+}
+
+.components-property-list--vertical {
+  .components-toggle-editor {
+    margin-left: var(--iui-size-3xs);
+    padding: 1px 0;
+  }
+}

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

@@ -0,0 +1,6 @@
+/** @packageDocumentation
+ * @module PropertyEditors
+ */
+/** @internal */
+export declare function registerEditors(): void;
+//# sourceMappingURL=registerEditors.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"registerEditors.d.ts","sourceRoot":"","sources":["../../../src/components-react/editors/registerEditors.ts"],"names":[],"mappings":"AAIA;;GAEG;AAsBH,gBAAgB;AAChB,wBAAgB,eAAe,SA2H9B"}

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

@@ -0,0 +1,49 @@
+/*---------------------------------------------------------------------------------------------
+ * 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 { StandardEditorNames, StandardTypeNames } from "@itwin/appui-abstract";
+import { BasicPropertyEditor, PropertyEditorManager, } from "./PropertyEditorManager.js";
+import { DateTimePropertyEditor, ShortDateTimePropertyEditor, } from "./DateTimeEditor.js";
+import { BooleanPropertyEditor } from "./BooleanEditor.js";
+import { CustomNumberPropertyEditor } from "./CustomNumberEditor.js";
+import { EnumPropertyButtonGroupEditor } from "./EnumButtonGroupEditor.js";
+import { EnumPropertyEditor } from "./EnumEditor.js";
+import { IconPropertyEditor } from "./IconEditor.js";
+import { ImageCheckBoxPropertyEditor } from "./ImageCheckBoxEditor.js";
+import { NumericInputPropertyEditor } from "./NumericInputEditor.js";
+import { SliderPropertyEditor } from "./SliderEditor.js";
+import { TextareaPropertyEditor } from "./TextareaEditor.js";
+import { TogglePropertyEditor } from "./ToggleEditor.js";
+/** @internal */
+export function registerEditors() {
+    PropertyEditorManager.registerEditor(StandardTypeNames.Bool, BooleanPropertyEditor);
+    PropertyEditorManager.registerEditor(StandardTypeNames.Boolean, BooleanPropertyEditor);
+    PropertyEditorManager.registerEditor(StandardTypeNames.Boolean, ImageCheckBoxPropertyEditor, StandardEditorNames.ImageCheckBox);
+    PropertyEditorManager.registerEditor(StandardTypeNames.Bool, ImageCheckBoxPropertyEditor, StandardEditorNames.ImageCheckBox);
+    PropertyEditorManager.registerEditor(StandardTypeNames.Bool, TogglePropertyEditor, StandardEditorNames.Toggle);
+    PropertyEditorManager.registerEditor(StandardTypeNames.Boolean, TogglePropertyEditor, StandardEditorNames.Toggle);
+    PropertyEditorManager.registerEditor(StandardTypeNames.Number, NumericInputPropertyEditor, StandardEditorNames.NumericInput);
+    PropertyEditorManager.registerEditor(StandardTypeNames.Int, NumericInputPropertyEditor, StandardEditorNames.NumericInput);
+    PropertyEditorManager.registerEditor(StandardTypeNames.Float, NumericInputPropertyEditor, StandardEditorNames.NumericInput);
+    PropertyEditorManager.registerEditor(StandardTypeNames.Double, NumericInputPropertyEditor, StandardEditorNames.NumericInput);
+    PropertyEditorManager.registerEditor(StandardTypeNames.Number, SliderPropertyEditor, StandardEditorNames.Slider);
+    PropertyEditorManager.registerEditor(StandardTypeNames.Int, SliderPropertyEditor, StandardEditorNames.Slider);
+    PropertyEditorManager.registerEditor(StandardTypeNames.Float, SliderPropertyEditor, StandardEditorNames.Slider);
+    PropertyEditorManager.registerEditor(StandardTypeNames.Double, SliderPropertyEditor, StandardEditorNames.Slider);
+    PropertyEditorManager.registerEditor(StandardTypeNames.Number, CustomNumberPropertyEditor, StandardEditorNames.NumberCustom);
+    PropertyEditorManager.registerEditor(StandardTypeNames.Text, BasicPropertyEditor);
+    PropertyEditorManager.registerEditor(StandardTypeNames.String, BasicPropertyEditor);
+    PropertyEditorManager.registerEditor(StandardTypeNames.Text, IconPropertyEditor, StandardEditorNames.IconPicker);
+    PropertyEditorManager.registerEditor(StandardTypeNames.String, IconPropertyEditor, StandardEditorNames.IconPicker);
+    PropertyEditorManager.registerEditor(StandardTypeNames.Text, TextareaPropertyEditor, StandardEditorNames.MultiLine);
+    PropertyEditorManager.registerEditor(StandardTypeNames.String, TextareaPropertyEditor, StandardEditorNames.MultiLine);
+    PropertyEditorManager.registerEditor(StandardTypeNames.Enum, EnumPropertyButtonGroupEditor, StandardEditorNames.EnumButtonGroup);
+    PropertyEditorManager.registerEditor(StandardTypeNames.Enum, EnumPropertyEditor);
+    PropertyEditorManager.registerEditor(StandardTypeNames.ShortDate, ShortDateTimePropertyEditor);
+    PropertyEditorManager.registerEditor(StandardTypeNames.DateTime, DateTimePropertyEditor);
+}
+//# sourceMappingURL=registerEditors.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"registerEditors.js","sourceRoot":"","sources":["../../../src/components-react/editors/registerEditors.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC/E,OAAO,EACL,mBAAmB,EACnB,qBAAqB,GACtB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACL,sBAAsB,EACtB,2BAA2B,GAC5B,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,EAAE,0BAA0B,EAAE,MAAM,yBAAyB,CAAC;AACrE,OAAO,EAAE,6BAA6B,EAAE,MAAM,4BAA4B,CAAC;AAC3E,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,EAAE,2BAA2B,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,EAAE,0BAA0B,EAAE,MAAM,yBAAyB,CAAC;AACrE,OAAO,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAEzD,gBAAgB;AAChB,MAAM,UAAU,eAAe;IAC7B,qBAAqB,CAAC,cAAc,CAClC,iBAAiB,CAAC,IAAI,EACtB,qBAAqB,CACtB,CAAC;IACF,qBAAqB,CAAC,cAAc,CAClC,iBAAiB,CAAC,OAAO,EACzB,qBAAqB,CACtB,CAAC;IACF,qBAAqB,CAAC,cAAc,CAClC,iBAAiB,CAAC,OAAO,EACzB,2BAA2B,EAC3B,mBAAmB,CAAC,aAAa,CAClC,CAAC;IACF,qBAAqB,CAAC,cAAc,CAClC,iBAAiB,CAAC,IAAI,EACtB,2BAA2B,EAC3B,mBAAmB,CAAC,aAAa,CAClC,CAAC;IACF,qBAAqB,CAAC,cAAc,CAClC,iBAAiB,CAAC,IAAI,EACtB,oBAAoB,EACpB,mBAAmB,CAAC,MAAM,CAC3B,CAAC;IACF,qBAAqB,CAAC,cAAc,CAClC,iBAAiB,CAAC,OAAO,EACzB,oBAAoB,EACpB,mBAAmB,CAAC,MAAM,CAC3B,CAAC;IAEF,qBAAqB,CAAC,cAAc,CAClC,iBAAiB,CAAC,MAAM,EACxB,0BAA0B,EAC1B,mBAAmB,CAAC,YAAY,CACjC,CAAC;IACF,qBAAqB,CAAC,cAAc,CAClC,iBAAiB,CAAC,GAAG,EACrB,0BAA0B,EAC1B,mBAAmB,CAAC,YAAY,CACjC,CAAC;IACF,qBAAqB,CAAC,cAAc,CAClC,iBAAiB,CAAC,KAAK,EACvB,0BAA0B,EAC1B,mBAAmB,CAAC,YAAY,CACjC,CAAC;IACF,qBAAqB,CAAC,cAAc,CAClC,iBAAiB,CAAC,MAAM,EACxB,0BAA0B,EAC1B,mBAAmB,CAAC,YAAY,CACjC,CAAC;IACF,qBAAqB,CAAC,cAAc,CAClC,iBAAiB,CAAC,MAAM,EACxB,oBAAoB,EACpB,mBAAmB,CAAC,MAAM,CAC3B,CAAC;IACF,qBAAqB,CAAC,cAAc,CAClC,iBAAiB,CAAC,GAAG,EACrB,oBAAoB,EACpB,mBAAmB,CAAC,MAAM,CAC3B,CAAC;IACF,qBAAqB,CAAC,cAAc,CAClC,iBAAiB,CAAC,KAAK,EACvB,oBAAoB,EACpB,mBAAmB,CAAC,MAAM,CAC3B,CAAC;IACF,qBAAqB,CAAC,cAAc,CAClC,iBAAiB,CAAC,MAAM,EACxB,oBAAoB,EACpB,mBAAmB,CAAC,MAAM,CAC3B,CAAC;IACF,qBAAqB,CAAC,cAAc,CAClC,iBAAiB,CAAC,MAAM,EACxB,0BAA0B,EAC1B,mBAAmB,CAAC,YAAY,CACjC,CAAC;IAEF,qBAAqB,CAAC,cAAc,CAClC,iBAAiB,CAAC,IAAI,EACtB,mBAAmB,CACpB,CAAC;IACF,qBAAqB,CAAC,cAAc,CAClC,iBAAiB,CAAC,MAAM,EACxB,mBAAmB,CACpB,CAAC;IACF,qBAAqB,CAAC,cAAc,CAClC,iBAAiB,CAAC,IAAI,EACtB,kBAAkB,EAClB,mBAAmB,CAAC,UAAU,CAC/B,CAAC;IACF,qBAAqB,CAAC,cAAc,CAClC,iBAAiB,CAAC,MAAM,EACxB,kBAAkB,EAClB,mBAAmB,CAAC,UAAU,CAC/B,CAAC;IACF,qBAAqB,CAAC,cAAc,CAClC,iBAAiB,CAAC,IAAI,EACtB,sBAAsB,EACtB,mBAAmB,CAAC,SAAS,CAC9B,CAAC;IACF,qBAAqB,CAAC,cAAc,CAClC,iBAAiB,CAAC,MAAM,EACxB,sBAAsB,EACtB,mBAAmB,CAAC,SAAS,CAC9B,CAAC;IAEF,qBAAqB,CAAC,cAAc,CAClC,iBAAiB,CAAC,IAAI,EACtB,6BAA6B,EAC7B,mBAAmB,CAAC,eAAe,CACpC,CAAC;IACF,qBAAqB,CAAC,cAAc,CAClC,iBAAiB,CAAC,IAAI,EACtB,kBAAkB,CACnB,CAAC;IAEF,qBAAqB,CAAC,cAAc,CAClC,iBAAiB,CAAC,SAAS,EAC3B,2BAA2B,CAC5B,CAAC;IACF,qBAAqB,CAAC,cAAc,CAClC,iBAAiB,CAAC,QAAQ,EAC1B,sBAAsB,CACvB,CAAC;AACJ,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module PropertyEditors\n */\n\nimport { StandardEditorNames, StandardTypeNames } from \"@itwin/appui-abstract\";\nimport {\n  BasicPropertyEditor,\n  PropertyEditorManager,\n} from \"./PropertyEditorManager.js\";\nimport {\n  DateTimePropertyEditor,\n  ShortDateTimePropertyEditor,\n} from \"./DateTimeEditor.js\";\nimport { BooleanPropertyEditor } from \"./BooleanEditor.js\";\nimport { CustomNumberPropertyEditor } from \"./CustomNumberEditor.js\";\nimport { EnumPropertyButtonGroupEditor } from \"./EnumButtonGroupEditor.js\";\nimport { EnumPropertyEditor } from \"./EnumEditor.js\";\nimport { IconPropertyEditor } from \"./IconEditor.js\";\nimport { ImageCheckBoxPropertyEditor } from \"./ImageCheckBoxEditor.js\";\nimport { NumericInputPropertyEditor } from \"./NumericInputEditor.js\";\nimport { SliderPropertyEditor } from \"./SliderEditor.js\";\nimport { TextareaPropertyEditor } from \"./TextareaEditor.js\";\nimport { TogglePropertyEditor } from \"./ToggleEditor.js\";\n\n/** @internal */\nexport function registerEditors() {\n  PropertyEditorManager.registerEditor(\n    StandardTypeNames.Bool,\n    BooleanPropertyEditor\n  );\n  PropertyEditorManager.registerEditor(\n    StandardTypeNames.Boolean,\n    BooleanPropertyEditor\n  );\n  PropertyEditorManager.registerEditor(\n    StandardTypeNames.Boolean,\n    ImageCheckBoxPropertyEditor,\n    StandardEditorNames.ImageCheckBox\n  );\n  PropertyEditorManager.registerEditor(\n    StandardTypeNames.Bool,\n    ImageCheckBoxPropertyEditor,\n    StandardEditorNames.ImageCheckBox\n  );\n  PropertyEditorManager.registerEditor(\n    StandardTypeNames.Bool,\n    TogglePropertyEditor,\n    StandardEditorNames.Toggle\n  );\n  PropertyEditorManager.registerEditor(\n    StandardTypeNames.Boolean,\n    TogglePropertyEditor,\n    StandardEditorNames.Toggle\n  );\n\n  PropertyEditorManager.registerEditor(\n    StandardTypeNames.Number,\n    NumericInputPropertyEditor,\n    StandardEditorNames.NumericInput\n  );\n  PropertyEditorManager.registerEditor(\n    StandardTypeNames.Int,\n    NumericInputPropertyEditor,\n    StandardEditorNames.NumericInput\n  );\n  PropertyEditorManager.registerEditor(\n    StandardTypeNames.Float,\n    NumericInputPropertyEditor,\n    StandardEditorNames.NumericInput\n  );\n  PropertyEditorManager.registerEditor(\n    StandardTypeNames.Double,\n    NumericInputPropertyEditor,\n    StandardEditorNames.NumericInput\n  );\n  PropertyEditorManager.registerEditor(\n    StandardTypeNames.Number,\n    SliderPropertyEditor,\n    StandardEditorNames.Slider\n  );\n  PropertyEditorManager.registerEditor(\n    StandardTypeNames.Int,\n    SliderPropertyEditor,\n    StandardEditorNames.Slider\n  );\n  PropertyEditorManager.registerEditor(\n    StandardTypeNames.Float,\n    SliderPropertyEditor,\n    StandardEditorNames.Slider\n  );\n  PropertyEditorManager.registerEditor(\n    StandardTypeNames.Double,\n    SliderPropertyEditor,\n    StandardEditorNames.Slider\n  );\n  PropertyEditorManager.registerEditor(\n    StandardTypeNames.Number,\n    CustomNumberPropertyEditor,\n    StandardEditorNames.NumberCustom\n  );\n\n  PropertyEditorManager.registerEditor(\n    StandardTypeNames.Text,\n    BasicPropertyEditor\n  );\n  PropertyEditorManager.registerEditor(\n    StandardTypeNames.String,\n    BasicPropertyEditor\n  );\n  PropertyEditorManager.registerEditor(\n    StandardTypeNames.Text,\n    IconPropertyEditor,\n    StandardEditorNames.IconPicker\n  );\n  PropertyEditorManager.registerEditor(\n    StandardTypeNames.String,\n    IconPropertyEditor,\n    StandardEditorNames.IconPicker\n  );\n  PropertyEditorManager.registerEditor(\n    StandardTypeNames.Text,\n    TextareaPropertyEditor,\n    StandardEditorNames.MultiLine\n  );\n  PropertyEditorManager.registerEditor(\n    StandardTypeNames.String,\n    TextareaPropertyEditor,\n    StandardEditorNames.MultiLine\n  );\n\n  PropertyEditorManager.registerEditor(\n    StandardTypeNames.Enum,\n    EnumPropertyButtonGroupEditor,\n    StandardEditorNames.EnumButtonGroup\n  );\n  PropertyEditorManager.registerEditor(\n    StandardTypeNames.Enum,\n    EnumPropertyEditor\n  );\n\n  PropertyEditorManager.registerEditor(\n    StandardTypeNames.ShortDate,\n    ShortDateTimePropertyEditor\n  );\n  PropertyEditorManager.registerEditor(\n    StandardTypeNames.DateTime,\n    DateTimePropertyEditor\n  );\n}\n"]}

package/lib/components-react/editors/variables.scss

@@ -0,0 +1,10 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+@use "~@itwin/core-react/lib/core-react/inputs/variables";
+
+@forward "~@itwin/core-react/lib/core-react/inputs/variables";
+
+$editor-component-height-small: 24px;
+$editor-iui-input-padding: variables.$uicore-iui-input-padding;

package/lib/components-react/favorite/FavoritePropertiesRenderer.d.ts

@@ -0,0 +1,40 @@
+/** @packageDocumentation
+ * @module Favorite
+ */
+import * as React from "react";
+import type { PropertyData } from "../propertygrid/PropertyDataProvider.js";
+import type { Orientation } from "../common/Orientation.js";
+/**
+ * Basic recreation of the `createRoot` function type, intentionally not exported.
+ */
+type CreateRoot = (container: Element | DocumentFragment) => {
+    render(children: React.ReactNode): void;
+};
+/** Renderer for Favorite Property List
+ * @public
+ */
+export declare class FavoritePropertiesRenderer {
+    /**
+     * Evaluates if a PropertyData contain Favorite records.
+     * @param propertyData PropertyData containing records
+     * @returns true if it contains Favorite records
+     */
+    hasFavorites(propertyData: PropertyData): boolean;
+    /** Allow creating an HTMLElement containing the `<FavoritePropertyList />` component so it can be added outside of a React component (`showCard` is the main expected use)
+     * @param propertyData PropertyData containing Favorite records to display.
+     * @param orientation Orientation of the items
+     * @returns a `div` HTMLElement with the `<FavoritePropertyList />` rendered within it.
+     */
+    renderFavorites(propertyData: PropertyData, orientation?: Orientation): HTMLElement | string;
+    /** Allow creating an HTMLElement containing the `<FavoritePropertyList />` component so it can be added outside of a React component (`showCard` is the main expected use)
+     * @note Previously when using React18, in order to remove the `ReactDOM.render` warning you needed to provide the `createRoot` function. This function is no longer used.
+     * @param propertyData PropertyData containing Favorite records to display.
+     * @param orientation Orientation of the items
+     * @param createRoot `createRoot` function imported from `import { createRoot } from "react-dom/client";`
+     * @returns a `div` HTMLElement with the `<FavoritePropertyList />` rendered within it.
+     * @deprecated in 5.0.0. Use the overload without `createRoot` parameter instead.
+     */
+    renderFavorites(propertyData: PropertyData, orientation?: Orientation, _createRoot?: CreateRoot): HTMLElement | string;
+}
+export {};
+//# sourceMappingURL=FavoritePropertiesRenderer.d.ts.map

package/lib/components-react/favorite/FavoritePropertiesRenderer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FavoritePropertiesRenderer.d.ts","sourceRoot":"","sources":["../../../src/components-react/favorite/FavoritePropertiesRenderer.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yCAAyC,CAAC;AAE5E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAE5D;;GAEG;AACH,KAAK,UAAU,GAAG,CAAC,SAAS,EAAE,OAAO,GAAG,gBAAgB,KAAK;IAC3D,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC;CACzC,CAAC;AAEF;;GAEG;AACH,qBAAa,0BAA0B;IACrC;;;;OAIG;IACI,YAAY,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO;IAIxD;;;;OAIG;IACI,eAAe,CACpB,YAAY,EAAE,YAAY,EAC1B,WAAW,CAAC,EAAE,WAAW,GACxB,WAAW,GAAG,MAAM;IACvB;;;;;;;OAOG;IACI,eAAe,CACpB,YAAY,EAAE,YAAY,EAC1B,WAAW,CAAC,EAAE,WAAW,EAEzB,WAAW,CAAC,EAAE,UAAU,GACvB,WAAW,GAAG,MAAM;CAgBxB"}

package/lib/components-react/favorite/FavoritePropertiesRenderer.js

@@ -0,0 +1,31 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Favorite
+ */
+import * as React from "react";
+import { createRoot } from "react-dom/client";
+import { FavoritePropertyList } from "./FavoritePropertyList.js";
+/** Renderer for Favorite Property List
+ * @public
+ */
+export class FavoritePropertiesRenderer {
+    /**
+     * Evaluates if a PropertyData contain Favorite records.
+     * @param propertyData PropertyData containing records
+     * @returns true if it contains Favorite records
+     */
+    hasFavorites(propertyData) {
+        return propertyData.records.Favorite !== undefined;
+    }
+    renderFavorites(propertyData, orientation, _createRoot) {
+        const div = document.createElement("div");
+        const element = React.createElement(FavoritePropertyList, { propertyData, orientation }, null);
+        const root = createRoot(div);
+        root.render(element);
+        return div;
+    }
+}
+//# sourceMappingURL=FavoritePropertiesRenderer.js.map

package/lib/components-react/favorite/FavoritePropertiesRenderer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FavoritePropertiesRenderer.js","sourceRoot":"","sources":["../../../src/components-react/favorite/FavoritePropertiesRenderer.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAE9C,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAUjE;;GAEG;AACH,MAAM,OAAO,0BAA0B;IACrC;;;;OAIG;IACI,YAAY,CAAC,YAA0B;QAC5C,OAAO,YAAY,CAAC,OAAO,CAAC,QAAQ,KAAK,SAAS,CAAC;IACrD,CAAC;IAyBM,eAAe,CACpB,YAA0B,EAC1B,WAAyB,EACzB,WAAwB;QAExB,MAAM,GAAG,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC1C,MAAM,OAAO,GAAG,KAAK,CAAC,aAAa,CACjC,oBAAoB,EACpB,EAAE,YAAY,EAAE,WAAW,EAAE,EAC7B,IAAI,CACL,CAAC;QACF,MAAM,IAAI,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC;QAC7B,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACrB,OAAO,GAAG,CAAC;IACb,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 Favorite\n */\n\nimport * as React from \"react\";\nimport { createRoot } from \"react-dom/client\";\nimport type { PropertyData } from \"../propertygrid/PropertyDataProvider.js\";\nimport { FavoritePropertyList } from \"./FavoritePropertyList.js\";\nimport type { Orientation } from \"../common/Orientation.js\";\n\n/**\n * Basic recreation of the `createRoot` function type, intentionally not exported.\n */\ntype CreateRoot = (container: Element | DocumentFragment) => {\n  render(children: React.ReactNode): void;\n};\n\n/** Renderer for Favorite Property List\n * @public\n */\nexport class FavoritePropertiesRenderer {\n  /**\n   * Evaluates if a PropertyData contain Favorite records.\n   * @param propertyData PropertyData containing records\n   * @returns true if it contains Favorite records\n   */\n  public hasFavorites(propertyData: PropertyData): boolean {\n    return propertyData.records.Favorite !== undefined;\n  }\n\n  /** Allow creating an HTMLElement containing the `<FavoritePropertyList />` component so it can be added outside of a React component (`showCard` is the main expected use)\n   * @param propertyData PropertyData containing Favorite records to display.\n   * @param orientation Orientation of the items\n   * @returns a `div` HTMLElement with the `<FavoritePropertyList />` rendered within it.\n   */\n  public renderFavorites(\n    propertyData: PropertyData,\n    orientation?: Orientation\n  ): HTMLElement | string;\n  /** Allow creating an HTMLElement containing the `<FavoritePropertyList />` component so it can be added outside of a React component (`showCard` is the main expected use)\n   * @note Previously when using React18, in order to remove the `ReactDOM.render` warning you needed to provide the `createRoot` function. This function is no longer used.\n   * @param propertyData PropertyData containing Favorite records to display.\n   * @param orientation Orientation of the items\n   * @param createRoot `createRoot` function imported from `import { createRoot } from \"react-dom/client\";`\n   * @returns a `div` HTMLElement with the `<FavoritePropertyList />` rendered within it.\n   * @deprecated in 5.0.0. Use the overload without `createRoot` parameter instead.\n   */\n  public renderFavorites(\n    propertyData: PropertyData,\n    orientation?: Orientation,\n    // eslint-disable-next-line @typescript-eslint/unified-signatures\n    _createRoot?: CreateRoot\n  ): HTMLElement | string;\n  public renderFavorites(\n    propertyData: PropertyData,\n    orientation?: Orientation,\n    _createRoot?: CreateRoot\n  ): HTMLElement | string {\n    const div = document.createElement(\"div\");\n    const element = React.createElement(\n      FavoritePropertyList,\n      { propertyData, orientation },\n      null\n    );\n    const root = createRoot(div);\n    root.render(element);\n    return div;\n  }\n}\n"]}

package/lib/components-react/favorite/FavoritePropertyList.d.ts

@@ -0,0 +1,21 @@
+/** @packageDocumentation
+ * @module Favorite
+ */
+import * as React from "react";
+import { PropertyValueRendererManager } from "../properties/ValueRendererManager.js";
+import type { PropertyData } from "../propertygrid/PropertyDataProvider.js";
+import { Orientation } from "../common/Orientation.js";
+/** Properties for [[FavoritePropertyList]] React component
+ * @alpha
+ * @deprecated in 4.17.0. Use `React.ComponentProps<typeof FavoritePropertyList>`
+ */
+export interface FavoritePropertyListProps {
+    propertyData: PropertyData;
+    propertyValueRendererManager?: PropertyValueRendererManager;
+    orientation?: Orientation;
+}
+/** Favorite Property List React component
+ * @alpha
+ */
+export declare function FavoritePropertyList(props: FavoritePropertyListProps): React.JSX.Element | null;
+//# sourceMappingURL=FavoritePropertyList.d.ts.map

package/lib/components-react/favorite/FavoritePropertyList.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FavoritePropertyList.d.ts","sourceRoot":"","sources":["../../../src/components-react/favorite/FavoritePropertyList.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,4BAA4B,EAAE,MAAM,uCAAuC,CAAC;AAErF,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yCAAyC,CAAC;AAC5E,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,YAAY,EAAE,YAAY,CAAC;IAC3B,4BAA4B,CAAC,EAAE,4BAA4B,CAAC;IAC5D,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B;AAED;;GAEG;AAEH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,yBAAyB,4BAyBpE"}