@react-types/shared 3.0.0-nightly.1626 → 3.0.0-nightly.1642

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-types/shared",
-  "version": "3.0.0-nightly.1626+f2b495b4b",
+  "version": "3.0.0-nightly.1642+3d93a8a75",
   "description": "Spectrum UI components in React",
   "license": "Apache-2.0",
   "types": "src/index.d.ts",
@@ -14,5 +14,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "f2b495b4b505ee0ae193ae69f82d8b13dd594433"
+  "gitHead": "3d93a8a75cc429d0a95ee4f380b7dc19f9b29ccd"
 }

package/src/dnd.d.ts

@@ -119,11 +119,20 @@ export interface DragTypes {
 }
 
 export interface DroppableCollectionProps {
+  /**
+   * A function returning the drop operation to be performed when items matching the given types are dropped
+   * on the drop target.
+   */
   getDropOperation?: (target: DropTarget, types: DragTypes, allowedOperations: DropOperation[]) => DropOperation,
+  /** Handler that is called when a valid drag element enters the drop target. */
   onDropEnter?: (e: DroppableCollectionEnterEvent) => void,
+  /** Handler that is called when a valid drag element is moved within the drop target. */
   onDropMove?: (e: DroppableCollectionMoveEvent) => void,
+  /** Handler that is called after a valid drag element is held over the drop target for a period of time. */
   onDropActivate?: (e: DroppableCollectionActivateEvent) => void,
+  /** Handler that is called when a valid drag element exits the drop target. */
   onDropExit?: (e: DroppableCollectionExitEvent) => void,
+  /** Handler that is called when a valid drag element is dropped on the drop target. */
   onDrop?: (e: DroppableCollectionDropEvent) => void
 }
 
@@ -142,10 +151,16 @@ interface DraggableCollectionEndEvent extends DragEndEvent {
 export type DragPreviewRenderer = (items: DragItem[], callback: (node: HTMLElement) => void) => void;
 
 export interface DraggableCollectionProps {
+  /** Handler that is called when a drag operation is started. */
   onDragStart?: (e: DraggableCollectionStartEvent) => void,
+  /** Handler that is called when the dragged element is moved. */
   onDragMove?: (e: DraggableCollectionMoveEvent) => void,
+  /** Handler that is called when the drag operation is ended, either as a result of a drop or a cancellation. */
   onDragEnd?: (e: DraggableCollectionEndEvent) => void,
+  /** A function that returns the items being dragged. */
   getItems: (keys: Set<Key>) => DragItem[],
+  /** The ref of the element that will be rendered as the drag preview while dragging. */
   preview?: RefObject<DragPreviewRenderer>,
+  /** Function that returns the drop operations that are allowed for the dragged items. If not provided, all drop operations are allowed. */
   getAllowedDropOperations?: () => DropOperation[]
 }