@react-spectrum/list 3.0.0-alpha.6 → 3.0.0-alpha.9

package/src/ListViewItem.tsx

@@ -14,24 +14,28 @@ import ChevronLeftMedium from '@spectrum-icons/ui/ChevronLeftMedium';
 import ChevronRightMedium from '@spectrum-icons/ui/ChevronRightMedium';
 import {classNames, ClearSlots, SlotProvider} from '@react-spectrum/utils';
 import {Content} from '@react-spectrum/view';
+import type {DraggableItemResult} from '@react-aria/dnd';
+import {FocusRing, useFocusRing} from '@react-aria/focus';
 import {Grid} from '@react-spectrum/layout';
+import ListGripper from '@spectrum-icons/ui/ListGripper';
 import listStyles from './listview.css';
 import {ListViewContext} from './ListView';
 import {mergeProps} from '@react-aria/utils';
 import React, {useContext, useRef} from 'react';
-import {useFocusRing} from '@react-aria/focus';
+import {useButton} from '@react-aria/button';
 import {useGridCell, useGridRow, useGridSelectionCheckbox} from '@react-aria/grid';
 import {useHover, usePress} from '@react-aria/interactions';
 import {useLocale} from '@react-aria/i18n';
+import {useVisuallyHidden} from '@react-aria/visually-hidden';
 
 export function ListViewItem(props) {
   let {
     item,
-    onAction,
-    isEmphasized
+    isEmphasized,
+    dragHooks
   } = props;
   let cellNode = [...item.childNodes][0];
-  let {state} = useContext(ListViewContext);
+  let {state, dragState, onAction, isListDraggable} = useContext(ListViewContext);
   let {direction} = useLocale();
   let rowRef = useRef<HTMLDivElement>();
   let cellRef =  useRef<HTMLDivElement>();
@@ -42,17 +46,24 @@ export function ListViewItem(props) {
   let {isFocusVisible, focusProps} = useFocusRing();
   let allowsInteraction = state.selectionManager.selectionMode !== 'none' || onAction;
   let isDisabled = !allowsInteraction || state.disabledKeys.has(item.key);
+  let isDraggable = dragState?.isDraggable(item.key) && !isDisabled;
   let {hoverProps, isHovered} = useHover({isDisabled});
   let {pressProps, isPressed} = usePress({isDisabled});
   let {rowProps} = useGridRow({
     node: item,
     isVirtualized: true,
-    onAction: onAction ? () => onAction(item.key) : undefined
+    onAction: onAction ? () => onAction(item.key) : undefined,
+    shouldSelectOnPressUp: isListDraggable
   }, state, rowRef);
   let {gridCellProps} = useGridCell({
     node: cellNode,
     focusMode: 'cell'
   }, state, cellRef);
+  let draggableItem: DraggableItemResult;
+  if (isListDraggable) {
+    // eslint-disable-next-line react-hooks/rules-of-hooks
+    draggableItem = dragHooks.useDraggableItem({key: item.key}, dragState);
+  }
   const mergedProps = mergeProps(
     gridCellProps,
     hoverProps,
@@ -61,6 +72,12 @@ export function ListViewItem(props) {
   );
   let {checkboxProps} = useGridSelectionCheckbox({...props, key: item.key}, state);
 
+  let dragButtonRef = React.useRef();
+  let {buttonProps} = useButton({
+    ...draggableItem?.dragButtonProps,
+    elementType: 'div'
+  }, dragButtonRef);
+
   let chevron = null;
   if (item.props.hasChildItems) {
     chevron = direction === 'ltr'
@@ -78,9 +95,11 @@ export function ListViewItem(props) {
 
   let showCheckbox = state.selectionManager.selectionMode !== 'none' && state.selectionManager.selectionBehavior === 'toggle';
   let isSelected = state.selectionManager.isSelected(item.key);
+  let showDragHandle = isDraggable && (isFocusVisibleWithin || isHovered || isPressed);
+  let {visuallyHiddenProps} = useVisuallyHidden();
   return (
     <div
-      {...mergeProps(rowProps, pressProps)}
+      {...mergeProps(rowProps, pressProps, isDraggable && draggableItem?.dragProps)}
       ref={rowRef}>
       <div
         className={
@@ -94,19 +113,41 @@ export function ListViewItem(props) {
               'is-hovered': isHovered,
               'is-selected': isSelected,
               'is-previous-selected': state.selectionManager.isSelected(item.prevKey),
-              'react-spectrum-ListViewItem--highlightSelection': state.selectionManager.selectionBehavior === 'replace' && (isSelected || state.selectionManager.isSelected(item.nextKey))
+              'react-spectrum-ListViewItem--highlightSelection': state.selectionManager.selectionBehavior === 'replace' && (isSelected || state.selectionManager.isSelected(item.nextKey)),
+              'react-spectrum-ListViewItem--draggable': isDraggable
             }
           )
         }
         ref={cellRef}
         {...mergedProps}>
         <Grid UNSAFE_className={listStyles['react-spectrum-ListViewItem-grid']}>
-          {showCheckbox && (
+          {isListDraggable &&
+            <div className={listStyles['react-spectrum-ListViewItem-draghandle-container']}>
+              {isDraggable &&
+                <FocusRing focusRingClass={classNames(listStyles, 'focus-ring')}>
+                  <div
+                    {...buttonProps as React.HTMLAttributes<HTMLElement>}
+                    className={
+                      classNames(
+                        listStyles,
+                        'react-spectrum-ListViewItem-draghandle-button'
+                      )
+                    }
+                    style={!showDragHandle ? {...visuallyHiddenProps.style} : {}}
+                    ref={dragButtonRef}
+                    draggable="true">
+                    <ListGripper />
+                  </div>
+                </FocusRing>
+              }
+            </div>
+          }
+          {showCheckbox &&
             <Checkbox
               UNSAFE_className={listStyles['react-spectrum-ListViewItem-checkbox']}
               {...checkboxProps}
               isEmphasized={isEmphasized} />
-          )}
+          }
           <SlotProvider
             slots={{
               content: {UNSAFE_className: listStyles['react-spectrum-ListViewItem-content']},

package/src/listview.css

@@ -98,17 +98,46 @@
     padding-bottom: 0px;
   }
 
+  &.is-dragging {
+    border: 1px solid var(--spectrum-global-color-blue-500);
+    border-radius: var(--spectrum-global-dimension-size-50);
+  }
+
   .react-spectrum-ListViewItem-grid {
     display: grid;
-    grid-template-columns: auto auto auto 1fr auto auto;
+    grid-template-columns: auto auto auto auto 1fr auto auto;
     grid-template-rows: 1fr auto;
     grid-template-areas:
-      "checkbox icon image content actions actionmenu chevron"
-      "checkbox icon image description actions actionmenu chevron"
+      "draghandle checkbox icon image content actions actionmenu chevron"
+      "draghandle checkbox icon image description actions actionmenu chevron"
     ;
     align-items: center;
   }
 
+  .react-spectrum-ListViewItem-draghandle-container {
+    grid-area: draghandle;
+    width: var(--spectrum-global-dimension-size-250);
+    display: flex;
+    align-self: stretch;
+    justify-self: stretch;
+    justify-content: center;
+    padding: var(--spectrum-global-dimension-size-25);
+
+
+    .react-spectrum-ListViewItem-draghandle-button {
+      width: var(--spectrum-global-dimension-size-200);
+      display: flex;
+      align-items: center;
+      justify-content: center;
+      border-radius: var(--spectrum-alias-border-radius-regular);
+
+      &:focus-ring {
+        box-shadow: inset 0 0 0 2px var(--spectrum-table-cell-border-color-key-focus);
+        outline: none;
+      }
+    }
+  }
+
   .react-spectrum-ListViewItem-checkbox {
     grid-area: checkbox;
     align-items: center;
@@ -185,6 +214,16 @@
   min-height: var(--spectrum-global-dimension-size-600);
 }
 
+.react-spectrum-ListView--draggable .react-spectrum-ListViewItem {
+  padding-inline-start: 0;
+}
+
+.react-spectrum-ListViewItem--draggable {
+  .react-spectrum-ListViewItem-checkbox input {
+    inset-inline-start: 0;
+  }
+}
+
 .react-spectrum-ListView-centeredWrapper {
   display: flex;
   align-items: center;