Merge branch '13634-data-explorer-context-menu'
authorMichal Klobukowski <michal.klobukowski@contractors.roche.com>
Tue, 19 Jun 2018 13:06:36 +0000 (15:06 +0200)
committerMichal Klobukowski <michal.klobukowski@contractors.roche.com>
Tue, 19 Jun 2018 13:06:36 +0000 (15:06 +0200)
refs #13634

Arvados-DCO-1.1-Signed-off-by: Michal Klobukowski <michal.klobukowski@contractors.roche.com>

src/components/context-menu/context-menu.test.tsx [new file with mode: 0644]
src/components/context-menu/context-menu.tsx [new file with mode: 0644]
src/components/data-explorer/data-explorer.tsx
src/components/data-table/data-table.tsx
src/components/popover/helpers.ts [new file with mode: 0644]
src/views/data-explorer/data-explorer.tsx

diff --git a/src/components/context-menu/context-menu.test.tsx b/src/components/context-menu/context-menu.test.tsx
new file mode 100644 (file)
index 0000000..9e4a9a4
--- /dev/null
@@ -0,0 +1,51 @@
+// Copyright (C) The Arvados Authors. All rights reserved.
+//
+// SPDX-License-Identifier: AGPL-3.0
+
+import * as React from "react";
+import { mount, configure, shallow } from "enzyme";
+import * as Adapter from "enzyme-adapter-react-16";
+import ContextMenu from "./context-menu";
+import { ListItem } from "@material-ui/core";
+
+configure({ adapter: new Adapter() });
+
+describe("<ContextMenu />", () => {
+
+    const item = {
+        name: "",
+        owner: "",
+        lastModified: "",
+        type: ""
+    };
+
+    const actions = [[{
+        icon: "",
+        name: "Action 1.1",
+        onClick: jest.fn()
+    },
+    {
+        icon: "",
+        name: "Action 1.2",
+        onClick: jest.fn()
+    },], [{
+        icon: "",
+        name: "Action 2.1",
+        onClick: jest.fn()
+    }]];
+
+    it("calls provided actions with provided item", () => {
+        const contextMenu = mount(<ContextMenu
+            anchorEl={document.createElement("div")}
+            onClose={jest.fn()}
+            {...{ actions, item }} />);
+
+        contextMenu.find(ListItem).at(0).simulate("click");
+        contextMenu.find(ListItem).at(1).simulate("click");
+        contextMenu.find(ListItem).at(2).simulate("click");
+
+        expect(actions[0][0].onClick).toHaveBeenCalledWith(item);
+        expect(actions[0][1].onClick).toHaveBeenCalledWith(item);
+        expect(actions[1][0].onClick).toHaveBeenCalledWith(item);
+    });
+});
\ No newline at end of file
diff --git a/src/components/context-menu/context-menu.tsx b/src/components/context-menu/context-menu.tsx
new file mode 100644 (file)
index 0000000..c86c517
--- /dev/null
@@ -0,0 +1,52 @@
+// Copyright (C) The Arvados Authors. All rights reserved.
+//
+// SPDX-License-Identifier: AGPL-3.0
+import * as React from "react";
+import { Popover, List, ListItem, ListItemIcon, ListItemText, Divider } from "@material-ui/core";
+import { DefaultTransformOrigin } from "../popover/helpers";
+
+export interface ContextMenuAction<T> {
+    name: string;
+    icon: string;
+    onClick: (item: T) => void;
+}
+
+export type ContextMenuActionGroup<T> = Array<ContextMenuAction<T>>;
+
+export interface ContextMenuProps<T> {
+    anchorEl?: HTMLElement;
+    item?: T;
+    onClose: () => void;
+    actions: Array<ContextMenuActionGroup<T>>;
+}
+
+export default class ContextMenu<T> extends React.PureComponent<ContextMenuProps<T>> {
+    render() {
+        const { anchorEl, onClose, actions, item } = this.props;
+        return <Popover
+            anchorEl={anchorEl}
+            open={Boolean(anchorEl)}
+            onClose={onClose}
+            transformOrigin={DefaultTransformOrigin}
+            anchorOrigin={DefaultTransformOrigin}>
+            <List dense>
+                {actions.map((group, groupIndex) =>
+                    <React.Fragment key={groupIndex}>
+                        {group.map((action, actionIndex) =>
+                            <ListItem
+                                button
+                                key={actionIndex}
+                                onClick={() => item && action.onClick(item)}>
+                                <ListItemIcon>
+                                    <i className={action.icon} />
+                                </ListItemIcon>
+                                <ListItemText>
+                                    {action.name}
+                                </ListItemText>
+                            </ListItem>)}
+                        {groupIndex < actions.length - 1 && <Divider />}
+                    </React.Fragment>)}
+            </List>
+        </Popover>;
+    }
+}
index 9aeb28a7a5d5f50115774c7a21c8588bc23df3ab..874c32595251c7ee169512f5ba93a67212113abe 100644 (file)
 // SPDX-License-Identifier: AGPL-3.0
 
 import * as React from 'react';
-import { DataTable, DataTableProps, DataColumn, ColumnSelector } from "../../components/data-table";
-import { Typography, Grid, ListItem, Divider, List, ListItemIcon, ListItemText, Paper, Toolbar } from '@material-ui/core';
-import IconButton, { IconButtonProps } from '@material-ui/core/IconButton';
+import { DataTable, DataColumn, ColumnSelector } from "../../components/data-table";
+import { Typography, Grid, Paper, Toolbar } from '@material-ui/core';
+import IconButton from '@material-ui/core/IconButton';
 import MoreVertIcon from "@material-ui/icons/MoreVert";
-import Popover from '../popover/popover';
 import { formatFileSize, formatDate } from '../../common/formatters';
 import { DataItem } from './data-item';
-
+import { mockAnchorFromMouseEvent } from '../popover/helpers';
+import ContextMenu from '../context-menu/context-menu';
+
+export interface DataExplorerContextActions {
+    onAddToFavourite: (dataIitem: DataItem) => void;
+    onCopy: (dataIitem: DataItem) => void;
+    onDownload: (dataIitem: DataItem) => void;
+    onMoveTo: (dataIitem: DataItem) => void;
+    onRemove: (dataIitem: DataItem) => void;
+    onRename: (dataIitem: DataItem) => void;
+    onShare: (dataIitem: DataItem) => void;
+}
 interface DataExplorerProps {
     items: DataItem[];
     onItemClick: (item: DataItem) => void;
+    contextActions: DataExplorerContextActions;
 }
 
-type DataExplorerState = Pick<DataTableProps<DataItem>, "columns">;
+interface DataExplorerState {
+    columns: Array<DataColumn<DataItem>>;
+    contextMenu: {
+        anchorEl?: HTMLElement;
+        item?: DataItem;
+    };
+}
 
 class DataExplorer extends React.Component<DataExplorerProps, DataExplorerState> {
     state: DataExplorerState = {
-        columns: [
-            {
-                name: "Name",
-                selected: true,
-                render: item => this.renderName(item)
-            },
-            {
-                name: "Status",
-                selected: true,
-                render: item => renderStatus(item.status)
-            },
-            {
-                name: "Type",
-                selected: true,
-                render: item => renderType(item.type)
-            },
-            {
-                name: "Owner",
-                selected: true,
-                render: item => renderOwner(item.owner)
-            },
-            {
-                name: "File size",
-                selected: true,
-                render: (item) => renderFileSize(item.fileSize)
-            },
-            {
-                name: "Last modified",
-                selected: true,
-                render: item => renderDate(item.lastModified)
-            },
-            {
-                name: "Actions",
-                selected: true,
-                configurable: false,
-                renderHeader: () => null,
-                render: renderItemActions
-            }
-        ]
+        contextMenu: {},
+        columns: [{
+            name: "Name",
+            selected: true,
+            render: item => this.renderName(item)
+        }, {
+            name: "Status",
+            selected: true,
+            render: item => renderStatus(item.status)
+        }, {
+            name: "Type",
+            selected: true,
+            render: item => renderType(item.type)
+        }, {
+            name: "Owner",
+            selected: true,
+            render: item => renderOwner(item.owner)
+        }, {
+            name: "File size",
+            selected: true,
+            render: item => renderFileSize(item.fileSize)
+        }, {
+            name: "Last modified",
+            selected: true,
+            render: item => renderDate(item.lastModified)
+        }, {
+            name: "Actions",
+            selected: true,
+            configurable: false,
+            renderHeader: () => null,
+            render: item => this.renderActions(item)
+        }]
     };
 
+    contextMenuActions = [[{
+        icon: "fas fa-users fa-fw",
+        name: "Share",
+        onClick: this.handleContextAction("onShare")
+    }, {
+        icon: "fas fa-sign-out-alt fa-fw",
+        name: "Move to",
+        onClick: this.handleContextAction("onMoveTo")
+    }, {
+        icon: "fas fa-star fa-fw",
+        name: "Add to favourite",
+        onClick: this.handleContextAction("onAddToFavourite")
+    }, {
+        icon: "fas fa-edit fa-fw",
+        name: "Rename",
+        onClick: this.handleContextAction("onRename")
+    }, {
+        icon: "fas fa-copy fa-fw",
+        name: "Make a copy",
+        onClick: this.handleContextAction("onCopy")
+    }, {
+        icon: "fas fa-download fa-fw",
+        name: "Download",
+        onClick: this.handleContextAction("onDownload")
+    }], [{
+        icon: "fas fa-trash-alt fa-fw",
+        name: "Remove",
+        onClick: this.handleContextAction("onRemove")
+    }
+    ]];
+
     render() {
         return <Paper>
+            <ContextMenu
+                {...this.state.contextMenu}
+                actions={this.contextMenuActions}
+                onClose={this.closeContextMenu} />
             <Toolbar>
                 <Grid container justify="flex-end">
                     <ColumnSelector
@@ -72,7 +117,8 @@ class DataExplorer extends React.Component<DataExplorerProps, DataExplorerState>
             </Toolbar>
             <DataTable
                 columns={this.state.columns}
-                items={this.props.items} />
+                items={this.props.items}
+                onRowContextMenu={this.openItemMenuOnRowClick} />
             <Toolbar />
         </Paper>;
     }
@@ -101,6 +147,43 @@ class DataExplorer extends React.Component<DataExplorerProps, DataExplorerState>
             </Grid>
         </Grid>
 
+    renderActions = (item: DataItem) =>
+        <Grid container justify="flex-end">
+            <IconButton onClick={event => this.openItemMenuOnActionsClick(event, item)}>
+                <MoreVertIcon />
+            </IconButton>
+        </Grid>
+
+    openItemMenuOnRowClick = (event: React.MouseEvent<HTMLElement>, item: DataItem) => {
+        event.preventDefault();
+        this.setState({
+            contextMenu: {
+                anchorEl: mockAnchorFromMouseEvent(event),
+                item
+            }
+        });
+    }
+
+    openItemMenuOnActionsClick = (event: React.MouseEvent<HTMLElement>, item: DataItem) => {
+        this.setState({
+            contextMenu: {
+                anchorEl: event.currentTarget,
+                item
+            }
+        });
+    }
+
+    closeContextMenu = () => {
+        this.setState({ contextMenu: {} });
+    }
+
+    handleContextAction(action: keyof DataExplorerContextActions) {
+        return (item: DataItem) => {
+            this.closeContextMenu();
+            this.props.contextActions[action](item);
+        };
+    }
+
 }
 
 const renderIcon = (dataItem: DataItem) => {
@@ -139,53 +222,4 @@ const renderStatus = (status?: string) =>
         {status || "-"}
     </Typography>;
 
-const renderItemActions = () =>
-    <Grid container justify="flex-end">
-        <Popover triggerComponent={ItemActionsTrigger}>
-            <List dense>
-                {[{
-                    icon: "fas fa-users",
-                    label: "Share"
-                },
-                {
-                    icon: "fas fa-sign-out-alt",
-                    label: "Move to"
-                },
-                {
-                    icon: "fas fa-star",
-                    label: "Add to favourite"
-                },
-                {
-                    icon: "fas fa-edit",
-                    label: "Rename"
-                },
-                {
-                    icon: "fas fa-copy",
-                    label: "Make a copy"
-                },
-                {
-                    icon: "fas fa-download",
-                    label: "Download"
-                }].map(renderAction)}
-                < Divider />
-                {renderAction({ icon: "fas fa-trash-alt", label: "Remove" })}
-            </List>
-        </Popover>
-    </Grid>;
-
-const renderAction = (action: { label: string, icon: string }, index?: number) =>
-    <ListItem button key={index}>
-        <ListItemIcon>
-            <i className={action.icon} />
-        </ListItemIcon>
-        <ListItemText>
-            {action.label}
-        </ListItemText>
-    </ListItem>;
-
-const ItemActionsTrigger: React.SFC<IconButtonProps> = (props) =>
-    <IconButton {...props}>
-        <MoreVertIcon />
-    </IconButton>;
-
 export default DataExplorer;
index e7ce03ada3d4cdd24bec91e9b643c12f9a299382..ec260e967b02afbc03797d3e235a412610ff427f 100644 (file)
@@ -9,12 +9,13 @@ import { DataColumn } from './data-column';
 export interface DataTableProps<T> {
     items: T[];
     columns: Array<DataColumn<T>>;
-    onItemClick?: (item: T) => void;
+    onRowClick?: (event: React.MouseEvent<HTMLTableRowElement>, item: T) => void;
+    onRowContextMenu?: (event: React.MouseEvent<HTMLTableRowElement>, item: T) => void;
 }
 
 class DataTable<T> extends React.Component<DataTableProps<T> & WithStyles<CssRules>> {
     render() {
-        const { items, columns, classes, onItemClick } = this.props;
+        const { items, columns, classes, onRowClick, onRowContextMenu } = this.props;
         return <div className={classes.tableContainer}>
             {items.length > 0 ?
                 <Table>
@@ -35,7 +36,8 @@ class DataTable<T> extends React.Component<DataTableProps<T> & WithStyles<CssRul
                                 <TableRow
                                     hover
                                     key={index}
-                                    onClick={() => onItemClick && onItemClick(item)}>
+                                    onClick={event => onRowClick && onRowClick(event, item)}
+                                    onContextMenu={event => onRowContextMenu && onRowContextMenu(event, item)}>
                                     {columns
                                         .filter(column => column.selected)
                                         .map((column, index) => (
diff --git a/src/components/popover/helpers.ts b/src/components/popover/helpers.ts
new file mode 100644 (file)
index 0000000..13f74a6
--- /dev/null
@@ -0,0 +1,24 @@
+// Copyright (C) The Arvados Authors. All rights reserved.
+//
+// SPDX-License-Identifier: AGPL-3.0
+
+import { PopoverOrigin } from "@material-ui/core/Popover";
+
+export const mockAnchorFromMouseEvent = (event: React.MouseEvent<HTMLElement>) => {
+    const el = document.createElement('div');
+    const clientRect = {
+        left: event.clientX,
+        right: event.clientX,
+        top: event.clientY,
+        bottom: event.clientY,
+        width: 0,
+        height: 0
+    };
+    el.getBoundingClientRect = () => clientRect;
+    return el;
+};
+
+export const DefaultTransformOrigin: PopoverOrigin = {
+    vertical: "top",
+    horizontal: "right",
+};
\ No newline at end of file
index 5f17b638f1a89888e117d275b5f737b182a79dd8..da09b695dbb047f2bf564a5edb7c94ec264feaa2 100644 (file)
@@ -13,6 +13,7 @@ import { push } from 'react-router-redux';
 import projectActions from "../../store/project/project-action";
 import { DataExplorer, DataItem } from '../../components/data-explorer';
 import { TreeItem } from '../../components/tree/tree';
+import { DataExplorerContextActions } from '../../components/data-explorer/data-explorer';
 
 interface DataExplorerViewDataProps {
     projects: ProjectState;
@@ -35,10 +36,21 @@ class DataExplorerView extends React.Component<DataExplorerViewProps, DataExplor
             <DataExplorer
                 items={projectItems.map(mapTreeItem)}
                 onItemClick={this.goToProject}
+                contextActions={this.contextActions}
             />
         );
     }
 
+    contextActions: DataExplorerContextActions = {
+        onAddToFavourite: console.log,
+        onCopy: console.log,
+        onDownload: console.log,
+        onMoveTo: console.log,
+        onRemove: console.log,
+        onRename: console.log,
+        onShare: console.log
+    };
+
     goToProject = (project: MappedProjectItem) => {
         this.props.dispatch(push(`/project/${project.uuid}`));
         this.props.dispatch(projectActions.TOGGLE_PROJECT_TREE_ITEM(project.uuid));