npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

mui-dt

v0.11.0

Published

Datatables for React using Material-UI

Downloads

7

Readme

MUI-DT - Datatables for Material-UI

Build Status Coverage Status npm version

MUI-DT is a data tables component built on Material-UI. It comes with features like filtering, resizable + view/hide columns, search, export to CSV download, printing, selectable rows, expandable rows, pagination, and sorting. On top of the ability to customize styling on most views, there are 3 display modes "stacked", "scroll", and "responsiveStacked".

You can try the table out live in a CodeSandbox here: https://codesandbox.io/s/github/patorjk/mui-dt

Install

npm install mui-dt --save

Usage

For a simple table:


import MuiDt from "mui-dt";

const columns = ["Name", "Company", "City", "State"];

const data = [
 ["Joe James", "Test Corp", "Yonkers", "NY"],
 ["John Walsh", "Test Corp", "Hartford", "CT"],
 ["Bob Herm", "Test Corp", "Tampa", "FL"],
 ["James Houston", "Test Corp", "Dallas", "TX"],
];

const options = {
  filterType: 'checkbox',
};

<MuiDt
  title={"Employee List"}
  data={data}
  columns={columns}
  options={options}
/>

Or customize columns:


import MuiDt from "mui-dt";

const columns = [
 {
  name: "name",
  label: "Name",
  options: {
   filter: true,
   sort: true,
  }
 },
 {
  name: "company",
  label: "Company",
  options: {
   filter: true,
   sort: false,
  }
 },
 {
  name: "city",
  label: "City",
  options: {
   filter: true,
   sort: false,
  }
 },
 {
  name: "state",
  label: "State",
  options: {
   filter: true,
   sort: false,
  }
 },
];

const data = [
 { name: "Joe James", company: "Test Corp", city: "Yonkers", state: "NY" },
 { name: "John Walsh", company: "Test Corp", city: "Hartford", state: "CT" },
 { name: "Bob Herm", company: "Test Corp", city: "Tampa", state: "FL" },
 { name: "James Houston", company: "Test Corp", city: "Dallas", state: "TX" },
];

const options = {
  filterType: 'checkbox',
};

<MuiDt
  title={"Employee List"}
  data={data}
  columns={columns}
  options={options}
/>

Cell data values should be a string, number, boolean, undefined, null, or array. Cells with data values of objects {} can cause issues.

API

<MUIDT />

The component accepts the following props:

|Name|Type|Description |:--:|:-----|:-----| |columns|array|Columns used to describe table. Must be either an array of simple strings or objects describing a column |data|array|Data used to describe table. Must be an array containing objects. (Arrays containing just strings or numbers also supported) |options|object|Options used to describe table |title|array|Title used to caption table

Options:

|Name|Type|Default|Description |:--:|:-----|:--|:-----| |caseSensitive |boolean|false|Enable/disable case sensitivity for search. |checkboxColor |string|'primary'|Color of the checkbox. Options are: 'primary', 'secondary', 'default'. |customFooter|function||Render a custom table footer. function(count, page, rowsPerPage, changeRowsPerPage, changePage, textLabels: object) => string| React Component Example |customRowRender |function||Override default row rendering with custom function. You probably don't need to use this, see the setRowProps method instead (this render method is more powerful, but it will be more work for you). customRowRender(data, dataIndex, rowIndex) => React Component |customSearch |function||Override default search with custom function. customSearch(searchQuery: string, currentRow: array, columns: array) => boolean |customSearchRender |function||Render a custom table search. For a debounced search, there is a plug-in called "debounceSearchRender" you can use here. See the plug-in section for more details. customSearchRender(searchText: string, handleSearch, hideSearch, options) => React Component |customSort|function||Override default sorting with custom function. function(data: array, colIndex: number, order: string) => array |customToolbar|function||Render a custom toolbar. |customToolbarSelect|function||Render a custom selected rows toolbar. function(selectedRows, displayData, setSelectedRows) => void |count|number||User provided override for total number of rows. |disableSelectToolbar|boolean|false|Enable/disable the Select Toolbar that appears when a row is selected. |displayMode|string|'stacked'|The display mode for the table. Options: 'stacked', 'scroll', or 'responsiveStacked'. 'responsiveStacked' will have the table in 'stacked' mode when on smaller screens and 'scroll' mode on larger screens. Use the 'tableBodyHeight to adjust the table's height. |download|boolean|true|Show/hide download icon from toolbar. |downloadOptions|object|{filename: 'tableDownload.csv', separator: ','}|Options to change the output of the CSV file: filename: string, separator: string, filterOptions: object(useDisplayedColumnsOnly: boolean, useDisplayedRowsOnly: boolean) |elevation|number|4|Shadow depth applied to Paper component. |expandableRows|boolean|false|Enable/disable expandable rows. |expandableRowsHeader|boolean|true|Show/hide the expand all/collapse all row header for expandable rows. |expandableRowsOnClick|boolean|false|Enable/disable expand trigger when row is clicked. When False, only expand icon will trigger this action. |filter|boolean|true|Show/hide filter icon from toolbar. |filterType |string||Choice of filtering view. enum('checkbox', 'dropdown', 'multiselect', 'textField') |filterPopoverOptions|object|{mustConfirm: false, confirmButtonLabel: 'Submit'}|Options to change the filter popover. Can be useful for serverSide filtering where you want to confirm the filters before applying them. Options: mustConfirm: boolean, confirmButtonLabel: string |fixedHeader|boolean|true|Enable/disable fixed header columns. |isRowExpandable|function||Enable/disable expansion or collapse on certain expandable rows with custom function. Will be considered true if not provided. function(dataIndex: number, expandedRows: object(lookup: {dataIndex: number}, data: arrayOfObjects: {index: number, dataIndex: number})) => bool. |isRowSelectable|function||Enable/disable selection on certain rows with custom function. Returns true if not provided. function(dataIndex: number, selectedRows: object(lookup: {[dataIndex]: boolean}, data: arrayOfObjects: {index: number, dataIndex: number})) => boolean. |onCellClick|function||Callback function that triggers when a cell is clicked. function(colData: any, cellMeta: { colIndex: number, rowIndex: number, dataIndex: number }) => void |onChangePage|function||Callback function that triggers when a page has changed. function(currentPage: number) => void |onChangeRowsPerPage|function||Callback function that triggers when the number of rows per page has changed. function(numberOfRows: number) => void |onColumnSortChange|function||Callback function that triggers when a column has been sorted. function(changedColumn: string, direction: string) => void |onColumnViewChange|function||Callback function that triggers when a column view has been changed. function(changedColumn: string, action: string) => void |onDownload|function||A callback function that triggers when the user downloads the CSV file. In the callback, you can control what is written to the CSV file. function(buildHead: (columns) => string, buildBody: (data) => string, columns, data) => string. Return false to cancel download of file. |onFilterChipClose|function||Callback function that triggers when a filter is removed via the user pressing X on a filter chip to remove one of the filters. function(changedColumnIndex: number, removedFilter: array, filterList: array,) => void |onFilterChange|function||Callback function that triggers when filters have changed. function(changedColumnIndex: number, filterList: array) => void |onFilterConfirm|function||Callback function that is triggered when a user presses the "confirm" button on the filter popover. This occurs only if you've set filterPopoverOptions.mustConfirm option to true. function(filterList: array) => void |onRowClick|function||Callback function that triggers when a row is clicked. function(rowData: string[], rowMeta: { dataIndex: number, rowIndex: number }) => void |onRowExpansionChange|function||Callback function that triggers when a row is expanded or collapsed. The rowsExpanded parameter can be used to save off the value for options.rowsExpanded for state changes. function(affectedRows: array, allRowsExpanded: array, rowsExpanded: array) => void Example |onRowsDelete|function||Callback function that triggers when row(s) are deleted. function(rowsDeleted: object(lookup: {[dataIndex]: boolean}, data: arrayOfObjects: {index: number, dataIndex: number})) => void OR false (Returning false prevents row deletion.) |onRowSelectionChange|function||Callback function that triggers when row(s) are selected/unselected. If setting state, the rowsSelected parameter can be used to set options.rowsSelected. function(affectedRows: array, allSelectedRows: array, rowsSelected: rowsSelected) => void Example |onSearchChange|function||Callback function that triggers when the search text value has changed. function(searchText: string) => void |onSearchClose|function||Callback function that triggers when the searchbox closes. function() => void |onSearchOpen|function||Callback function that triggers when the searchbox opens. function() => void |onTableChange|function||Callback function that triggers when table state has changed. function(action: string, tableState: object) => void |onTableInit|function||Callback function that triggers when table state has been initialized. function(action: string, tableState: object) => void |page|number||User provided starting page for pagination. |pagination|boolean|true|Enable/disable pagination. |print|boolean|true|Show/hide print icon from toolbar. |renderExpandableRow|function||Render expandable row. function(rowData, rowMeta) => React Component |resizableColumns|boolean|false|Enable/disable resizable columns. |rowHover|boolean|true|Enable/disable hover style over rows. |rowsExpanded|array||User provided expanded rows. |rowsPerPage|number|10|Number of rows allowed per page. |rowsPerPageOptions|array|[10,15,100]|Options to provide in pagination for number of rows a user can select. |rowsSelected|array||User provided selected rows. |selectableRows|string|'multiple'|Numbers of rows that can be selected. Options are 'multiple', 'single', 'none'. |selectableRowsHeader|boolean|true|Show/hide the select all/deselect all checkbox header for selectable rows. |selectableRowsOnClick|boolean|false|Enable/disable select toggle when row is clicked. When False, only checkbox will trigger this action. |search|boolean|true|Show/hide search icon from toolbar. |searchText|string||Initial search text. |searchProps|object|{}|Props applied to the search text box. You can set the placeholder text this way as well as add method callbacks like onBlur, onKeyUp, etc. Example |setRowProps|function||Is called for each row and allows you to return custom props for this row based on its data. function(row: array, dataIndex: number) => object Example |serverSide|boolean|false|Enable remote data source. When setting this option to true, the developer is responsible for the filtering, sorting, etc, of the data and for updating the options and columns inputs to the table. Example |showSearch|boolean|false|Shows the search bar when the table toolbar rendered. Example |sort|boolean|true|Enable/disable sort on all columns. |sortOrder|object|{}|Sets the column to sort by and the sort direction. To remove/reset sorting, input in an empty object. Options: columnName: string, sortDirection: enum('asc', 'desc') Example |sortFilterList|boolean|true|Enable/disable alphanumeric sorting of filter lists. |tableProps|object|{}|Props applied to the table. You can set the table up to be a "dense" table this way. Example |tableBodyHeight|string|'none'|The height of the body of the table. This is a CSS string value (ex: '500px', 'none', '100%', etc). Example |textLabels |object||User provided labels to localize text |viewColumns|boolean|true|Show/hide viewColumns icon from toolbar.

Customize Columns

On each column object, you have the ability to customize columns to your liking with the 'options' property. Example:

const columns = [
 {
  name: "Name",
  options: {
   filter: true,
   sort: false
  }
 },
 ...
];

Column:

|Name|Type|Description |:--:|:-----|:-----| |name|string|Name of column (This field is required) |label|string|Column Header Name override |options|object|Options for customizing column

Column Options:

|Name|Type|Default|Description |:--:|:-----|:--|:-----| |customBodyRender|function||Function that returns a string or React component. Used to display data within a table cell of a given column. function(value, tableMeta, updateValue) => string| React Component Example |customBodyRenderLite|function||Function that returns a string or React component. Used to display data within a table cell of a given column. This function has better performance than customBodyRender at the cost of some functionality (different arguments and filtering is done with pre-processed data). If you have a client-side table with 1000+ rows, this is what you should use. function(dataIndex, rowIndex) => string| React Component Example |customHeadLabelRender|function||Function that returns a string or React component. Used to replace the display for the column header's label. function(columnMeta, sortOrder, handleToggleColumn) => string| React Component |customHeadRender|function||Function that returns a string or React component. Used as display for column header. In most cases you want customHeadLabelRender instead, as this method is for overriding the full header cell. function(columnMeta, handleToggleColumn) => string| React Component |display|string|'true'|Display column in table. enum('true', 'false', 'excluded') |download|boolean|true|Display column in CSV download file. |empty|boolean|false|This denotes whether the column has data or not (for use with intentionally empty columns). |filter|boolean|true|Display column in filter list. |filterList|array||Filter value list. Example |filterOptions|{names, logic, display}||With filter options, it's possible to use custom names for the filter fields. Example, custom filter logic Example, and custom rendering. Example |customFilterListRender|function||Function that returns a string used as the chip label. function(value) => string Example |filterType |string|'dropdown'|Choice of filtering view. Takes priority over global filterType option.enum('checkbox', 'dropdown', 'multiselect', 'textField', 'custom') Use 'custom' if you are supplying your own rendering via filterOptions. |hint|string||Display hint icon with string as tooltip on hover. |print|boolean|true|Display column when printing. |searchable|boolean|true|Exclude/include column from search results. |setCellProps|function||Is called for each cell and allows to you return custom props for this cell based on its data. function(cellValue: string, rowIndex: number, columnIndex: number) => object Example |setCellHeaderProps|function||Is called for each header cell and allows you to return custom props for the header cell based on its data. function(columnMeta: object) => object Example |sort|boolean|true|Enable/disable sorting on column. |viewColumns|boolean|true|Allow user to toggle column visibility through 'View Column' list.

customHeadRender is called with these arguments:

function(columnMeta: {
  customHeadRender: func,
  display: enum('true', 'false', 'excluded'),
  filter: boolean,
  sort: boolean,
  download: boolean,
  empty: boolean,
  index: number,
  label: string,
  name: string,
  print: boolean,
  searchable: boolean,
  viewColumns: boolean
}, handleToggleColumn: function(columnIndex))

customBodyRender is called with these arguments:

function(value: any, tableMeta: {
  rowIndex: number,
  columnIndex: number,
  columnData: array, // Columns Options object
  rowData: array, // Full row data
  tableData: array, Full table data
  tableState: {
    announceText: null|string,
    page: number,
    rowsPerPage: number,
    filterList: array,
    selectedRows: {
      data: array,
      lookup: object,
    },
    searchText: null|string,
  },
}, updateValue: function)

Plug-ins

The table lends itself to plug-ins in many areas, especially in the customRender functions. Many use cases for these render functions are common, so a set of plug-ins are available that you can use.

Available Plug-ins:

|Name|Type|Default|Description |:--:|:-----|:--|:-----| |debounceSearchRender|function||Function that returns a function for the customSearchRender method. This plug-in allows you to create a debounced search. function(debounceWait) => function Example

Customize Styling

Using Material-UI theme overrides will allow you to customize styling to your liking. First, determine which component you would want to target and then lookup the override classname. Let's start with a simple example where we will change the background color of a body cell to be red:

import React from "react";
import MuiDt from "mui-dt";
import { createMuiTheme, MuiThemeProvider } from '@material-ui/core/styles';

class BodyCellExample extends React.Component {

  getMuiTheme = () => createMuiTheme({
    overrides: {
      MUIDataTableBodyCell: {
        root: {
          backgroundColor: "#FF0000"
        }
      }
    }
  })

  render() {

    return (
      <MuiThemeProvider theme={this.getMuiTheme()}>
        <MuiDt title={"ACME Employee list"} data={data} columns={columns} options={options} />
      </MuiThemeProvider>
    );

  }
}

Remote Data

If you are looking to work with remote data sets or handle pagination, filtering, and sorting on a remote server you can do that with the following options:

const options = {
  serverSide: true,
  onTableChange: (action, tableState) => {
    this.xhrRequest('my.api.com/tableData', result => {
      this.setState({ data: result });
    });
  }
};

To see an example Click Here

Localization

This package decided that the cost of bringing in another library to perform localizations would be too expensive. Instead the ability to override all text labels (which aren't many) is offered through the options property textLabels. The available strings:

const options = {
  ...
  textLabels: {
    body: {
      noMatch: "Sorry, no matching records found",
      toolTip: "Sort",
    },
    pagination: {
      next: "Next Page",
      previous: "Previous Page",
      rowsPerPage: "Rows per page:",
      displayRows: "of",
    },
    toolbar: {
      search: "Search",
      downloadCsv: "Download CSV",
      print: "Print",
      viewColumns: "View Columns",
      filterTable: "Filter Table",
    },
    filter: {
      all: "All",
      title: "FILTERS",
      reset: "RESET",
    },
    viewColumns: {
      title: "Show Columns",
      titleAria: "Show/Hide Table Columns",
    },
    selectedRows: {
      text: "row(s) selected",
      delete: "Delete",
      deleteAria: "Delete Selected Rows",
    },
  }
  ...
}

Breaking Changes with mui-datatables

This library started as a fork of mui-datatables. Below I list breaking changes with mui-datatables.

  • The table now retains internal state through re-renders. When you override a table option or column option you take control, but if you opt not to control an option the table will maintain the state and not reset it when the table re-renders.
  • The "resetFilters" event that occurs for the onTableChange function is now called "clearFilters".
  • The responsiveScrollMaxHeight responsiveScrollFullHeight classes on MUIDataTable have been removed.
  • customToolbarSelect renamed customSelectToolbar.
  • disableToolbarSelect renamed disableSelectToolbar.
  • onRowsSelect renamed onRowSelectionChange.
  • onRowsExpand renamed onRowExpansionChange.
  • onFilterChange now takes the column index instead of the column name.
  • responsive option is now "displayMode". "stacked" mode is not tied to smaller screens, instead "responsiveStacked" should be used for this behavior.
  • customHeadRender function signature changed.
  • sortDirection property removed from Column API. Sorting is now handled via a sortOrder property on the options object.

Contributing

Thanks for taking an interest in the library and the github community!

The following commands should get you started:

npm i
npm run dev

open http://localhost:5050/ in browser

After you make your changes locally, you can run the test suite with npm test.

License

The files included in this repository are licensed under the MIT license.

Thanks

Thank you to BrowserStack for providing the infrastructure that allows us to test in real browsers.