@itwin/components-react 3.4.0-dev.57 → 3.4.0-dev.59

package/lib/esm/components-react/table/component/dragdrop/DragDropDef.d.ts

@@ -1,155 +1,155 @@
-/** @packageDocumentation
- * @module DragDrop
- */
-import * as React from "react";
-import { CommonProps } from "@itwin/core-react";
-/** Enum for different DropEffects.
- * @beta
- * @deprecated
- */
-export declare enum DropEffects {
-    None = 0,
-    Copy = 1,
-    Move = 2,
-    Link = 4
-}
-/** Enum for status of current drag/drop item
- * @beta
- * @deprecated
- */
-export declare enum DropStatus {
-    None = 0,
-    Ok = 1,
-    Drop = 2,
-    Cancel = 3
-}
-/** Properties and callbacks for the withDragSource Higher-Order Component.
- * @beta
- * @deprecated
- */
-export interface DropTargetProps<DragDropObject = any> {
-    /**
-     * Triggered when item is dropped on wrapped component.
-     * Return value is passed to the DragSource's onDragSourceEnd callback.
-     */
-    onDropTargetDrop?: (args: DropTargetArguments<DragDropObject>) => DropTargetArguments<DragDropObject>;
-    /** Triggered when item is dragged over wrapped component. */
-    onDropTargetOver?: (args: DropTargetArguments<DragDropObject>) => void;
-    /** Determines whether item may be dropped on DropTarget. */
-    canDropTargetDrop?: (args: DropTargetArguments<DragDropObject>) => boolean;
-    /** List of allowed object types */
-    objectTypes?: Array<string | symbol> | (() => Array<string | symbol>);
-}
-/** Properties and callbacks for the withDragSource Higher-Order Component.
- * @beta
- * @deprecated
- */
-export interface DragSourceProps<DragDropObject = any> {
-    /** Triggered when DragSource has begun a drag. */
-    onDragSourceBegin?: (data: DragSourceArguments<DragDropObject>) => DragSourceArguments<DragDropObject>;
-    /**
-     * Triggered when a DragSource drag has ended.
-     * Callback is always called after an onDragSourceBegin callback, regardless of whether the drag was successful.
-     */
-    onDragSourceEnd?: (data: DragSourceArguments<DragDropObject>) => void;
-    /**
-     * Specifies the DragSource type.
-     * data parameter is non-null when data is trickled down from dragged component.
-     */
-    objectType?: ((data?: DragDropObject) => string | symbol) | string | symbol;
-    /**
-     * Specifies a default DragLayer component to display as a drag preview.
-     * This property is dependent on the DragDropLayerManager in appui-react. The DragLayer is ultimately rendered using the DragDropLayerRendererComponent, which must exist within the app that is used.
-     * Component may be overridden if another DragLayer is registered for the given type using the DragDropLayerManager in appui-react.
-     */
-    defaultDragLayer?: React.ComponentType<DragLayerProps<DragDropObject>>;
-}
-/** Base DragDropArguments interface, used by both DragSourceArguments and DragTargetArguments.
- * @beta
- * @deprecated
- */
-export interface DragDropArguments<DragDropObject = any> {
-    /** Arbitrary data being transferred. Actual data structure determined by the return value of the onDragSourceBegin callback. */
-    dataObject: DragDropObject;
-    /** Drop Effect of current drag */
-    dropEffect: DropEffects;
-    /** Status of current drop */
-    dropStatus: DropStatus;
-    /** Current mouse position. */
-    clientOffset: {
-        x: number;
-        y: number;
-    };
-    /** Mouse position at beginning of drag. */
-    initialClientOffset: {
-        x: number;
-        y: number;
-    };
-    /**
-     * Current mouse position, offset by the difference between initial mouse position and initial dragSource offset.
-     * Useful for preserving apparent anchor point of mouse to dragSource while rendering a dragPreview.
-     */
-    sourceClientOffset?: {
-        x: number;
-        y: number;
-    };
-    /** Position of top left corner of current dragSource, measured at beginning of drag. */
-    initialSourceClientOffset?: {
-        x: number;
-        y: number;
-    };
-    /** DOMRect object of dragSource.
-     * Not available in canDropTargetDrop.
-     */
-    dragRect?: DOMRect;
-    /** DOMRect object of current dropTarget, if available.
-      * Not available in canDropTargetDrop.
-      */
-    dropRect?: DOMRect;
-    /** determines whether item is dropped on same structure as the drag source, or a different structure.
-     * Passed from OnDropTargetDrop for use in OnDragSourceEnd
-     * Used primarily for cases where the dataProvider object needs to differentiate a moveItem method with a subsequent removeItem then addItem.
-     */
-    local?: boolean;
-    /** specifies the row to be dropped onto.
-     * Populated by consumers for trickle down arguments.
-     * Specifically used where further information is needed within a given dataProvider structure. Ie. insertRow(rowIndex, rowItem) type methods.
-     */
-    row?: number;
-    /** specifies the col to be dropped onto.
-     * Populated by consumers for trickle down arguments.
-     * Specifically used where further information is needed within a given dataProvider structure. Ie. dataProvider.insertCol(colIndex, colItem) type methods.
-     */
-    col?: number;
-}
-/** Properties for DragLayer components
- * @beta
- * @deprecated
- */
-export interface DragLayerProps<DragDropObject = any> extends CommonProps {
-    args?: DragSourceArguments<DragDropObject>;
-}
-/** Interface for arguments supplied to DragSource callbacks, including onDragSourceBegin, and onDragSourceEnd, as well as to the DragLayers as a prop.
- * @beta
- * @deprecated
- */
-export interface DragSourceArguments<DragDropObject = any> extends DragDropArguments<DragDropObject> {
-    /** Parent object, using the data structure relevant to object being used.
-     * Object populated by consumer for use as trickle down arguments.
-     * Specifically used where further information is needed within a given dataProvider structure. Ie. dataProvider.removeChild(parentObject, child) type methods.
-     */
-    parentObject?: DragDropObject;
-    defaultDragLayer?: React.ComponentType<DragLayerProps<DragDropObject>>;
-}
-/** Interface for arguments supplied to DropTarget callbacks, including onDropTargetOver, onDropTargetDrop, and canDropTargetDrop.
- * @beta
- * @deprecated
- */
-export interface DropTargetArguments<DragDropObject = any> extends DragSourceArguments<DragDropObject> {
-    /** Object that is being dropped onto, using the data structure relevant to object being used.
-     * Object populated by consumer for use as trickle down arguments.
-     * Specifically used where further information is needed within a given dataProvider structure. Ie. dataProvider.addChild(dropLocation, child) type methods.
-     */
-    dropLocation?: DragDropObject;
-}
+/** @packageDocumentation
+ * @module DragDrop
+ */
+import * as React from "react";
+import { CommonProps } from "@itwin/core-react";
+/** Enum for different DropEffects.
+ * @beta
+ * @deprecated
+ */
+export declare enum DropEffects {
+    None = 0,
+    Copy = 1,
+    Move = 2,
+    Link = 4
+}
+/** Enum for status of current drag/drop item
+ * @beta
+ * @deprecated
+ */
+export declare enum DropStatus {
+    None = 0,
+    Ok = 1,
+    Drop = 2,
+    Cancel = 3
+}
+/** Properties and callbacks for the withDragSource Higher-Order Component.
+ * @beta
+ * @deprecated
+ */
+export interface DropTargetProps<DragDropObject = any> {
+    /**
+     * Triggered when item is dropped on wrapped component.
+     * Return value is passed to the DragSource's onDragSourceEnd callback.
+     */
+    onDropTargetDrop?: (args: DropTargetArguments<DragDropObject>) => DropTargetArguments<DragDropObject>;
+    /** Triggered when item is dragged over wrapped component. */
+    onDropTargetOver?: (args: DropTargetArguments<DragDropObject>) => void;
+    /** Determines whether item may be dropped on DropTarget. */
+    canDropTargetDrop?: (args: DropTargetArguments<DragDropObject>) => boolean;
+    /** List of allowed object types */
+    objectTypes?: Array<string | symbol> | (() => Array<string | symbol>);
+}
+/** Properties and callbacks for the withDragSource Higher-Order Component.
+ * @beta
+ * @deprecated
+ */
+export interface DragSourceProps<DragDropObject = any> {
+    /** Triggered when DragSource has begun a drag. */
+    onDragSourceBegin?: (data: DragSourceArguments<DragDropObject>) => DragSourceArguments<DragDropObject>;
+    /**
+     * Triggered when a DragSource drag has ended.
+     * Callback is always called after an onDragSourceBegin callback, regardless of whether the drag was successful.
+     */
+    onDragSourceEnd?: (data: DragSourceArguments<DragDropObject>) => void;
+    /**
+     * Specifies the DragSource type.
+     * data parameter is non-null when data is trickled down from dragged component.
+     */
+    objectType?: ((data?: DragDropObject) => string | symbol) | string | symbol;
+    /**
+     * Specifies a default DragLayer component to display as a drag preview.
+     * This property is dependent on the DragDropLayerManager in appui-react. The DragLayer is ultimately rendered using the DragDropLayerRendererComponent, which must exist within the app that is used.
+     * Component may be overridden if another DragLayer is registered for the given type using the DragDropLayerManager in appui-react.
+     */
+    defaultDragLayer?: React.ComponentType<DragLayerProps<DragDropObject>>;
+}
+/** Base DragDropArguments interface, used by both DragSourceArguments and DragTargetArguments.
+ * @beta
+ * @deprecated
+ */
+export interface DragDropArguments<DragDropObject = any> {
+    /** Arbitrary data being transferred. Actual data structure determined by the return value of the onDragSourceBegin callback. */
+    dataObject: DragDropObject;
+    /** Drop Effect of current drag */
+    dropEffect: DropEffects;
+    /** Status of current drop */
+    dropStatus: DropStatus;
+    /** Current mouse position. */
+    clientOffset: {
+        x: number;
+        y: number;
+    };
+    /** Mouse position at beginning of drag. */
+    initialClientOffset: {
+        x: number;
+        y: number;
+    };
+    /**
+     * Current mouse position, offset by the difference between initial mouse position and initial dragSource offset.
+     * Useful for preserving apparent anchor point of mouse to dragSource while rendering a dragPreview.
+     */
+    sourceClientOffset?: {
+        x: number;
+        y: number;
+    };
+    /** Position of top left corner of current dragSource, measured at beginning of drag. */
+    initialSourceClientOffset?: {
+        x: number;
+        y: number;
+    };
+    /** DOMRect object of dragSource.
+     * Not available in canDropTargetDrop.
+     */
+    dragRect?: DOMRect;
+    /** DOMRect object of current dropTarget, if available.
+      * Not available in canDropTargetDrop.
+      */
+    dropRect?: DOMRect;
+    /** determines whether item is dropped on same structure as the drag source, or a different structure.
+     * Passed from OnDropTargetDrop for use in OnDragSourceEnd
+     * Used primarily for cases where the dataProvider object needs to differentiate a moveItem method with a subsequent removeItem then addItem.
+     */
+    local?: boolean;
+    /** specifies the row to be dropped onto.
+     * Populated by consumers for trickle down arguments.
+     * Specifically used where further information is needed within a given dataProvider structure. Ie. insertRow(rowIndex, rowItem) type methods.
+     */
+    row?: number;
+    /** specifies the col to be dropped onto.
+     * Populated by consumers for trickle down arguments.
+     * Specifically used where further information is needed within a given dataProvider structure. Ie. dataProvider.insertCol(colIndex, colItem) type methods.
+     */
+    col?: number;
+}
+/** Properties for DragLayer components
+ * @beta
+ * @deprecated
+ */
+export interface DragLayerProps<DragDropObject = any> extends CommonProps {
+    args?: DragSourceArguments<DragDropObject>;
+}
+/** Interface for arguments supplied to DragSource callbacks, including onDragSourceBegin, and onDragSourceEnd, as well as to the DragLayers as a prop.
+ * @beta
+ * @deprecated
+ */
+export interface DragSourceArguments<DragDropObject = any> extends DragDropArguments<DragDropObject> {
+    /** Parent object, using the data structure relevant to object being used.
+     * Object populated by consumer for use as trickle down arguments.
+     * Specifically used where further information is needed within a given dataProvider structure. Ie. dataProvider.removeChild(parentObject, child) type methods.
+     */
+    parentObject?: DragDropObject;
+    defaultDragLayer?: React.ComponentType<DragLayerProps<DragDropObject>>;
+}
+/** Interface for arguments supplied to DropTarget callbacks, including onDropTargetOver, onDropTargetDrop, and canDropTargetDrop.
+ * @beta
+ * @deprecated
+ */
+export interface DropTargetArguments<DragDropObject = any> extends DragSourceArguments<DragDropObject> {
+    /** Object that is being dropped onto, using the data structure relevant to object being used.
+     * Object populated by consumer for use as trickle down arguments.
+     * Specifically used where further information is needed within a given dataProvider structure. Ie. dataProvider.addChild(dropLocation, child) type methods.
+     */
+    dropLocation?: DragDropObject;
+}
 //# sourceMappingURL=DragDropDef.d.ts.map

package/lib/esm/components-react/table/component/dragdrop/DragDropDef.js

@@ -1,30 +1,30 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module DragDrop
- */
-/** Enum for different DropEffects.
- * @beta
- * @deprecated
- */
-export var DropEffects;
-(function (DropEffects) {
-    DropEffects[DropEffects["None"] = 0] = "None";
-    DropEffects[DropEffects["Copy"] = 1] = "Copy";
-    DropEffects[DropEffects["Move"] = 2] = "Move";
-    DropEffects[DropEffects["Link"] = 4] = "Link";
-})(DropEffects || (DropEffects = {}));
-/** Enum for status of current drag/drop item
- * @beta
- * @deprecated
- */
-export var DropStatus;
-(function (DropStatus) {
-    DropStatus[DropStatus["None"] = 0] = "None";
-    DropStatus[DropStatus["Ok"] = 1] = "Ok";
-    DropStatus[DropStatus["Drop"] = 2] = "Drop";
-    DropStatus[DropStatus["Cancel"] = 3] = "Cancel";
-})(DropStatus || (DropStatus = {}));
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module DragDrop
+ */
+/** Enum for different DropEffects.
+ * @beta
+ * @deprecated
+ */
+export var DropEffects;
+(function (DropEffects) {
+    DropEffects[DropEffects["None"] = 0] = "None";
+    DropEffects[DropEffects["Copy"] = 1] = "Copy";
+    DropEffects[DropEffects["Move"] = 2] = "Move";
+    DropEffects[DropEffects["Link"] = 4] = "Link";
+})(DropEffects || (DropEffects = {}));
+/** Enum for status of current drag/drop item
+ * @beta
+ * @deprecated
+ */
+export var DropStatus;
+(function (DropStatus) {
+    DropStatus[DropStatus["None"] = 0] = "None";
+    DropStatus[DropStatus["Ok"] = 1] = "Ok";
+    DropStatus[DropStatus["Drop"] = 2] = "Drop";
+    DropStatus[DropStatus["Cancel"] = 3] = "Cancel";
+})(DropStatus || (DropStatus = {}));
 //# sourceMappingURL=DragDropDef.js.map

package/lib/esm/components-react/table/component/dragdrop/DragDropDef.js.map

@@ -1 +1 @@
-{"version":3,"file":"DragDropDef.js","sourceRoot":"","sources":["../../../../../../src/components-react/table/component/dragdrop/DragDropDef.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAKH;;;GAGG;AACH,MAAM,CAAN,IAAY,WAKX;AALD,WAAY,WAAW;IACrB,6CAAQ,CAAA;IACR,6CAAa,CAAA;IACb,6CAAa,CAAA;IACb,6CAAa,CAAA;AACf,CAAC,EALW,WAAW,KAAX,WAAW,QAKtB;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,UAKX;AALD,WAAY,UAAU;IACpB,2CAAQ,CAAA;IACR,uCAAE,CAAA;IACF,2CAAI,CAAA;IACJ,+CAAM,CAAA;AACR,CAAC,EALW,UAAU,KAAV,UAAU,QAKrB","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 DragDrop\n */\n\nimport * as React from \"react\";\nimport { CommonProps } from \"@itwin/core-react\";\n\n/** Enum for different DropEffects.\n * @beta\n * @deprecated\n */\nexport enum DropEffects {\n  None = 0,\n  Copy = 1 << 0,\n  Move = 1 << 1,\n  Link = 1 << 2,\n}\n\n/** Enum for status of current drag/drop item\n * @beta\n * @deprecated\n */\nexport enum DropStatus {\n  None = 0,\n  Ok,\n  Drop,\n  Cancel,\n}\n\n/** Properties and callbacks for the withDragSource Higher-Order Component.\n * @beta\n * @deprecated\n */\nexport interface DropTargetProps<DragDropObject = any> {\n  /**\n   * Triggered when item is dropped on wrapped component.\n   * Return value is passed to the DragSource's onDragSourceEnd callback.\n   */\n  onDropTargetDrop?: (args: DropTargetArguments<DragDropObject>) => DropTargetArguments<DragDropObject>; // eslint-disable-line deprecation/deprecation\n  /** Triggered when item is dragged over wrapped component. */\n  onDropTargetOver?: (args: DropTargetArguments<DragDropObject>) => void; // eslint-disable-line deprecation/deprecation\n  /** Determines whether item may be dropped on DropTarget. */\n  canDropTargetDrop?: (args: DropTargetArguments<DragDropObject>) => boolean; // eslint-disable-line deprecation/deprecation\n  /** List of allowed object types */\n  objectTypes?: Array<string | symbol> | (() => Array<string | symbol>);\n}\n\n/** Properties and callbacks for the withDragSource Higher-Order Component.\n * @beta\n * @deprecated\n */\nexport interface DragSourceProps<DragDropObject = any> {\n  /** Triggered when DragSource has begun a drag. */\n  onDragSourceBegin?: (data: DragSourceArguments<DragDropObject>) => DragSourceArguments<DragDropObject>; // eslint-disable-line deprecation/deprecation\n  /**\n   * Triggered when a DragSource drag has ended.\n   * Callback is always called after an onDragSourceBegin callback, regardless of whether the drag was successful.\n   */\n  onDragSourceEnd?: (data: DragSourceArguments<DragDropObject>) => void; // eslint-disable-line deprecation/deprecation\n  /**\n   * Specifies the DragSource type.\n   * data parameter is non-null when data is trickled down from dragged component.\n   */\n  objectType?: ((data?: DragDropObject) => string | symbol) | string | symbol;\n  /**\n   * Specifies a default DragLayer component to display as a drag preview.\n   * This property is dependent on the DragDropLayerManager in appui-react. The DragLayer is ultimately rendered using the DragDropLayerRendererComponent, which must exist within the app that is used.\n   * Component may be overridden if another DragLayer is registered for the given type using the DragDropLayerManager in appui-react.\n   */\n  defaultDragLayer?: React.ComponentType<DragLayerProps<DragDropObject>>; // eslint-disable-line deprecation/deprecation\n}\n\n/** Base DragDropArguments interface, used by both DragSourceArguments and DragTargetArguments.\n * @beta\n * @deprecated\n */\nexport interface DragDropArguments<DragDropObject = any> {\n  /** Arbitrary data being transferred. Actual data structure determined by the return value of the onDragSourceBegin callback. */\n  dataObject: DragDropObject;\n  /** Drop Effect of current drag */\n  dropEffect: DropEffects; // eslint-disable-line deprecation/deprecation\n  /** Status of current drop */\n  dropStatus: DropStatus; // eslint-disable-line deprecation/deprecation\n  /** Current mouse position. */\n  clientOffset: { x: number, y: number };\n  /** Mouse position at beginning of drag. */\n  initialClientOffset: { x: number, y: number };\n  /**\n   * Current mouse position, offset by the difference between initial mouse position and initial dragSource offset.\n   * Useful for preserving apparent anchor point of mouse to dragSource while rendering a dragPreview.\n   */\n  sourceClientOffset?: { x: number, y: number };\n  /** Position of top left corner of current dragSource, measured at beginning of drag. */\n  initialSourceClientOffset?: { x: number, y: number };\n  /** DOMRect object of dragSource.\n   * Not available in canDropTargetDrop.\n   */\n  dragRect?: DOMRect;\n  /** DOMRect object of current dropTarget, if available.\n    * Not available in canDropTargetDrop.\n    */\n  dropRect?: DOMRect;\n  /** determines whether item is dropped on same structure as the drag source, or a different structure.\n   * Passed from OnDropTargetDrop for use in OnDragSourceEnd\n   * Used primarily for cases where the dataProvider object needs to differentiate a moveItem method with a subsequent removeItem then addItem.\n   */\n  local?: boolean;\n  /** specifies the row to be dropped onto.\n   * Populated by consumers for trickle down arguments.\n   * Specifically used where further information is needed within a given dataProvider structure. Ie. insertRow(rowIndex, rowItem) type methods.\n   */\n  row?: number;\n  /** specifies the col to be dropped onto.\n   * Populated by consumers for trickle down arguments.\n   * Specifically used where further information is needed within a given dataProvider structure. Ie. dataProvider.insertCol(colIndex, colItem) type methods.\n   */\n  col?: number;\n}\n\n/** Properties for DragLayer components\n * @beta\n * @deprecated\n */\nexport interface DragLayerProps<DragDropObject = any> extends CommonProps {\n  args?: DragSourceArguments<DragDropObject>; // eslint-disable-line deprecation/deprecation\n}\n\n/** Interface for arguments supplied to DragSource callbacks, including onDragSourceBegin, and onDragSourceEnd, as well as to the DragLayers as a prop.\n * @beta\n * @deprecated\n */\nexport interface DragSourceArguments<DragDropObject = any> extends DragDropArguments<DragDropObject> { // eslint-disable-line deprecation/deprecation\n  /** Parent object, using the data structure relevant to object being used.\n   * Object populated by consumer for use as trickle down arguments.\n   * Specifically used where further information is needed within a given dataProvider structure. Ie. dataProvider.removeChild(parentObject, child) type methods.\n   */\n  parentObject?: DragDropObject;\n  defaultDragLayer?: React.ComponentType<DragLayerProps<DragDropObject>>; // eslint-disable-line deprecation/deprecation\n}\n\n/** Interface for arguments supplied to DropTarget callbacks, including onDropTargetOver, onDropTargetDrop, and canDropTargetDrop.\n * @beta\n * @deprecated\n */\nexport interface DropTargetArguments<DragDropObject = any> extends DragSourceArguments<DragDropObject> { // eslint-disable-line deprecation/deprecation\n  /** Object that is being dropped onto, using the data structure relevant to object being used.\n   * Object populated by consumer for use as trickle down arguments.\n   * Specifically used where further information is needed within a given dataProvider structure. Ie. dataProvider.addChild(dropLocation, child) type methods.\n   */\n  dropLocation?: DragDropObject; // Where to attach\n}\n"]}
+{"version":3,"file":"DragDropDef.js","sourceRoot":"","sources":["../../../../../../src/components-react/table/component/dragdrop/DragDropDef.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAKH;;;GAGG;AACH,MAAM,CAAN,IAAY,WAKX;AALD,WAAY,WAAW;IACrB,6CAAQ,CAAA;IACR,6CAAa,CAAA;IACb,6CAAa,CAAA;IACb,6CAAa,CAAA;AACf,CAAC,EALW,WAAW,KAAX,WAAW,QAKtB;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,UAKX;AALD,WAAY,UAAU;IACpB,2CAAQ,CAAA;IACR,uCAAE,CAAA;IACF,2CAAI,CAAA;IACJ,+CAAM,CAAA;AACR,CAAC,EALW,UAAU,KAAV,UAAU,QAKrB","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 DragDrop\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport { CommonProps } from \"@itwin/core-react\";\r\n\r\n/** Enum for different DropEffects.\r\n * @beta\r\n * @deprecated\r\n */\r\nexport enum DropEffects {\r\n  None = 0,\r\n  Copy = 1 << 0,\r\n  Move = 1 << 1,\r\n  Link = 1 << 2,\r\n}\r\n\r\n/** Enum for status of current drag/drop item\r\n * @beta\r\n * @deprecated\r\n */\r\nexport enum DropStatus {\r\n  None = 0,\r\n  Ok,\r\n  Drop,\r\n  Cancel,\r\n}\r\n\r\n/** Properties and callbacks for the withDragSource Higher-Order Component.\r\n * @beta\r\n * @deprecated\r\n */\r\nexport interface DropTargetProps<DragDropObject = any> {\r\n  /**\r\n   * Triggered when item is dropped on wrapped component.\r\n   * Return value is passed to the DragSource's onDragSourceEnd callback.\r\n   */\r\n  onDropTargetDrop?: (args: DropTargetArguments<DragDropObject>) => DropTargetArguments<DragDropObject>; // eslint-disable-line deprecation/deprecation\r\n  /** Triggered when item is dragged over wrapped component. */\r\n  onDropTargetOver?: (args: DropTargetArguments<DragDropObject>) => void; // eslint-disable-line deprecation/deprecation\r\n  /** Determines whether item may be dropped on DropTarget. */\r\n  canDropTargetDrop?: (args: DropTargetArguments<DragDropObject>) => boolean; // eslint-disable-line deprecation/deprecation\r\n  /** List of allowed object types */\r\n  objectTypes?: Array<string | symbol> | (() => Array<string | symbol>);\r\n}\r\n\r\n/** Properties and callbacks for the withDragSource Higher-Order Component.\r\n * @beta\r\n * @deprecated\r\n */\r\nexport interface DragSourceProps<DragDropObject = any> {\r\n  /** Triggered when DragSource has begun a drag. */\r\n  onDragSourceBegin?: (data: DragSourceArguments<DragDropObject>) => DragSourceArguments<DragDropObject>; // eslint-disable-line deprecation/deprecation\r\n  /**\r\n   * Triggered when a DragSource drag has ended.\r\n   * Callback is always called after an onDragSourceBegin callback, regardless of whether the drag was successful.\r\n   */\r\n  onDragSourceEnd?: (data: DragSourceArguments<DragDropObject>) => void; // eslint-disable-line deprecation/deprecation\r\n  /**\r\n   * Specifies the DragSource type.\r\n   * data parameter is non-null when data is trickled down from dragged component.\r\n   */\r\n  objectType?: ((data?: DragDropObject) => string | symbol) | string | symbol;\r\n  /**\r\n   * Specifies a default DragLayer component to display as a drag preview.\r\n   * This property is dependent on the DragDropLayerManager in appui-react. The DragLayer is ultimately rendered using the DragDropLayerRendererComponent, which must exist within the app that is used.\r\n   * Component may be overridden if another DragLayer is registered for the given type using the DragDropLayerManager in appui-react.\r\n   */\r\n  defaultDragLayer?: React.ComponentType<DragLayerProps<DragDropObject>>; // eslint-disable-line deprecation/deprecation\r\n}\r\n\r\n/** Base DragDropArguments interface, used by both DragSourceArguments and DragTargetArguments.\r\n * @beta\r\n * @deprecated\r\n */\r\nexport interface DragDropArguments<DragDropObject = any> {\r\n  /** Arbitrary data being transferred. Actual data structure determined by the return value of the onDragSourceBegin callback. */\r\n  dataObject: DragDropObject;\r\n  /** Drop Effect of current drag */\r\n  dropEffect: DropEffects; // eslint-disable-line deprecation/deprecation\r\n  /** Status of current drop */\r\n  dropStatus: DropStatus; // eslint-disable-line deprecation/deprecation\r\n  /** Current mouse position. */\r\n  clientOffset: { x: number, y: number };\r\n  /** Mouse position at beginning of drag. */\r\n  initialClientOffset: { x: number, y: number };\r\n  /**\r\n   * Current mouse position, offset by the difference between initial mouse position and initial dragSource offset.\r\n   * Useful for preserving apparent anchor point of mouse to dragSource while rendering a dragPreview.\r\n   */\r\n  sourceClientOffset?: { x: number, y: number };\r\n  /** Position of top left corner of current dragSource, measured at beginning of drag. */\r\n  initialSourceClientOffset?: { x: number, y: number };\r\n  /** DOMRect object of dragSource.\r\n   * Not available in canDropTargetDrop.\r\n   */\r\n  dragRect?: DOMRect;\r\n  /** DOMRect object of current dropTarget, if available.\r\n    * Not available in canDropTargetDrop.\r\n    */\r\n  dropRect?: DOMRect;\r\n  /** determines whether item is dropped on same structure as the drag source, or a different structure.\r\n   * Passed from OnDropTargetDrop for use in OnDragSourceEnd\r\n   * Used primarily for cases where the dataProvider object needs to differentiate a moveItem method with a subsequent removeItem then addItem.\r\n   */\r\n  local?: boolean;\r\n  /** specifies the row to be dropped onto.\r\n   * Populated by consumers for trickle down arguments.\r\n   * Specifically used where further information is needed within a given dataProvider structure. Ie. insertRow(rowIndex, rowItem) type methods.\r\n   */\r\n  row?: number;\r\n  /** specifies the col to be dropped onto.\r\n   * Populated by consumers for trickle down arguments.\r\n   * Specifically used where further information is needed within a given dataProvider structure. Ie. dataProvider.insertCol(colIndex, colItem) type methods.\r\n   */\r\n  col?: number;\r\n}\r\n\r\n/** Properties for DragLayer components\r\n * @beta\r\n * @deprecated\r\n */\r\nexport interface DragLayerProps<DragDropObject = any> extends CommonProps {\r\n  args?: DragSourceArguments<DragDropObject>; // eslint-disable-line deprecation/deprecation\r\n}\r\n\r\n/** Interface for arguments supplied to DragSource callbacks, including onDragSourceBegin, and onDragSourceEnd, as well as to the DragLayers as a prop.\r\n * @beta\r\n * @deprecated\r\n */\r\nexport interface DragSourceArguments<DragDropObject = any> extends DragDropArguments<DragDropObject> { // eslint-disable-line deprecation/deprecation\r\n  /** Parent object, using the data structure relevant to object being used.\r\n   * Object populated by consumer for use as trickle down arguments.\r\n   * Specifically used where further information is needed within a given dataProvider structure. Ie. dataProvider.removeChild(parentObject, child) type methods.\r\n   */\r\n  parentObject?: DragDropObject;\r\n  defaultDragLayer?: React.ComponentType<DragLayerProps<DragDropObject>>; // eslint-disable-line deprecation/deprecation\r\n}\r\n\r\n/** Interface for arguments supplied to DropTarget callbacks, including onDropTargetOver, onDropTargetDrop, and canDropTargetDrop.\r\n * @beta\r\n * @deprecated\r\n */\r\nexport interface DropTargetArguments<DragDropObject = any> extends DragSourceArguments<DragDropObject> { // eslint-disable-line deprecation/deprecation\r\n  /** Object that is being dropped onto, using the data structure relevant to object being used.\r\n   * Object populated by consumer for use as trickle down arguments.\r\n   * Specifically used where further information is needed within a given dataProvider structure. Ie. dataProvider.addChild(dropLocation, child) type methods.\r\n   */\r\n  dropLocation?: DragDropObject; // Where to attach\r\n}\r\n"]}

package/lib/esm/components-react/table/component/dragdrop/withDragSource.d.ts

@@ -1,42 +1,42 @@
-/** @packageDocumentation
- * @module DragDrop
- */
-import * as React from "react";
-import { ConnectDragPreview, ConnectDragSource, DndComponentClass } from "react-dnd";
-import { DragSourceProps, DropEffects } from "./DragDropDef";
-/** React properties for withDragSource Higher-Order Component
- * @beta
- * @deprecated
- */
-export interface WithDragSourceProps<DragDropObject = any> {
-    /** Properties and callbacks for DragSource. */
-    dragProps: DragSourceProps<DragDropObject>;
-    /** Style properties for dropTarget wrapper element */
-    dragStyle?: React.CSSProperties;
-    /** Which dropEffect dragSource should default to. */
-    defaultDropEffect?: DropEffects;
-    /** Which dropEffect dragSource should be used when ctrl button is pressed during start of drag. */
-    ctrlDropEffect?: DropEffects;
-    /** Which dropEffect dragSource should be used when alt button is pressed during start of drag. */
-    altDropEffect?: DropEffects;
-    /** @internal */
-    connectDragSource?: ConnectDragSource;
-    /** @internal */
-    connectDragPreview?: ConnectDragPreview;
-    /** @internal */
-    isDragging?: boolean;
-    /** @internal */
-    canDrag?: boolean;
-    /** @internal */
-    item?: DragDropObject;
-    /** @internal */
-    type?: string | symbol | null;
-}
-/**
- * HOC (Higher-Order Component) that transforms wrapped component into a DragSource.
- * @param Component component to wrap.
- * @beta
- * @deprecated
- */
-export declare const withDragSource: <ComponentProps extends {}, DragDropObject = any>(Component: React.ComponentType<ComponentProps>) => DndComponentClass<typeof React.Component, ComponentProps & WithDragSourceProps<DragDropObject>>;
+/** @packageDocumentation
+ * @module DragDrop
+ */
+import * as React from "react";
+import { ConnectDragPreview, ConnectDragSource, DndComponentClass } from "react-dnd";
+import { DragSourceProps, DropEffects } from "./DragDropDef";
+/** React properties for withDragSource Higher-Order Component
+ * @beta
+ * @deprecated
+ */
+export interface WithDragSourceProps<DragDropObject = any> {
+    /** Properties and callbacks for DragSource. */
+    dragProps: DragSourceProps<DragDropObject>;
+    /** Style properties for dropTarget wrapper element */
+    dragStyle?: React.CSSProperties;
+    /** Which dropEffect dragSource should default to. */
+    defaultDropEffect?: DropEffects;
+    /** Which dropEffect dragSource should be used when ctrl button is pressed during start of drag. */
+    ctrlDropEffect?: DropEffects;
+    /** Which dropEffect dragSource should be used when alt button is pressed during start of drag. */
+    altDropEffect?: DropEffects;
+    /** @internal */
+    connectDragSource?: ConnectDragSource;
+    /** @internal */
+    connectDragPreview?: ConnectDragPreview;
+    /** @internal */
+    isDragging?: boolean;
+    /** @internal */
+    canDrag?: boolean;
+    /** @internal */
+    item?: DragDropObject;
+    /** @internal */
+    type?: string | symbol | null;
+}
+/**
+ * HOC (Higher-Order Component) that transforms wrapped component into a DragSource.
+ * @param Component component to wrap.
+ * @beta
+ * @deprecated
+ */
+export declare const withDragSource: <ComponentProps extends {}, DragDropObject = any>(Component: React.ComponentType<ComponentProps>) => DndComponentClass<typeof React.Component, ComponentProps & WithDragSourceProps<DragDropObject>>;
 //# sourceMappingURL=withDragSource.d.ts.map