Add docs

ECN · Jan 21, 2021 · 246e4d9 · 246e4d9
1 parent 9df197e
commit 246e4d9
Showing 1 changed file with 36 additions and 0 deletions.
diff --git a/src/components/LastUpdatedCell/LastUpdatedCell.md b/src/components/LastUpdatedCell/LastUpdatedCell.md
@@ -0,0 +1,36 @@
+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.
+
+## Default Usage
+```jsx
+import { Paper } from '@material-ui/core';
+import LastUpdatedCell from "./LastUpdatedCell";
+
+let today = new Date();
+let threeDaysAgo = new Date().setDate(today.getDate() - 3);
+let lastWeek = new Date().setDate(today.getDate() - 8);
+let lastMonth = new Date().setDate(today.getDate() - 28);
+
+<Paper>
+	{ /* Today */ }
+	<LastUpdatedCell time={today} />
+	{ /* Three Days Ago */ }
+	<LastUpdatedCell time={threeDaysAgo} />
+	{ /* Last Week */ }
+	<LastUpdatedCell time={lastWeek} />
+	{ /* Last Month */ }
+	<LastUpdatedCell time={lastMonth} />
+</Paper>
+```
+
+```jsx static
+<Paper>
+	{ /* Today */ }
+	<LastUpdatedCell time={today} />
+	{ /* Three Days Ago */ }
+	<LastUpdatedCell time={threeDaysAgo} />
+	{ /* Last Week */ }
+	<LastUpdatedCell time={lastWeek} />
+	{ /* Last Month */ }
+	<LastUpdatedCell time={lastMonth} />
+</Paper>
+```