@itwin/components-react 4.0.0-dev.3 → 4.0.0-dev.6

package/lib/esm/components-react/propertygrid/component/PropertyGridCommons.d.ts

@@ -1,87 +1,87 @@
-/** @packageDocumentation
- * @module PropertyGrid
- */
-/// <reference types="react" />
-import { PropertyRecord } from "@itwin/appui-abstract";
-import { CommonProps, Orientation } from "@itwin/core-react";
-import { PropertyUpdatedArgs } from "../../editors/EditorContainer";
-import { ActionButtonRenderer } from "../../properties/renderers/ActionButtonRenderer";
-import { PropertyValueRendererManager } from "../../properties/ValueRendererManager";
-import { PropertyCategory } from "../PropertyDataProvider";
-/** Arguments for the Property Editing event callback
- * @public
- */
-export interface PropertyEditingArgs {
-    /** PropertyRecord being edited  */
-    propertyRecord: PropertyRecord;
-    /** Unique key of currently edited property */
-    propertyKey?: string;
-}
-/** Arguments for `PropertyGridProps.onPropertyContextMenu` callback
- * @public
- */
-export interface PropertyGridContextMenuArgs {
-    /** PropertyRecord being edited  */
-    propertyRecord: PropertyRecord;
-    /** An event which caused the context menu callback */
-    event: React.MouseEvent;
-}
-/**
- * Common Property Grid Props to be used by Property Grid Variants
- * @public
- */
-export interface CommonPropertyGridProps extends CommonProps {
-    /** Grid orientation. When not defined, it is chosen automatically based on width of the grid. */
-    orientation?: Orientation;
-    /** Enables/disables property hovering effect */
-    isPropertyHoverEnabled?: boolean;
-    /** Called to show a context menu when properties are right-clicked */
-    onPropertyContextMenu?: (args: PropertyGridContextMenuArgs) => void;
-    /** Enables/disables property selection */
-    isPropertySelectionEnabled?: boolean;
-    /** Enables/disables property selection with right click */
-    isPropertySelectionOnRightClickEnabled?: boolean;
-    /** Callback to property selection */
-    onPropertySelectionChanged?: (property: PropertyRecord) => void;
-    /** Enables/disables property editing */
-    isPropertyEditingEnabled?: boolean;
-    /** Callback for when properties are being edited */
-    onPropertyEditing?: (args: PropertyEditingArgs, category: PropertyCategory) => void;
-    /** Callback for when properties are updated */
-    onPropertyUpdated?: (args: PropertyUpdatedArgs, category: PropertyCategory) => Promise<boolean>;
-    /** Custom property value renderer manager */
-    propertyValueRendererManager?: PropertyValueRendererManager;
-    /** Indicates whether the orientation is fixed and does not auto-switch to Vertical when the width is too narrow. Defaults to false. */
-    isOrientationFixed?: boolean;
-    /** The minimum width before the auto-switch to Vertical when the width is too narrow. Defaults to 300. */
-    horizontalOrientationMinWidth?: number;
-    /** Minimum allowed label column width, after which resizing stops */
-    minLabelWidth?: number;
-    /** Minimum allowed value column width, after which resizing stops */
-    minValueWidth?: number;
-    /** Fixed action button column width */
-    actionButtonWidth?: number;
-    /**
-     * Array of action button renderers. Each renderer is called for each property and can decide
-     * to render an action button for the property or not.
-     */
-    actionButtonRenderers?: ActionButtonRenderer[];
-}
-/** @internal */
-export declare class PropertyGridCommons {
-    static getCurrentOrientation(width: number, preferredOrientation?: Orientation, isOrientationFixed?: boolean, horizontalOrientationMinWidth?: number): Orientation;
-    /**
-     * Helper method to handle link clicks
-     * @internal
-     */
-    static handleLinkClick(text: string): void;
-    /**
-     * A helper method to get links from string.
-     * @internal
-     */
-    static getLinks: (value: string) => Array<{
-        start: number;
-        end: number;
-    }>;
-}
+/** @packageDocumentation
+ * @module PropertyGrid
+ */
+/// <reference types="react" />
+import { PropertyRecord } from "@itwin/appui-abstract";
+import { CommonProps, Orientation } from "@itwin/core-react";
+import { PropertyUpdatedArgs } from "../../editors/EditorContainer";
+import { ActionButtonRenderer } from "../../properties/renderers/ActionButtonRenderer";
+import { PropertyValueRendererManager } from "../../properties/ValueRendererManager";
+import { PropertyCategory } from "../PropertyDataProvider";
+/** Arguments for the Property Editing event callback
+ * @public
+ */
+export interface PropertyEditingArgs {
+    /** PropertyRecord being edited  */
+    propertyRecord: PropertyRecord;
+    /** Unique key of currently edited property */
+    propertyKey?: string;
+}
+/** Arguments for `PropertyGridProps.onPropertyContextMenu` callback
+ * @public
+ */
+export interface PropertyGridContextMenuArgs {
+    /** PropertyRecord being edited  */
+    propertyRecord: PropertyRecord;
+    /** An event which caused the context menu callback */
+    event: React.MouseEvent;
+}
+/**
+ * Common Property Grid Props to be used by Property Grid Variants
+ * @public
+ */
+export interface CommonPropertyGridProps extends CommonProps {
+    /** Grid orientation. When not defined, it is chosen automatically based on width of the grid. */
+    orientation?: Orientation;
+    /** Enables/disables property hovering effect */
+    isPropertyHoverEnabled?: boolean;
+    /** Called to show a context menu when properties are right-clicked */
+    onPropertyContextMenu?: (args: PropertyGridContextMenuArgs) => void;
+    /** Enables/disables property selection */
+    isPropertySelectionEnabled?: boolean;
+    /** Enables/disables property selection with right click */
+    isPropertySelectionOnRightClickEnabled?: boolean;
+    /** Callback to property selection */
+    onPropertySelectionChanged?: (property: PropertyRecord) => void;
+    /** Enables/disables property editing */
+    isPropertyEditingEnabled?: boolean;
+    /** Callback for when properties are being edited */
+    onPropertyEditing?: (args: PropertyEditingArgs, category: PropertyCategory) => void;
+    /** Callback for when properties are updated */
+    onPropertyUpdated?: (args: PropertyUpdatedArgs, category: PropertyCategory) => Promise<boolean>;
+    /** Custom property value renderer manager */
+    propertyValueRendererManager?: PropertyValueRendererManager;
+    /** Indicates whether the orientation is fixed and does not auto-switch to Vertical when the width is too narrow. Defaults to false. */
+    isOrientationFixed?: boolean;
+    /** The minimum width before the auto-switch to Vertical when the width is too narrow. Defaults to 300. */
+    horizontalOrientationMinWidth?: number;
+    /** Minimum allowed label column width, after which resizing stops */
+    minLabelWidth?: number;
+    /** Minimum allowed value column width, after which resizing stops */
+    minValueWidth?: number;
+    /** Fixed action button column width */
+    actionButtonWidth?: number;
+    /**
+     * Array of action button renderers. Each renderer is called for each property and can decide
+     * to render an action button for the property or not.
+     */
+    actionButtonRenderers?: ActionButtonRenderer[];
+}
+/** @internal */
+export declare class PropertyGridCommons {
+    static getCurrentOrientation(width: number, preferredOrientation?: Orientation, isOrientationFixed?: boolean, horizontalOrientationMinWidth?: number): Orientation;
+    /**
+     * Helper method to handle link clicks
+     * @internal
+     */
+    static handleLinkClick(text: string): void;
+    /**
+     * A helper method to get links from string.
+     * @internal
+     */
+    static getLinks: (value: string) => Array<{
+        start: number;
+        end: number;
+    }>;
+}
 //# sourceMappingURL=PropertyGridCommons.d.ts.map

package/lib/esm/components-react/propertygrid/component/PropertyGridCommons.js

@@ -1,52 +1,52 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module PropertyGrid
- */
-import { Orientation } from "@itwin/core-react";
-import { matchLinks } from "../../common/Links";
-/** @internal */
-export class PropertyGridCommons {
-    static getCurrentOrientation(width, preferredOrientation, isOrientationFixed, horizontalOrientationMinWidth) {
-        const orientation = preferredOrientation !== null && preferredOrientation !== void 0 ? preferredOrientation : Orientation.Horizontal;
-        if (isOrientationFixed)
-            return orientation;
-        horizontalOrientationMinWidth = horizontalOrientationMinWidth !== null && horizontalOrientationMinWidth !== void 0 ? horizontalOrientationMinWidth : 300;
-        // Switch to Vertical if width too small
-        if (width < horizontalOrientationMinWidth)
-            return Orientation.Vertical;
-        return orientation;
-    }
-    /**
-     * Helper method to handle link clicks
-     * @internal
-     */
-    static handleLinkClick(text) {
-        const linksArray = matchLinks(text);
-        if (linksArray.length <= 0)
-            return;
-        const foundLink = linksArray[0];
-        // istanbul ignore else
-        if (foundLink && foundLink.url) {
-            if (foundLink.schema === "mailto:" || foundLink.schema === "pw:")
-                location.href = foundLink.url;
-            else {
-                const windowOpen = window.open(foundLink.url, "_blank");
-                if (windowOpen)
-                    windowOpen.focus();
-            }
-        }
-    }
-}
-/**
- * A helper method to get links from string.
- * @internal
- */
-PropertyGridCommons.getLinks = (value) => {
-    return matchLinks(value).map((linkInfo) => {
-        return { start: linkInfo.index, end: linkInfo.lastIndex };
-    });
-};
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module PropertyGrid
+ */
+import { Orientation } from "@itwin/core-react";
+import { matchLinks } from "../../common/Links";
+/** @internal */
+export class PropertyGridCommons {
+    static getCurrentOrientation(width, preferredOrientation, isOrientationFixed, horizontalOrientationMinWidth) {
+        const orientation = preferredOrientation !== null && preferredOrientation !== void 0 ? preferredOrientation : Orientation.Horizontal;
+        if (isOrientationFixed)
+            return orientation;
+        horizontalOrientationMinWidth = horizontalOrientationMinWidth !== null && horizontalOrientationMinWidth !== void 0 ? horizontalOrientationMinWidth : 300;
+        // Switch to Vertical if width too small
+        if (width < horizontalOrientationMinWidth)
+            return Orientation.Vertical;
+        return orientation;
+    }
+    /**
+     * Helper method to handle link clicks
+     * @internal
+     */
+    static handleLinkClick(text) {
+        const linksArray = matchLinks(text);
+        if (linksArray.length <= 0)
+            return;
+        const foundLink = linksArray[0];
+        // istanbul ignore else
+        if (foundLink && foundLink.url) {
+            if (foundLink.schema === "mailto:" || foundLink.schema === "pw:")
+                location.href = foundLink.url;
+            else {
+                const windowOpen = window.open(foundLink.url, "_blank");
+                if (windowOpen)
+                    windowOpen.focus();
+            }
+        }
+    }
+}
+/**
+ * A helper method to get links from string.
+ * @internal
+ */
+PropertyGridCommons.getLinks = (value) => {
+    return matchLinks(value).map((linkInfo) => {
+        return { start: linkInfo.index, end: linkInfo.lastIndex };
+    });
+};
 //# sourceMappingURL=PropertyGridCommons.js.map

package/lib/esm/components-react/propertygrid/component/PropertyGridCommons.js.map

@@ -1 +1 @@
-{"version":3,"file":"PropertyGridCommons.js","sourceRoot":"","sources":["../../../../../src/components-react/propertygrid/component/PropertyGridCommons.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EAAe,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAC7D,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AA4EhD,gBAAgB;AAChB,MAAM,OAAO,mBAAmB;IACvB,MAAM,CAAC,qBAAqB,CAAC,KAAa,EAAE,oBAAkC,EAAE,kBAA4B,EAAE,6BAAsC;QACzJ,MAAM,WAAW,GAAG,oBAAoB,aAApB,oBAAoB,cAApB,oBAAoB,GAAI,WAAW,CAAC,UAAU,CAAC;QACnE,IAAI,kBAAkB;YACpB,OAAO,WAAW,CAAC;QAErB,6BAA6B,GAAG,6BAA6B,aAA7B,6BAA6B,cAA7B,6BAA6B,GAAI,GAAG,CAAC;QACrE,wCAAwC;QACxC,IAAI,KAAK,GAAG,6BAA6B;YACvC,OAAO,WAAW,CAAC,QAAQ,CAAC;QAE9B,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,eAAe,CAAC,IAAY;QACxC,MAAM,UAAU,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;QACpC,IAAI,UAAU,CAAC,MAAM,IAAI,CAAC;YACxB,OAAO;QACT,MAAM,SAAS,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;QAChC,uBAAuB;QACvB,IAAI,SAAS,IAAI,SAAS,CAAC,GAAG,EAAE;YAC9B,IAAI,SAAS,CAAC,MAAM,KAAK,SAAS,IAAI,SAAS,CAAC,MAAM,KAAK,KAAK;gBAC9D,QAAQ,CAAC,IAAI,GAAG,SAAS,CAAC,GAAG,CAAC;iBAC3B;gBACH,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;gBACxD,IAAI,UAAU;oBACZ,UAAU,CAAC,KAAK,EAAE,CAAC;aACtB;SACF;IACH,CAAC;;AAED;;;GAGG;AACW,4BAAQ,GAAG,CAAC,KAAa,EAAyC,EAAE;IAChF,OAAO,UAAU,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,QAA8C,EAAE,EAAE;QAC9E,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAC,KAAK,EAAE,GAAG,EAAE,QAAQ,CAAC,SAAS,EAAE,CAAC;IAC5D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module PropertyGrid\n */\n\nimport { PropertyRecord } from \"@itwin/appui-abstract\";\nimport { CommonProps, Orientation } from \"@itwin/core-react\";\nimport { matchLinks } from \"../../common/Links\";\nimport { PropertyUpdatedArgs } from \"../../editors/EditorContainer\";\nimport { ActionButtonRenderer } from \"../../properties/renderers/ActionButtonRenderer\";\nimport { PropertyValueRendererManager } from \"../../properties/ValueRendererManager\";\nimport { PropertyCategory } from \"../PropertyDataProvider\";\n\n/** Arguments for the Property Editing event callback\n * @public\n */\nexport interface PropertyEditingArgs {\n  /** PropertyRecord being edited  */\n  propertyRecord: PropertyRecord;\n  /** Unique key of currently edited property */\n  propertyKey?: string;\n}\n\n/** Arguments for `PropertyGridProps.onPropertyContextMenu` callback\n * @public\n */\nexport interface PropertyGridContextMenuArgs {\n  /** PropertyRecord being edited  */\n  propertyRecord: PropertyRecord;\n  /** An event which caused the context menu callback */\n  event: React.MouseEvent;\n}\n\n/**\n * Common Property Grid Props to be used by Property Grid Variants\n * @public\n */\nexport interface CommonPropertyGridProps extends CommonProps {\n  /** Grid orientation. When not defined, it is chosen automatically based on width of the grid. */\n  orientation?: Orientation;\n\n  /** Enables/disables property hovering effect */\n  isPropertyHoverEnabled?: boolean;\n\n  /** Called to show a context menu when properties are right-clicked */\n  onPropertyContextMenu?: (args: PropertyGridContextMenuArgs) => void;\n\n  /** Enables/disables property selection */\n  isPropertySelectionEnabled?: boolean;\n  /** Enables/disables property selection with right click */\n  isPropertySelectionOnRightClickEnabled?: boolean;\n  /** Callback to property selection */\n  onPropertySelectionChanged?: (property: PropertyRecord) => void;\n\n  /** Enables/disables property editing */\n  isPropertyEditingEnabled?: boolean;\n  /** Callback for when properties are being edited */\n  onPropertyEditing?: (args: PropertyEditingArgs, category: PropertyCategory) => void;\n  /** Callback for when properties are updated */\n  onPropertyUpdated?: (args: PropertyUpdatedArgs, category: PropertyCategory) => Promise<boolean>;\n\n  /** Custom property value renderer manager */\n  propertyValueRendererManager?: PropertyValueRendererManager;\n\n  /** Indicates whether the orientation is fixed and does not auto-switch to Vertical when the width is too narrow. Defaults to false. */\n  isOrientationFixed?: boolean;\n  /** The minimum width before the auto-switch to Vertical when the width is too narrow. Defaults to 300. */\n  horizontalOrientationMinWidth?: number;\n\n  /** Minimum allowed label column width, after which resizing stops */\n  minLabelWidth?: number;\n  /** Minimum allowed value column width, after which resizing stops */\n  minValueWidth?: number;\n  /** Fixed action button column width */\n  actionButtonWidth?: number;\n\n  /**\n   * Array of action button renderers. Each renderer is called for each property and can decide\n   * to render an action button for the property or not.\n   */\n  actionButtonRenderers?: ActionButtonRenderer[];\n}\n\n/** @internal */\nexport class PropertyGridCommons {\n  public static getCurrentOrientation(width: number, preferredOrientation?: Orientation, isOrientationFixed?: boolean, horizontalOrientationMinWidth?: number): Orientation {\n    const orientation = preferredOrientation ?? Orientation.Horizontal;\n    if (isOrientationFixed)\n      return orientation;\n\n    horizontalOrientationMinWidth = horizontalOrientationMinWidth ?? 300;\n    // Switch to Vertical if width too small\n    if (width < horizontalOrientationMinWidth)\n      return Orientation.Vertical;\n\n    return orientation;\n  }\n\n  /**\n   * Helper method to handle link clicks\n   * @internal\n   */\n  public static handleLinkClick(text: string) {\n    const linksArray = matchLinks(text);\n    if (linksArray.length <= 0)\n      return;\n    const foundLink = linksArray[0];\n    // istanbul ignore else\n    if (foundLink && foundLink.url) {\n      if (foundLink.schema === \"mailto:\" || foundLink.schema === \"pw:\")\n        location.href = foundLink.url;\n      else {\n        const windowOpen = window.open(foundLink.url, \"_blank\");\n        if (windowOpen)\n          windowOpen.focus();\n      }\n    }\n  }\n\n  /**\n   * A helper method to get links from string.\n   * @internal\n   */\n  public static getLinks = (value: string): Array<{ start: number, end: number }> => {\n    return matchLinks(value).map((linkInfo: { index: number, lastIndex: number }) => {\n      return { start: linkInfo.index, end: linkInfo.lastIndex };\n    });\n  };\n}\n"]}
+{"version":3,"file":"PropertyGridCommons.js","sourceRoot":"","sources":["../../../../../src/components-react/propertygrid/component/PropertyGridCommons.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EAAe,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAC7D,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AA4EhD,gBAAgB;AAChB,MAAM,OAAO,mBAAmB;IACvB,MAAM,CAAC,qBAAqB,CAAC,KAAa,EAAE,oBAAkC,EAAE,kBAA4B,EAAE,6BAAsC;QACzJ,MAAM,WAAW,GAAG,oBAAoB,aAApB,oBAAoB,cAApB,oBAAoB,GAAI,WAAW,CAAC,UAAU,CAAC;QACnE,IAAI,kBAAkB;YACpB,OAAO,WAAW,CAAC;QAErB,6BAA6B,GAAG,6BAA6B,aAA7B,6BAA6B,cAA7B,6BAA6B,GAAI,GAAG,CAAC;QACrE,wCAAwC;QACxC,IAAI,KAAK,GAAG,6BAA6B;YACvC,OAAO,WAAW,CAAC,QAAQ,CAAC;QAE9B,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,eAAe,CAAC,IAAY;QACxC,MAAM,UAAU,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;QACpC,IAAI,UAAU,CAAC,MAAM,IAAI,CAAC;YACxB,OAAO;QACT,MAAM,SAAS,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;QAChC,uBAAuB;QACvB,IAAI,SAAS,IAAI,SAAS,CAAC,GAAG,EAAE;YAC9B,IAAI,SAAS,CAAC,MAAM,KAAK,SAAS,IAAI,SAAS,CAAC,MAAM,KAAK,KAAK;gBAC9D,QAAQ,CAAC,IAAI,GAAG,SAAS,CAAC,GAAG,CAAC;iBAC3B;gBACH,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;gBACxD,IAAI,UAAU;oBACZ,UAAU,CAAC,KAAK,EAAE,CAAC;aACtB;SACF;IACH,CAAC;;AAED;;;GAGG;AACW,4BAAQ,GAAG,CAAC,KAAa,EAAyC,EAAE;IAChF,OAAO,UAAU,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,QAA8C,EAAE,EAAE;QAC9E,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAC,KAAK,EAAE,GAAG,EAAE,QAAQ,CAAC,SAAS,EAAE,CAAC;IAC5D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PropertyGrid\r\n */\r\n\r\nimport { PropertyRecord } from \"@itwin/appui-abstract\";\r\nimport { CommonProps, Orientation } from \"@itwin/core-react\";\r\nimport { matchLinks } from \"../../common/Links\";\r\nimport { PropertyUpdatedArgs } from \"../../editors/EditorContainer\";\r\nimport { ActionButtonRenderer } from \"../../properties/renderers/ActionButtonRenderer\";\r\nimport { PropertyValueRendererManager } from \"../../properties/ValueRendererManager\";\r\nimport { PropertyCategory } from \"../PropertyDataProvider\";\r\n\r\n/** Arguments for the Property Editing event callback\r\n * @public\r\n */\r\nexport interface PropertyEditingArgs {\r\n  /** PropertyRecord being edited  */\r\n  propertyRecord: PropertyRecord;\r\n  /** Unique key of currently edited property */\r\n  propertyKey?: string;\r\n}\r\n\r\n/** Arguments for `PropertyGridProps.onPropertyContextMenu` callback\r\n * @public\r\n */\r\nexport interface PropertyGridContextMenuArgs {\r\n  /** PropertyRecord being edited  */\r\n  propertyRecord: PropertyRecord;\r\n  /** An event which caused the context menu callback */\r\n  event: React.MouseEvent;\r\n}\r\n\r\n/**\r\n * Common Property Grid Props to be used by Property Grid Variants\r\n * @public\r\n */\r\nexport interface CommonPropertyGridProps extends CommonProps {\r\n  /** Grid orientation. When not defined, it is chosen automatically based on width of the grid. */\r\n  orientation?: Orientation;\r\n\r\n  /** Enables/disables property hovering effect */\r\n  isPropertyHoverEnabled?: boolean;\r\n\r\n  /** Called to show a context menu when properties are right-clicked */\r\n  onPropertyContextMenu?: (args: PropertyGridContextMenuArgs) => void;\r\n\r\n  /** Enables/disables property selection */\r\n  isPropertySelectionEnabled?: boolean;\r\n  /** Enables/disables property selection with right click */\r\n  isPropertySelectionOnRightClickEnabled?: boolean;\r\n  /** Callback to property selection */\r\n  onPropertySelectionChanged?: (property: PropertyRecord) => void;\r\n\r\n  /** Enables/disables property editing */\r\n  isPropertyEditingEnabled?: boolean;\r\n  /** Callback for when properties are being edited */\r\n  onPropertyEditing?: (args: PropertyEditingArgs, category: PropertyCategory) => void;\r\n  /** Callback for when properties are updated */\r\n  onPropertyUpdated?: (args: PropertyUpdatedArgs, category: PropertyCategory) => Promise<boolean>;\r\n\r\n  /** Custom property value renderer manager */\r\n  propertyValueRendererManager?: PropertyValueRendererManager;\r\n\r\n  /** Indicates whether the orientation is fixed and does not auto-switch to Vertical when the width is too narrow. Defaults to false. */\r\n  isOrientationFixed?: boolean;\r\n  /** The minimum width before the auto-switch to Vertical when the width is too narrow. Defaults to 300. */\r\n  horizontalOrientationMinWidth?: number;\r\n\r\n  /** Minimum allowed label column width, after which resizing stops */\r\n  minLabelWidth?: number;\r\n  /** Minimum allowed value column width, after which resizing stops */\r\n  minValueWidth?: number;\r\n  /** Fixed action button column width */\r\n  actionButtonWidth?: number;\r\n\r\n  /**\r\n   * Array of action button renderers. Each renderer is called for each property and can decide\r\n   * to render an action button for the property or not.\r\n   */\r\n  actionButtonRenderers?: ActionButtonRenderer[];\r\n}\r\n\r\n/** @internal */\r\nexport class PropertyGridCommons {\r\n  public static getCurrentOrientation(width: number, preferredOrientation?: Orientation, isOrientationFixed?: boolean, horizontalOrientationMinWidth?: number): Orientation {\r\n    const orientation = preferredOrientation ?? Orientation.Horizontal;\r\n    if (isOrientationFixed)\r\n      return orientation;\r\n\r\n    horizontalOrientationMinWidth = horizontalOrientationMinWidth ?? 300;\r\n    // Switch to Vertical if width too small\r\n    if (width < horizontalOrientationMinWidth)\r\n      return Orientation.Vertical;\r\n\r\n    return orientation;\r\n  }\r\n\r\n  /**\r\n   * Helper method to handle link clicks\r\n   * @internal\r\n   */\r\n  public static handleLinkClick(text: string) {\r\n    const linksArray = matchLinks(text);\r\n    if (linksArray.length <= 0)\r\n      return;\r\n    const foundLink = linksArray[0];\r\n    // istanbul ignore else\r\n    if (foundLink && foundLink.url) {\r\n      if (foundLink.schema === \"mailto:\" || foundLink.schema === \"pw:\")\r\n        location.href = foundLink.url;\r\n      else {\r\n        const windowOpen = window.open(foundLink.url, \"_blank\");\r\n        if (windowOpen)\r\n          windowOpen.focus();\r\n      }\r\n    }\r\n  }\r\n\r\n  /**\r\n   * A helper method to get links from string.\r\n   * @internal\r\n   */\r\n  public static getLinks = (value: string): Array<{ start: number, end: number }> => {\r\n    return matchLinks(value).map((linkInfo: { index: number, lastIndex: number }) => {\r\n      return { start: linkInfo.index, end: linkInfo.lastIndex };\r\n    });\r\n  };\r\n}\r\n"]}

package/lib/esm/components-react/propertygrid/component/PropertyGridEventsRelatedPropsSupplier.d.ts

@@ -1,44 +1,44 @@
-/** @packageDocumentation
- * @module PropertyGrid
- */
-import "./PropertyGrid.scss";
-import * as React from "react";
-import { CommonPropertyGridProps } from "./PropertyGridCommons";
-import { PropertyListProps } from "./PropertyList";
-/** @internal */
-export declare type PropertyGridEventsRelatedProps = Pick<PropertyListProps, "onPropertyClicked" | "onPropertyRightClicked" | "onPropertyContextMenu" | "onEditCommit" | "onEditCancel" | "selectedPropertyKey" | "editingPropertyKey"> & Pick<CommonPropertyGridProps, "isPropertySelectionOnRightClickEnabled" | "isPropertyEditingEnabled"> & Required<Pick<CommonPropertyGridProps, "isPropertyHoverEnabled" | "isPropertySelectionEnabled">>;
-/** Properties for [[PropertyGridEventsRelatedPropsSupplier]] React component
- * @internal
- */
-export declare type PropertyGridEventsRelatedPropsSupplierProps = Pick<CommonPropertyGridProps, "onPropertyContextMenu" | "isPropertySelectionOnRightClickEnabled" | "isPropertySelectionOnRightClickEnabled" | "onPropertySelectionChanged" | "isPropertyEditingEnabled" | "onPropertyUpdated"> & Required<Pick<CommonPropertyGridProps, "isPropertyHoverEnabled" | "isPropertySelectionEnabled">> & {
-    children: (context: PropertyGridEventsRelatedProps) => React.ReactNode;
-};
-/** State of [[PropertyGridEventsRelatedPropsSupplier]] React component
- * @internal
- */
-interface PropertyGridEventsRelatedPropsSupplierState {
-    /** Unique key of currently selected property */
-    selectedPropertyKey?: string;
-    /** Unique key of currently edited property */
-    editingPropertyKey?: string;
-}
-/** PropertyGridEventsRelatedPropsSupplier React component.
- * @internal
- */
-export declare class PropertyGridEventsRelatedPropsSupplier extends React.Component<PropertyGridEventsRelatedPropsSupplierProps, PropertyGridEventsRelatedPropsSupplierState> {
-    /** @internal */
-    constructor(props: PropertyGridEventsRelatedPropsSupplierProps);
-    private _isClickSupported;
-    private _isRightClickSupported;
-    private _onPropertyRightClicked;
-    private _onPropertyClicked;
-    private _onPropertyContextMenu;
-    private _onEditCommit;
-    private _onEditCancel;
-    private onEnabledPropertyRightClicked;
-    private onEnabledPropertyLeftClicked;
-    /** @internal */
-    render(): JSX.Element;
-}
-export {};
+/** @packageDocumentation
+ * @module PropertyGrid
+ */
+import "./PropertyGrid.scss";
+import * as React from "react";
+import { CommonPropertyGridProps } from "./PropertyGridCommons";
+import { PropertyListProps } from "./PropertyList";
+/** @internal */
+export declare type PropertyGridEventsRelatedProps = Pick<PropertyListProps, "onPropertyClicked" | "onPropertyRightClicked" | "onPropertyContextMenu" | "onEditCommit" | "onEditCancel" | "selectedPropertyKey" | "editingPropertyKey"> & Pick<CommonPropertyGridProps, "isPropertySelectionOnRightClickEnabled" | "isPropertyEditingEnabled"> & Required<Pick<CommonPropertyGridProps, "isPropertyHoverEnabled" | "isPropertySelectionEnabled">>;
+/** Properties for [[PropertyGridEventsRelatedPropsSupplier]] React component
+ * @internal
+ */
+export declare type PropertyGridEventsRelatedPropsSupplierProps = Pick<CommonPropertyGridProps, "onPropertyContextMenu" | "isPropertySelectionOnRightClickEnabled" | "isPropertySelectionOnRightClickEnabled" | "onPropertySelectionChanged" | "isPropertyEditingEnabled" | "onPropertyUpdated"> & Required<Pick<CommonPropertyGridProps, "isPropertyHoverEnabled" | "isPropertySelectionEnabled">> & {
+    children: (context: PropertyGridEventsRelatedProps) => React.ReactNode;
+};
+/** State of [[PropertyGridEventsRelatedPropsSupplier]] React component
+ * @internal
+ */
+interface PropertyGridEventsRelatedPropsSupplierState {
+    /** Unique key of currently selected property */
+    selectedPropertyKey?: string;
+    /** Unique key of currently edited property */
+    editingPropertyKey?: string;
+}
+/** PropertyGridEventsRelatedPropsSupplier React component.
+ * @internal
+ */
+export declare class PropertyGridEventsRelatedPropsSupplier extends React.Component<PropertyGridEventsRelatedPropsSupplierProps, PropertyGridEventsRelatedPropsSupplierState> {
+    /** @internal */
+    constructor(props: PropertyGridEventsRelatedPropsSupplierProps);
+    private _isClickSupported;
+    private _isRightClickSupported;
+    private _onPropertyRightClicked;
+    private _onPropertyClicked;
+    private _onPropertyContextMenu;
+    private _onEditCommit;
+    private _onEditCancel;
+    private onEnabledPropertyRightClicked;
+    private onEnabledPropertyLeftClicked;
+    /** @internal */
+    render(): JSX.Element;
+}
+export {};
 //# sourceMappingURL=PropertyGridEventsRelatedPropsSupplier.d.ts.map

package/lib/esm/components-react/propertygrid/component/PropertyGridEventsRelatedPropsSupplier.js

@@ -1,99 +1,99 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module PropertyGrid
- */
-import "./PropertyGrid.scss";
-import * as React from "react";
-import { PropertyValueFormat } from "@itwin/appui-abstract";
-/** PropertyGridEventsRelatedPropsSupplier React component.
- * @internal
- */
-export class PropertyGridEventsRelatedPropsSupplier extends React.Component {
-    /** @internal */
-    constructor(props) {
-        super(props);
-        this._onPropertyRightClicked = (property, key) => {
-            // istanbul ignore else
-            if (this._isRightClickSupported())
-                this.onEnabledPropertyRightClicked(property, key);
-        };
-        this._onPropertyClicked = (property, key) => {
-            // istanbul ignore else
-            if (this._isClickSupported())
-                this.onEnabledPropertyLeftClicked(property, key);
-        };
-        this._onPropertyContextMenu = (property, e) => {
-            if (this.props.onPropertyContextMenu) {
-                this.props.onPropertyContextMenu({ propertyRecord: property, event: e });
-            }
-        };
-        this._onEditCommit = async (args, category) => {
-            // istanbul ignore else
-            if (this.props.onPropertyUpdated) {
-                await this.props.onPropertyUpdated(args, category);
-                this.setState({ editingPropertyKey: undefined });
-            }
-        };
-        this._onEditCancel = () => {
-            this.setState({ editingPropertyKey: undefined });
-        };
-        this.state = {};
-    }
-    _isClickSupported() {
-        return this.props.isPropertySelectionEnabled || this.props.isPropertyEditingEnabled;
-    }
-    _isRightClickSupported() {
-        return this.props.isPropertySelectionOnRightClickEnabled;
-    }
-    onEnabledPropertyRightClicked(property, key) {
-        let selectedPropertyKey = this.state.selectedPropertyKey;
-        let editingPropertyKey = this.state.editingPropertyKey;
-        editingPropertyKey = undefined;
-        if (selectedPropertyKey !== key)
-            selectedPropertyKey = key;
-        if (this.props.onPropertySelectionChanged)
-            this.props.onPropertySelectionChanged(property);
-        this.setState({ selectedPropertyKey, editingPropertyKey });
-    }
-    onEnabledPropertyLeftClicked(property, key) {
-        let selectedPropertyKey = this.state.selectedPropertyKey;
-        let editingPropertyKey = this.state.editingPropertyKey;
-        const isValuePrimitive = property.value.valueFormat === PropertyValueFormat.Primitive;
-        const isEditingEnabled = this.props.isPropertyEditingEnabled;
-        const isSelectionEnabled = this.props.isPropertySelectionEnabled;
-        if (isEditingEnabled && isValuePrimitive) {
-            // Deselect editing key only if another selection was made
-            editingPropertyKey = isSelectionEnabled && selectedPropertyKey !== key ? undefined : key;
-        }
-        if (editingPropertyKey === key) {
-            this.setState({ editingPropertyKey });
-            return;
-        }
-        // Select/Deselect
-        selectedPropertyKey = selectedPropertyKey !== key ? key : undefined;
-        if (this.props.onPropertySelectionChanged)
-            this.props.onPropertySelectionChanged(property);
-        this.setState({ selectedPropertyKey, editingPropertyKey });
-    }
-    /** @internal */
-    render() {
-        const renderContext = {
-            isPropertyHoverEnabled: this.props.isPropertyHoverEnabled,
-            isPropertySelectionEnabled: this.props.isPropertySelectionEnabled,
-            isPropertySelectionOnRightClickEnabled: this.props.isPropertySelectionOnRightClickEnabled,
-            isPropertyEditingEnabled: this.props.isPropertyEditingEnabled,
-            selectedPropertyKey: this.state.selectedPropertyKey,
-            editingPropertyKey: this.state.editingPropertyKey,
-            onEditCommit: this._onEditCommit,
-            onEditCancel: this._onEditCancel,
-            onPropertyClicked: this._isClickSupported() ? this._onPropertyClicked : undefined,
-            onPropertyRightClicked: this._isRightClickSupported() ? this._onPropertyRightClicked : undefined,
-            onPropertyContextMenu: this._onPropertyContextMenu,
-        };
-        return (React.createElement(React.Fragment, null, this.props.children(renderContext)));
-    }
-}
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module PropertyGrid
+ */
+import "./PropertyGrid.scss";
+import * as React from "react";
+import { PropertyValueFormat } from "@itwin/appui-abstract";
+/** PropertyGridEventsRelatedPropsSupplier React component.
+ * @internal
+ */
+export class PropertyGridEventsRelatedPropsSupplier extends React.Component {
+    /** @internal */
+    constructor(props) {
+        super(props);
+        this._onPropertyRightClicked = (property, key) => {
+            // istanbul ignore else
+            if (this._isRightClickSupported())
+                this.onEnabledPropertyRightClicked(property, key);
+        };
+        this._onPropertyClicked = (property, key) => {
+            // istanbul ignore else
+            if (this._isClickSupported())
+                this.onEnabledPropertyLeftClicked(property, key);
+        };
+        this._onPropertyContextMenu = (property, e) => {
+            if (this.props.onPropertyContextMenu) {
+                this.props.onPropertyContextMenu({ propertyRecord: property, event: e });
+            }
+        };
+        this._onEditCommit = async (args, category) => {
+            // istanbul ignore else
+            if (this.props.onPropertyUpdated) {
+                await this.props.onPropertyUpdated(args, category);
+                this.setState({ editingPropertyKey: undefined });
+            }
+        };
+        this._onEditCancel = () => {
+            this.setState({ editingPropertyKey: undefined });
+        };
+        this.state = {};
+    }
+    _isClickSupported() {
+        return this.props.isPropertySelectionEnabled || this.props.isPropertyEditingEnabled;
+    }
+    _isRightClickSupported() {
+        return this.props.isPropertySelectionOnRightClickEnabled;
+    }
+    onEnabledPropertyRightClicked(property, key) {
+        let selectedPropertyKey = this.state.selectedPropertyKey;
+        let editingPropertyKey = this.state.editingPropertyKey;
+        editingPropertyKey = undefined;
+        if (selectedPropertyKey !== key)
+            selectedPropertyKey = key;
+        if (this.props.onPropertySelectionChanged)
+            this.props.onPropertySelectionChanged(property);
+        this.setState({ selectedPropertyKey, editingPropertyKey });
+    }
+    onEnabledPropertyLeftClicked(property, key) {
+        let selectedPropertyKey = this.state.selectedPropertyKey;
+        let editingPropertyKey = this.state.editingPropertyKey;
+        const isValuePrimitive = property.value.valueFormat === PropertyValueFormat.Primitive;
+        const isEditingEnabled = this.props.isPropertyEditingEnabled;
+        const isSelectionEnabled = this.props.isPropertySelectionEnabled;
+        if (isEditingEnabled && isValuePrimitive) {
+            // Deselect editing key only if another selection was made
+            editingPropertyKey = isSelectionEnabled && selectedPropertyKey !== key ? undefined : key;
+        }
+        if (editingPropertyKey === key) {
+            this.setState({ editingPropertyKey });
+            return;
+        }
+        // Select/Deselect
+        selectedPropertyKey = selectedPropertyKey !== key ? key : undefined;
+        if (this.props.onPropertySelectionChanged)
+            this.props.onPropertySelectionChanged(property);
+        this.setState({ selectedPropertyKey, editingPropertyKey });
+    }
+    /** @internal */
+    render() {
+        const renderContext = {
+            isPropertyHoverEnabled: this.props.isPropertyHoverEnabled,
+            isPropertySelectionEnabled: this.props.isPropertySelectionEnabled,
+            isPropertySelectionOnRightClickEnabled: this.props.isPropertySelectionOnRightClickEnabled,
+            isPropertyEditingEnabled: this.props.isPropertyEditingEnabled,
+            selectedPropertyKey: this.state.selectedPropertyKey,
+            editingPropertyKey: this.state.editingPropertyKey,
+            onEditCommit: this._onEditCommit,
+            onEditCancel: this._onEditCancel,
+            onPropertyClicked: this._isClickSupported() ? this._onPropertyClicked : undefined,
+            onPropertyRightClicked: this._isRightClickSupported() ? this._onPropertyRightClicked : undefined,
+            onPropertyContextMenu: this._onPropertyContextMenu,
+        };
+        return (React.createElement(React.Fragment, null, this.props.children(renderContext)));
+    }
+}
 //# sourceMappingURL=PropertyGridEventsRelatedPropsSupplier.js.map