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             disableRipple
  41             onContextMenu={noop}
  42             toggleItemActive={this.props.mutuallyExclusive ? this.toggleRadioButtonFilter : noop}
  43             toggleItemOpen={this.toggleOpen}
  44             toggleItemSelection={this.toggleFilter}
  45         />;
  46     }
  47
  48     /**
  49      * Handler for when a tree item is toggled via a radio button.
  50      * Ensures mutual exclusivity among filter tree items.
  51      */
  52     toggleRadioButtonFilter = (_: any, item: TreeItem<DataTableFilterItem>) => {
  53         const { onChange = noop } = this.props;
  54
  55         // If the filter is already selected, do nothing.
  56         if (item.selected) { return; }
  57
  58         // Otherwise select this node and deselect the others
  59         const filters = selectNode(item.id)(this.props.filters);
  60         const toDeselect = Object.keys(this.props.filters).filter((id) => (id !== item.id));
  61         onChange(deselectNodes(toDeselect)(filters));
  62     }
  63
  64     toggleFilter = (_: React.MouseEvent, item: TreeItem<DataTableFilterItem>) => {
  65         const { onChange = noop } = this.props;
  66         onChange(toggleNodeSelection(item.id)(this.props.filters));
  67     }
  68
  69     toggleOpen = (_: React.MouseEvent, item: TreeItem<DataTableFilterItem>) => {
  70         const { onChange = noop } = this.props;
  71         onChange(toggleNodeCollapse(item.id)(this.props.filters));
  72     }
  73 }
  74
  75 const renderItem = (item: TreeItem<DataTableFilterItem>) =>
  76     <span>{item.data.name}</span>;
  77
  78 const filterToTreeItem = (filters: DataTableFilters) =>
  79     (id: string): TreeItem<any> => {
  80         const node = getNode(id)(filters) || initTreeNode({ id: '', value: 'InvalidNode' });
  81         const items = getNodeChildrenIds(node.id)(filters)
  82             .map(filterToTreeItem(filters));
  83
  84         return {
  85             active: node.active,
  86             data: node.value,
  87             id: node.id,
  88             items: items.length > 0 ? items : undefined,
  89             open: node.expanded,
  90             selected: node.selected,
  91             status: TreeItemStatus.LOADED,
  92         };
  93     };
  94
  95 const filtersToTree = (filters: DataTableFilters): TreeItem<DataTableFilterItem>[] =>
  96     map(filterToTreeItem(filters), getNodeChildrenIds('')(filters));