README.md

@patternfly/react-table

This package provides Table PatternFly components based on PatternFly 4

Prerequisite

Node Environment

This project currently supports Node Active LTS releases. Please stay current with Node Active LTS when developing patternfly-react.

For example, to develop with Node 8, use the following:

nvm install 8
nvm use 8

This project also requires a Yarn version of >=1.6.0. The latest version can be installed here.

Installing

yarn add @patternfly/react-table

or

npm install @patternfly/react-table --save

Usage

It's strongly advised to use the PatternFly Base CSS in your whole project, or some components may diverge in appearance:

import '@patternfly/react-core/dist/styles/base.css';

Example Component Usage

import { Table, TableHeader, TableBody } from '@patternfly/react-table';

class SimpleTable extends React.Component {
  constructor(props) {
    super(props);
    this.state = {
      columns: [
        { title: 'Repositories', props: null },
        'Branches',
        { title: 'Pull requests', props: null },
        'Workspaces',
        'Last Commit'
      ],
      rows: [['one', 'two', 'three', 'four', 'five']]
    };
  }
  render() {
    const { columns, rows } = this.state;
    return (
      <Table caption="Simple Table" rows={rows} cells={columns}>
        <TableHeader />
        <TableBody />
      </Table>
    );
  }
}
export default SimpleTable;

Contribution

This library makes use of the babel plugin from @patternfly/react-styles to enable providing the CSS alongside the components. This removes the need for consumers to use (style|css|sass)-loaders. For an example of using CSS from core you can reference Button.js. For any CSS not provided by core please use the StyleSheet.create utility from @patternfly/react-styles. This will prevent collisions with any consumers, and allow the CSS to be bundled with the component.

Custom transformators

If you want to add custom transformators to show some special column (collapsible, checkbox) you have to include isVisible there as well so cellRenderer knows which cells to render (main purpose is for colSpan).

Example of such transformator can be:

function someTransform(value) {
  return {
    isVisible: true,
    children: <div>cell</div>
  }
}

If you want to add this transformer as default cell (first, last, any,...) for each row you also want to change function calculateColumnsin HeaderUtils.js.

Notice: Any data provided as cell will be visible by default, no need to add isVisible if you want to change how data are displayed.

Documentation

This project uses Gatsby. For an overview of the project structure please refer to the Gatsby documentation - Building with Components.

A comprehensive list of components and detailed usage of each can be found on the PatternFly React Docs website You can also find how each component is meant to be used from a design perspective on the PatternFly 4 Core website.

Note: All commands below assume you are on the root directory in this repository.

Install

Run to install all the dependencies

yarn && yarn bootstrap && yarn build && yarn build:docs

Building

yarn bootstrap && yarn build && yarn build:docs

Running

To start the site locally.

yarn build && yarn start:pf4

Building

To build the site.

yarn build:docs

Building

yarn build

Testing

Testing is done at the root of this repo. To only run the @patternfly/react-table tests:

yarn test packages/react-table