Skip to content

Commit

Permalink
Update ItemTable docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Justin Campbell committed Aug 19, 2020
1 parent a6c8b4e commit 99c8345
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion src/components/ItemTable/ItemTable.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
The ItemTable is a modified version of [material-table](https://material-table.com/) the primary view for webqueue2. It displays metadata for items of selected queues and allows for filtering. By default, it is pre-configured to fetch data the webqueue2 API.
The ItemTable is the primary view for webqueue2. It displays item metadata for items of selected queues and allows for filtering by field and opening an item by clicking. By default, it is pre-configured to fetch data from the webqueue2 API.

It is based on [material-table](https://material-table.com/).
```jsx
import React, { useState } from "react";

const [activeItem, setActiveItem] = useState({});
const [sidebarOpen, setSidebarOpen] = useState({});

<ItemTable setActiveItem={activeItem} setSidebarOpen={setSidebarOpen} />
```

```jsx static
<ItemTable setActiveItem={{}} setSidebarOpen={{}} />
```

0 comments on commit 99c8345

Please sign in to comment.