src/components/data-explorer/data-explorer.tsx

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 import * as React from 'react';
   6 import { Grid, Paper, Toolbar, StyleRulesCallback, withStyles, WithStyles, TablePagination, IconButton, Tooltip } from '@material-ui/core';
   7 import { ColumnSelector } from "../column-selector/column-selector";
   8 import { DataTable, DataColumns } from "../data-table/data-table";
   9 import { DataColumn, SortDirection } from "../data-table/data-column";
  10 import { SearchInput } from '../search-input/search-input';
  11 import { ArvadosTheme } from "~/common/custom-theme";
  12 import { createTree } from '~/models/tree';
  13 import { DataTableFilters } from '../data-table-filters/data-table-filters-tree';
  14 import { MoreOptionsIcon } from '~/components/icon/icon';
  15
  16 type CssRules = 'searchBox' | "toolbar" | "footer" | "root" | 'moreOptionsButton';
  17
  18 const styles: StyleRulesCallback<CssRules> = (theme: ArvadosTheme) => ({
  19     searchBox: {
  20         paddingBottom: theme.spacing.unit * 2
  21     },
  22     toolbar: {
  23         paddingTop: theme.spacing.unit * 2
  24     },
  25     footer: {
  26         overflow: 'auto'
  27     },
  28     root: {
  29         height: '100%'
  30     },
  31     moreOptionsButton: {
  32         padding: 0
  33     }
  34 });
  35
  36 interface DataExplorerDataProps<T> {
  37     items: T[];
  38     itemsAvailable: number;
  39     columns: DataColumns<T>;
  40     searchValue: string;
  41     rowsPerPage: number;
  42     rowsPerPageOptions: number[];
  43     page: number;
  44     contextMenuColumn: boolean;
  45     dataTableDefaultView?: React.ReactNode;
  46     working?: boolean;
  47     isColumnSelectorHidden?: boolean;
  48 }
  49
  50 interface DataExplorerActionProps<T> {
  51     onSetColumns: (columns: DataColumns<T>) => void;
  52     onSearch: (value: string) => void;
  53     onRowClick: (item: T) => void;
  54     onRowDoubleClick: (item: T) => void;
  55     onColumnToggle: (column: DataColumn<T>) => void;
  56     onContextMenu: (event: React.MouseEvent<HTMLElement>, item: T) => void;
  57     onSortToggle: (column: DataColumn<T>) => void;
  58     onFiltersChange: (filters: DataTableFilters, column: DataColumn<T>) => void;
  59     onChangePage: (page: number) => void;
  60     onChangeRowsPerPage: (rowsPerPage: number) => void;
  61     extractKey?: (item: T) => React.Key;
  62 }
  63
  64 type DataExplorerProps<T> = DataExplorerDataProps<T> & DataExplorerActionProps<T> & WithStyles<CssRules>;
  65
  66 export const DataExplorer = withStyles(styles)(
  67     class DataExplorerGeneric<T> extends React.Component<DataExplorerProps<T>> {
  68         componentDidMount() {
  69             if (this.props.onSetColumns) {
  70                 this.props.onSetColumns(this.props.columns);
  71             }
  72         }
  73         render() {
  74             const {
  75                 columns, onContextMenu, onFiltersChange, onSortToggle, working, extractKey,
  76                 rowsPerPage, rowsPerPageOptions, onColumnToggle, searchValue, onSearch,
  77                 items, itemsAvailable, onRowClick, onRowDoubleClick, classes,
  78                 dataTableDefaultView, isColumnSelectorHidden
  79             } = this.props;
  80             return <Paper className={classes.root}>
  81                 <Toolbar className={classes.toolbar}>
  82                     <Grid container justify="space-between" wrap="nowrap" alignItems="center">
  83                         <div className={classes.searchBox}>
  84                             <SearchInput
  85                                 value={searchValue}
  86                                 onSearch={onSearch} />
  87                         </div>
  88                         {!isColumnSelectorHidden && <ColumnSelector
  89                             columns={columns}
  90                             onColumnToggle={onColumnToggle} />}
  91                     </Grid>
  92                 </Toolbar>
  93                 <DataTable
  94                     columns={this.props.contextMenuColumn ? [...columns, this.contextMenuColumn] : columns}
  95                     items={items}
  96                     onRowClick={(_, item: T) => onRowClick(item)}
  97                     onContextMenu={onContextMenu}
  98                     onRowDoubleClick={(_, item: T) => onRowDoubleClick(item)}
  99                     onFiltersChange={onFiltersChange}
 100                     onSortToggle={onSortToggle}
 101                     extractKey={extractKey}
 102                     working={working}
 103                     defaultView={dataTableDefaultView}
 104                 />
 105                 <Toolbar className={classes.footer}>
 106                     <Grid container justify="flex-end">
 107                         <TablePagination
 108                             count={itemsAvailable}
 109                             rowsPerPage={rowsPerPage}
 110                             rowsPerPageOptions={rowsPerPageOptions}
 111                             page={this.props.page}
 112                             onChangePage={this.changePage}
 113                             onChangeRowsPerPage={this.changeRowsPerPage}
 114                             component="div" />
 115                     </Grid>
 116                 </Toolbar>
 117             </Paper>;
 118         }
 119
 120         changePage = (event: React.MouseEvent<HTMLButtonElement>, page: number) => {
 121             this.props.onChangePage(page);
 122         }
 123
 124         changeRowsPerPage: React.ChangeEventHandler<HTMLTextAreaElement | HTMLInputElement> = (event) => {
 125             this.props.onChangeRowsPerPage(parseInt(event.target.value, 10));
 126         }
 127
 128         renderContextMenuTrigger = (item: T) =>
 129             <Grid container justify="center">
 130                 <Tooltip title="More options" disableFocusListener>
 131                     <IconButton className={this.props.classes.moreOptionsButton} onClick={event => this.props.onContextMenu(event, item)}>
 132                         <MoreOptionsIcon />
 133                     </IconButton>
 134                 </Tooltip>
 135             </Grid>
 136
 137         contextMenuColumn: DataColumn<any> = {
 138             name: "Actions",
 139             selected: true,
 140             configurable: false,
 141             sortDirection: SortDirection.NONE,
 142             filters: createTree(),
 143             key: "context-actions",
 144             render: this.renderContextMenuTrigger
 145         };
 146     }
 147 );