material-ui-treeview/index.d.ts

A React tree view for material-ui v1.

import * as React from 'react';
import { ExpansionPanelSummaryProps } from '@material-ui/core/ExpansionPanelSummary';
import { ExpansionPanelDetailsProps } from '@material-ui/core/ExpansionPanelDetails';
import { ListItemProps } from '@material-ui/core/ListItem';

export interface Tree {
  value: string;
  href?: string;
  nodes?: Array<string | Tree>;
  id?: string | number;
}

export interface MuiTreeViewProps {
  /**
   * The data to render as a tree view
   */
  tree: Tree[];

  /**
   * Callback function fired when a tree leaf is clicked.
   */
  onLeafClick?: (leaf: {
    value: string;
    parent: Tree;
    id?: string | number;
    href?: string;
  }) => void;

  /**
   * Callback function fired when a tree node is clicked.
   */
  onParentClick?: (parent: Tree) => void;

  /**
   * A search term to refine the tree
   */
  searchTerm?: string;

  /**
   * Given a `searchTerm`, a subtree will be shown if any parent node
   * higher up in the tree matches the search term. Defaults to false.
   */
  softSearch?: boolean;

  /**
   * Properties applied to the ExpansionPanelSummary element.
   */
  expansionPanelSummaryProps?: ExpansionPanelSummaryProps;

  /**
   * Properties applied to the ExpansionPanelDetails element.
   */
  expansionPanelDetailsProps?: ExpansionPanelDetailsProps;

  /**
   * Properties applied to the ListItem element.
   */
  listItemProps?: ListItemProps;

  /**
   * Makes search insensitive to case if true.
   * Defaults to false.
   */
  caseInsensitiveSearch?: boolean;

  /** Node to render when searchTerm is provided but the search filter 
   * returns no result.*/
  onEmptySearch?: React.ReactNode;

  /**
   * A React Router Link node to use. Required when a leaf node
   * has an href value.
   * */
  Link?: React.ReactNode;
}

export default class MuiTreeView extends React.Component<MuiTreeViewProps> {}