Skip to content

Commit

Permalink
Updated ItemHeaderView docs to show the proper library that is being …
Browse files Browse the repository at this point in the history
…used for the component
  • Loading branch information
wrigh393 committed Feb 8, 2021
1 parent ecc3105 commit 8623071
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions src/components/ItemHeaderView/ItemHeaderView.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
The ItemHeader displays item metadata for items of selected queues and allows for filtering by field and opening an item by clicking. Items are passed in as a required parameter. It is to be used with the [ItemTableAppBar](/#/Components/ItemTableAppBar).

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


const [itemData, setItemData] = useState([]);

const testItems = [{"queue": "ce", "number": 9, "lastUpdated": "09-11-20 12:14 PM", "isLocked": false, "userEmail": "lslusher@purdue.edu", "userName": "Slusher, Laura M", "userAlias": "lslusher", "assignedTo": "bekuma", "subject": "RE: New laptop", "status": "waiting on reply/time to call", "priority": "deploy", "department": "che", "building": "frny", "dateReceived": "2020-03-12T18:07:27+0000"}, {"queue": "ce", "number": 42, "lastUpdated": "09-11-20 12:14 PM", "isLocked": false, "userEmail": "feng293@purdue.edu", "userName": "", "userAlias": "feng293", "assignedTo": "schmid22", "subject": "Upgrade system and Abaqus", "status": "", "priority": "", "department": "", "building": "", "dateReceived": "2020-05-14T10:21:32-0400"}, {"queue": "ce", "number": 51, "lastUpdated": "09-11-20 12:14 PM", "isLocked": false, "userEmail": "jclauso@purdue.edu", "userName": "", "userAlias": "jclauso", "assignedTo": "schmid22", "subject": "ECN privileges for future grad student", "status": "Waiting for reply", "priority": "", "department": "", "building": "", "dateReceived": "2020-05-14T15:03:07-0400"}];


useEffect(() => {

setItemData(testItems)

}, []);

<ItemHeaderView data={itemData} />
```
```jsx static
<ItemHeaderView data={someArray} />
```

0 comments on commit 8623071

Please sign in to comment.