Skip to content

Commit

Permalink
docs: adjust table README to the new template structure (#986)
Browse files Browse the repository at this point in the history
  • Loading branch information
burakukula committed Jun 1, 2021
1 parent 0e72180 commit 16bdcc8
Showing 1 changed file with 18 additions and 8 deletions.
26 changes: 18 additions & 8 deletions packages/forma-36-react-components/src/components/Table/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,20 @@ storybook: 'https://f36-storybook.contentful.com/?path=/info/components-table--d

Use tables to present large amounts of data, and data which has multiple properties attached to it.

## Table of contents

- [How to use Table](#how-to-use-table)
- [Code examples](#code-examples)
- [Content recommendations](#content-recommendations)

## How to use Table

- Make sure Tables span the full width of the container they're in
- Make sure a table has a header describing the content of its respective columns
- Ordered columns by relevance from left to right. Images, if present, have a higher priority, and should be placed in the first column. Checkboxes naturally have the highest priority.

## Code examples

```jsx
<Table>
<TableHead>
Expand Down Expand Up @@ -42,12 +56,8 @@ Use tables to present large amounts of data, and data which has multiple propert
</Table>
```

## Table of contents

1. [Best practices](#best-practices)

## Best practices <a name="best-practices" />
## Content recommendations

- Make sure Tables span the full width of the container they're in
- Make sure a table has a header describing the content of its respective columns
- Ordered columns by relevance from left to right. Images, if present, have a higher priority, and should be placed in the first column. Checkboxes naturally have the highest priority.
- Keep headers short
- Headers should be informative and descriptive
- Content in the table should be concise and scannable

0 comments on commit 16bdcc8

Please sign in to comment.