src/components/data-table-filters/data-table-filters-tree.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 { Tree, toggleNodeSelection, getNode, initTreeNode, getNodeChildrenIds, selectNode, deselectNodes } from '~/models/tree';
   7 import { Tree as TreeComponent, TreeItem, TreeItemStatus } from '~/components/tree/tree';
   8 import { noop, map } from "lodash/fp";
   9 import { toggleNodeCollapse } from '~/models/tree';
  10 import { countNodes, countChildren } from '~/models/tree';
  11
  12 export interface DataTableFilterItem {
  13     name: string;
  14 }
  15
  16 export type DataTableFilters = Tree<DataTableFilterItem>;
  17
  18 export interface DataTableFilterProps {
  19     filters: DataTableFilters;
  20     onChange?: (filters: DataTableFilters) => void;
  21
  22     /**
  23      * When set to true, only one filter can be selected at a time.
  24      */
  25     mutuallyExclusive?: boolean;
  26 }
  27
  28 export class DataTableFiltersTree extends React.Component<DataTableFilterProps> {
  29
  30     render() {
  31         const { filters } = this.props;
  32         const hasSubfilters = countNodes(filters) !== countChildren('')(filters);
  33         return <TreeComponent
  34             levelIndentation={hasSubfilters ? 20 : 0}
  35             itemRightPadding={20}
  36             items={filtersToTree(filters)}
  37             render={renderItem}
  38             showSelection
  39             useRadioButtons={this.props.mutuallyExclusive}
  40             toggleItemRadioButton={this.toggleRadioButtonFilter}
  41             disableRipple
  42             onContextMenu={noop}
  43             toggleItemActive={noop}
  44             toggleItemOpen={this.toggleOpen}
  45             toggleItemSelection={this.toggleFilter}
  46         />;
  47     }
  48
  49     /**
  50      * Handler for when a tree item is toggled via a radio button.
  51      * Ensures mutual exclusivity among filter tree items.
  52      */
  53     toggleRadioButtonFilter = (item: TreeItem<DataTableFilterItem>) => {
  54         const { onChange = noop } = this.props;
  55
  56         // If the filter is already selected, do nothing.
  57         if (item.selected) { return; }
  58
  59         // Otherwise select this node and deselect the others
  60         const filters = selectNode(item.id)(this.props.filters);
  61         const toDeselect = Object.keys(this.props.filters).filter((id) => (id !== item.id));
  62         onChange(deselectNodes(toDeselect)(filters));
  63     }
  64
  65     toggleFilter = (_: React.MouseEvent, item: TreeItem<DataTableFilterItem>) => {
  66         const { onChange = noop } = this.props;
  67         onChange(toggleNodeSelection(item.id)(this.props.filters));
  68     }
  69
  70     toggleOpen = (_: React.MouseEvent, item: TreeItem<DataTableFilterItem>) => {
  71         const { onChange = noop } = this.props;
  72         onChange(toggleNodeCollapse(item.id)(this.props.filters));
  73     }
  74 }
  75
  76 const renderItem = (item: TreeItem<DataTableFilterItem>) =>
  77     <span>{item.data.name}</span>;
  78
  79 const filterToTreeItem = (filters: DataTableFilters) =>
  80     (id: string): TreeItem<any> => {
  81         const node = getNode(id)(filters) || initTreeNode({ id: '', value: 'InvalidNode' });
  82         const items = getNodeChildrenIds(node.id)(filters)
  83             .map(filterToTreeItem(filters));
  84
  85         return {
  86             active: node.active,
  87             data: node.value,
  88             id: node.id,
  89             items: items.length > 0 ? items : undefined,
  90             open: node.expanded,
  91             selected: node.selected,
  92             status: TreeItemStatus.LOADED,
  93         };
  94     };
  95
  96 const filtersToTree = (filters: DataTableFilters): TreeItem<DataTableFilterItem>[] =>
  97     map(filterToTreeItem(filters), getNodeChildrenIds('')(filters));