https://github.com/uptick/react-object-list

Neat table/list views with filtering and pagination support; powered by React.
https://github.com/uptick/react-object-list

react

Last synced: 11 months ago
JSON representation

Neat table/list views with filtering and pagination support; powered by React.

• Host: GitHub
• URL: https://github.com/uptick/react-object-list
• Owner: uptick
• License: mit
• Created: 2018-03-08T07:09:18.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-01-25T07:49:07.000Z (over 3 years ago)
• Last Synced: 2024-11-09T02:50:07.307Z (over 1 year ago)
• Topics: react
• Language: JavaScript
• Homepage:
• Size: 4.01 MB
• Stars: 13
• Watchers: 10
• Forks: 4
• Open Issues: 47
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# react-object-list

[![npm version](https://badge.fury.io/js/react-object-list.svg)](http://badge.fury.io/js/react-object-list)

![Downloads](http://img.shields.io/npm/dm/react-object-list.svg?style=flat)

[![Build Status](https://travis-ci.org/uptick/react-object-list.svg?branch=master)](https://travis-ci.org/uptick/react-object-list)

[![codecov](https://codecov.io/gh/uptick/react-object-list/branch/master/graph/badge.svg)](https://codecov.io/gh/uptick/react-object-list)

Component used to display an array of object based data in a sortable, filterable, paginated, list based view, powered by React.

Custom components can be passed in if they are designed to handle the same props as the default components. This functionality is available for the DataRenderer, Pagination and ErrorMessage and your component can simply be passed in through the props with one of the above keys.

## Live Demo

Check out the live demo here: http://uptick.github.io/react-object-list/

## Installation

Install the package:

```

yarn add react-object-list

```

Ensure you have all peer dependencies installed

```

yarn add classnames moment prop-types react-month-picker react-select

```

Include icons from FontAwesome 4:

```javascript

import React from 'react'

import ReactDOM from 'react-dom'

import ObjectList from 'react-object-list'

import {FontAwesome} from 'react-object-list/icons'

var mount = document.querySelectorAll('div.browser-mount');

ReactDOM.render(

  ,

  mount[0]

);

```

or your own icons by specifying as so:

```javascript

  ,

      Favourites: ,

      RemoveFavourite: ,

      RemoveFilter: ,

      DropdownOpen: ,

      DropdownClose: ,

      SortAsc: ,

      SortDesc: ,

      Unsorted: ,

      Loading: ,

      CheckboxChecked: ,

      CheckboxUnchecked: ,

    }}

  />

```

Unspecified icons will not show (excl. RemoveFavourite, SortAsc, SortDesc, CheckboxChecked, CheckboxUnchecked, RemoveFilter).