Merge pull request #1184 from ethereum/multiselectdelete

Multi select & multi context menu actions & deleting multi

libs/remix-ui/file-explorer/src/lib/file-explorer-context-menu.tsx

@@ -1,12 +1,11 @@
 import React, { useRef, useEffect } from 'react' // eslint-disable-line
-import { FileExplorerContextMenuProps } from './types'
+import { action, FileExplorerContextMenuProps } from './types'
 
 import './css/file-explorer-context-menu.css'
 
 export const FileExplorerContextMenu = (props: FileExplorerContextMenuProps) => {
-  const { actions, createNewFile, createNewFolder, deletePath, renamePath, hideContextMenu, pushChangesToGist, publishFileToGist, publishFolderToGist, copy, paste, runScript, emit, pageX, pageY, path, type, ...otherProps } = props
+  const { actions, createNewFile, createNewFolder, deletePath, renamePath, hideContextMenu, pushChangesToGist, publishFileToGist, publishFolderToGist, copy, paste, runScript, emit, pageX, pageY, path, type, focus, ...otherProps } = props
   const contextMenuRef = useRef(null)
-
   useEffect(() => {
     contextMenuRef.current.focus()
   }, [])
@@ -22,14 +21,40 @@ export const FileExplorerContextMenu = (props: FileExplorerContextMenuProps) =>
     }
   }, [pageX, pageY])
 
+  const filterItem = (item: action) => {
+    /**
+     * if there are multiple elements focused we need to take this and all conditions must be met
+     * for example : 'downloadAsZip' with type ['file','folder'] will work on files and folders when multiple are selected
+    **/
+    const nonRootFocus = focus.filter((el) => { return !(el.key === '' && el.type === 'folder') })
+    if (nonRootFocus.length > 1) {
+      for (const element of nonRootFocus) {
+        if (!itemMatchesCondition(item, element.type, element.key)) return false
+      }
+      return true
+    } else {
+      return itemMatchesCondition(item, type, path)
+    }
+  }
+
+  const itemMatchesCondition = (item: action, itemType: string, itemPath: string) => {
+    if (item.type && Array.isArray(item.type) && (item.type.findIndex(name => name === itemType) !== -1)) return true
+    else if (item.path && Array.isArray(item.path) && (item.path.findIndex(key => key === itemPath) !== -1)) return true
+    else if (item.extension && Array.isArray(item.extension) && (item.extension.findIndex(ext => itemPath.endsWith(ext)) !== -1)) return true
+    else if (item.pattern && Array.isArray(item.pattern) && (item.pattern.filter(value => itemPath.match(new RegExp(value))).length > 0)) return true
+    else return false
+  }
+
+  const getPath = () => {
+    if (focus.length > 1) {
+      return focus.map((element) => element.key)
+    } else {
+      return path
+    }
+  }
+
   const menu = () => {
-    return actions.filter(item => {
-      if (item.type && Array.isArray(item.type) && (item.type.findIndex(name => name === type) !== -1)) return true
-      else if (item.path && Array.isArray(item.path) && (item.path.findIndex(key => key === path) !== -1)) return true
-      else if (item.extension && Array.isArray(item.extension) && (item.extension.findIndex(ext => path.endsWith(ext)) !== -1)) return true
-      else if (item.pattern && Array.isArray(item.pattern) && (item.pattern.filter(value => path.match(new RegExp(value))).length > 0)) return true
-      else return false
-    }).map((item, index) => {
+    return actions.filter(item => filterItem(item)).map((item, index) => {
       return <li
         id={`menuitem${item.name.toLowerCase()}`}
         key={index}
@@ -47,7 +72,7 @@ export const FileExplorerContextMenu = (props: FileExplorerContextMenuProps) =>
               renamePath(path, type)
               break
             case 'Delete':
-              deletePath(path)
+              deletePath(getPath())
               break
             case 'Push changes to gist':
               pushChangesToGist(path, type)
@@ -67,8 +92,11 @@ export const FileExplorerContextMenu = (props: FileExplorerContextMenuProps) =>
             case 'Paste':
               paste(path, type)
               break
+            case 'Delete All':
+              deletePath(getPath())
+              break
             default:
-              emit && emit(item.id, path)
+              emit && emit(item.id, getPath())
               break
           }
           hideContextMenu()

libs/remix-ui/file-explorer/src/lib/file-explorer.tsx

@@ -6,7 +6,7 @@ import { Toaster } from '@remix-ui/toaster' // eslint-disable-line
 import Gists from 'gists'
 import { FileExplorerMenu } from './file-explorer-menu' // eslint-disable-line
 import { FileExplorerContextMenu } from './file-explorer-context-menu' // eslint-disable-line
-import { FileExplorerProps, File } from './types'
+import { FileExplorerProps, File, MenuItems } from './types'
 import { fileSystemReducer, fileSystemInitialState } from './reducers/fileSystem'
 import { fetchDirectory, init, resolveDirectory, addInputField, removeInputField } from './actions/fileSystem'
 import * as helper from '../../../../../apps/remix-ide/src/lib/helper'
@@ -33,63 +33,80 @@ export const FileExplorer = (props: FileExplorerProps) => {
       type: ['folder', 'gist'],
       path: [],
       extension: [],
-      pattern: []
+      pattern: [],
+      multiselect: false
     }, {
       id: 'newFolder',
       name: 'New Folder',
       type: ['folder', 'gist'],
       path: [],
       extension: [],
-      pattern: []
+      pattern: [],
+      multiselect: false
     }, {
       id: 'rename',
       name: 'Rename',
       type: ['file', 'folder'],
       path: [],
       extension: [],
-      pattern: []
+      pattern: [],
+      multiselect: false
     }, {
       id: 'delete',
       name: 'Delete',
       type: ['file', 'folder', 'gist'],
       path: [],
       extension: [],
-      pattern: []
+      pattern: [],
+      multiselect: false
     }, {
       id: 'run',
       name: 'Run',
       type: [],
       path: [],
       extension: ['.js'],
-      pattern: []
+      pattern: [],
+      multiselect: false
     }, {
       id: 'pushChangesToGist',
       name: 'Push changes to gist',
       type: ['gist'],
       path: [],
       extension: [],
-      pattern: []
+      pattern: [],
+      multiselect: false
     }, {
       id: 'publishFolderToGist',
       name: 'Publish folder to gist',
       type: ['folder'],
       path: [],
       extension: [],
-      pattern: []
+      pattern: [],
+      multiselect: false
     }, {
       id: 'publishFileToGist',
       name: 'Publish file to gist',
       type: ['file'],
       path: [],
       extension: [],
-      pattern: []
+      pattern: [],
+      multiselect: false
     }, {
       id: 'copy',
       name: 'Copy',
       type: ['folder', 'file'],
       path: [],
       extension: [],
-      pattern: []
+      pattern: [],
+      multiselect: false
+    }, {
+      id: 'deleteAll',
+      name: 'Delete All',
+      type: ['folder', 'file'],
+      path: [],
+      extension: [],
+      pattern: [],
+      multiselect: true
     }],
     focusContext: {
       element: null,
@@ -224,6 +241,31 @@ export const FileExplorer = (props: FileExplorerProps) => {
     }
   }, [state.modals])
 
+  useEffect(() => {
+    const keyPressHandler = (e: KeyboardEvent) => {
+      if (e.shiftKey) {
+        setState(prevState => {
+          return { ...prevState, ctrlKey: true }
+        })
+      }
+    }
+
+    const keyUpHandler = (e: KeyboardEvent) => {
+      if (!e.shiftKey) {
+        setState(prevState => {
+          return { ...prevState, ctrlKey: false }
+        })
+      }
+    }
+
+    document.addEventListener('keydown', keyPressHandler)
+    document.addEventListener('keyup', keyUpHandler)
+    return () => {
+      document.removeEventListener('keydown', keyPressHandler)
+      document.removeEventListener('keyup', keyUpHandler)
+    }
+  }, [])
+
   useEffect(() => {
     if (canPaste) {
       addMenuItems([{
@@ -232,14 +274,15 @@ export const FileExplorer = (props: FileExplorerProps) => {
         type: ['folder', 'file'],
         path: [],
         extension: [],
-        pattern: []
+        pattern: [],
+        multiselect: false
       }])
     } else {
       removeMenuItems(['paste'])
     }
   }, [canPaste])
 
-  const addMenuItems = (items: { id: string, name: string, type: string[], path: string[], extension: string[], pattern: string[] }[]) => {
+  const addMenuItems = (items: MenuItems) => {
     setState(prevState => {
       // filter duplicate items
       const actions = items.filter(({ name }) => prevState.actions.findIndex(action => action.name === name) === -1)
@@ -325,21 +368,23 @@ export const FileExplorer = (props: FileExplorerProps) => {
     }
   }
 
-  const deletePath = async (path: string) => {
+  const deletePath = async (path: string | string[]) => {
     const filesProvider = fileSystem.provider.provider
-
-    if (filesProvider.isReadOnly(path)) {
-      return toast('cannot delete file. ' + name + ' is a read only explorer')
+    if (!Array.isArray(path)) path = [path]
+    for (const p of path) {
+      if (filesProvider.isReadOnly(p)) {
+        return toast('cannot delete file. ' + name + ' is a read only explorer')
+      }
     }
-    const isDir = state.fileManager.isDirectory(path)
-
-    modal(`Delete ${isDir ? 'folder' : 'file'}`, `Are you sure you want to delete ${path} ${isDir ? 'folder' : 'file'}?`, 'OK', async () => {
-      try {
-        const fileManager = state.fileManager
-
-        await fileManager.remove(path)
-      } catch (e) {
-        toast(`Failed to remove ${isDir ? 'folder' : 'file'} ${path}.`)
+    modal(`Delete ${path.length > 1 ? 'items' : 'item'}`, deleteMessage(path), 'OK', async () => {
+      const fileManager = state.fileManager
+      for (const p of path) {
+        try {
+          await fileManager.remove(p)
+        } catch (e) {
+          const isDir = state.fileManager.isDirectory(p)
+          toast(`Failed to remove ${isDir ? 'folder' : 'file'} ${p}.`)
+        }
       }
     }, 'Cancel', () => {})
   }
@@ -556,7 +601,7 @@ export const FileExplorer = (props: FileExplorerProps) => {
     })
   }
 
-  const emitContextMenuEvent = (id: string, path: string) => {
+  const emitContextMenuEvent = (id: string, path: string | string[]) => {
     plugin.emit(id, path)
   }
 
@@ -566,7 +611,7 @@ export const FileExplorer = (props: FileExplorerProps) => {
     })
   }
 
-  const modal = (title: string, message: string, okLabel: string, okFn: () => void, cancelLabel?: string, cancelFn?: () => void) => {
+  const modal = (title: string, message: string | JSX.Element, okLabel: string, okFn: () => void, cancelLabel?: string, cancelFn?: () => void) => {
     setState(prevState => {
       return {
         ...prevState,
@@ -592,10 +637,25 @@ export const FileExplorer = (props: FileExplorerProps) => {
 
   const handleClickFile = (path: string, type: string) => {
     path = path.indexOf(props.name + '/') === 0 ? path.replace(props.name + '/', '') : path
-    state.fileManager.open(path)
-    setState(prevState => {
-      return { ...prevState, focusElement: [{ key: path, type }] }
-    })
+    if (!state.ctrlKey) {
+      state.fileManager.open(path)
+      setState(prevState => {
+        return { ...prevState, focusElement: [{ key: path, type }] }
+      })
+    } else {
+      if (state.focusElement.findIndex(item => item.key === path) !== -1) {
+        setState(prevState => {
+          return { ...prevState, focusElement: prevState.focusElement.filter(item => item.key !== path) }
+        })
+      } else {
+        setState(prevState => {
+          const nonRootFocus = prevState.focusElement.filter((el) => { return !(el.key === '' && el.type === 'folder') })
+
+          nonRootFocus.push({ key: path, type })
+          return { ...prevState, focusElement: nonRootFocus }
+        })
+      }
+    }
   }
 
   const handleClickFolder = async (path: string, type: string) => {
@@ -606,7 +666,10 @@ export const FileExplorer = (props: FileExplorerProps) => {
         })
       } else {
         setState(prevState => {
-          return { ...prevState, focusElement: [...prevState.focusElement, { key: path, type }] }
+          const nonRootFocus = prevState.focusElement.filter((el) => { return !(el.key === '' && el.type === 'folder') })
+
+          nonRootFocus.push({ key: path, type })
+          return { ...prevState, focusElement: nonRootFocus }
         })
       }
     } else {
@@ -763,6 +826,17 @@ export const FileExplorer = (props: FileExplorerProps) => {
     })
   }
 
+  const deleteMessage = (path: string[]) => {
+    return (
+      <div>
+        <div>Are you sure you want to delete {path.length > 1 ? 'these items' : 'this item'}?</div>
+        {
+          path.map((item, i) => (<li key={i}>{item}</li>))
+        }
+      </div>
+    )
+  }
+
   const label = (file: File) => {
     return (
       <div
@@ -929,7 +1003,7 @@ export const FileExplorer = (props: FileExplorerProps) => {
       <Toaster message={state.toasterMsg} />
       { state.showContextMenu &&
         <FileExplorerContextMenu
-          actions={state.actions}
+          actions={state.focusElement.length > 1 ? state.actions.filter(item => item.multiselect) : state.actions.filter(item => !item.multiselect)}
           hideContextMenu={hideContextMenu}
           createNewFile={handleNewFileInput}
           createNewFolder={handleNewFolderInput}
@@ -943,6 +1017,7 @@ export const FileExplorer = (props: FileExplorerProps) => {
           pageY={state.focusContext.y}
           path={state.focusContext.element}
           type={state.focusContext.type}
+          focus={state.focusElement}
           onMouseOver={(e) => {
             e.stopPropagation()
             handleMouseOver(state.focusContext.element)

libs/remix-ui/file-explorer/src/lib/types/index.ts

@@ -6,7 +6,7 @@ export interface FileExplorerProps {
     menuItems?: string[],
     plugin: any,
     focusRoot: boolean,
-    contextMenuItems: { id: string, name: string, type: string[], path: string[], extension: string[], pattern: string[] }[],
+    contextMenuItems: MenuItems,
     displayInput?: boolean,
     externalUploads?: EventTarget & HTMLInputElement
 }
@@ -29,11 +29,14 @@ export interface FileExplorerMenuProps {
     uploadFile: (target: EventTarget & HTMLInputElement) => void
 }
 
+export type action = { name: string, type: string[], path: string[], extension: string[], pattern: string[], id: string, multiselect: boolean }
+
+export type MenuItems = action[]
 export interface FileExplorerContextMenuProps {
-    actions: { name: string, type: string[], path: string[], extension: string[], pattern: string[], id: string }[],
+    actions: action[],
     createNewFile: (folder?: string) => void,
     createNewFolder: (parentFolder?: string) => void,
-    deletePath: (path: string) => void,
+    deletePath: (path: string | string[]) => void,
     renamePath: (path: string, type: string) => void,
     hideContextMenu: () => void,
     publishToGist?: (path?: string, type?: string) => void,
@@ -41,12 +44,13 @@ export interface FileExplorerContextMenuProps {
     publishFolderToGist?: (path?: string, type?: string) => void,
     publishFileToGist?: (path?: string, type?: string) => void,
     runScript?: (path: string) => void,
-    emit?: (id: string, path: string) => void,
+    emit?: (id: string, path: string | string[]) => void,
     pageX: number,
     pageY: number,
     path: string,
     type: string,
+    focus: {key:string, type:string}[],
     onMouseOver?: (...args) => void,
-    copy?: (path: string, type: string) => void
+    copy?: (path: string, type: string) => void,
     paste?: (destination: string, type: string) => void
 }

libs/remix-ui/tree-view/src/lib/tree-view-item/tree-view-item.tsx

@@ -14,7 +14,7 @@ export const TreeViewItem = (props: TreeViewItemProps) => {
   return (
     <li ref={innerRef} key={`treeViewLi${id}`} data-id={`treeViewLi${id}`} className='li_tv' {...otherProps}>
       <div key={`treeViewDiv${id}`} data-id={`treeViewDiv${id}`} className={`d-flex flex-row align-items-center ${labelClass}`} onClick={() => !controlBehaviour && setIsExpanded(!isExpanded)}>
-        { controlBehaviour ? null : children ? <div className={isExpanded ? `px-1 ${iconY} caret caret_tv` : `px-1 ${iconX} caret caret_tv`} style={{ visibility: children ? 'visible' : 'hidden' }}></div> : icon ? <div className={`pr-3 pl-1 ${icon} caret caret_tv`}></div> : null }
+        { children ? <div className={isExpanded ? `px-1 ${iconY} caret caret_tv` : `px-1 ${iconX} caret caret_tv`} style={{ visibility: children ? 'visible' : 'hidden' }}></div> : icon ? <div className={`pr-3 pl-1 ${icon} caret caret_tv`}></div> : null }
         <span className='w-100 pl-1'>
           { label }
         </span>