Skip to content

Commit

Permalink
Update docs to show what values the time prop can be
Browse files Browse the repository at this point in the history
  • Loading branch information
campb303 committed Jan 21, 2021
1 parent 246e4d9 commit 1ed9daa
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
2 changes: 1 addition & 1 deletion src/components/LastUpdatedCell/LastUpdatedCell.js
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ export default function LastUpdatedCell({ time, ItemTableCellProps }) {
};

LastUpdatedCell.propTypes = {
/** ISO 8601 formatted time string. */
/** ISO 8601 formatted time string, Date object or UNIX time. See: https://www.npmjs.com/package/react-relative-time */
"time": PropTypes.string.isRequired,
/** Props to be applied to the ItemTableCell. */
"ItemTableCellProps": PropTypes.object,
Expand Down
4 changes: 3 additions & 1 deletion src/components/LastUpdatedCell/LastUpdatedCell.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
The LastUpdatedCell wraps an [ItemTableCell](/#/Components/ItemTableCell) and changes its background color based on the time passed to it to indicate how old an item is.
A table cell that takes a time value and returns a relative time with a background color to indicate how old an item is.

The LastUpdatedCell wraps an [ItemTableCell](/#/Components/ItemTableCell)

## Default Usage
```jsx
Expand Down

0 comments on commit 1ed9daa

Please sign in to comment.