Skip to content

Commit d74a725

Browse files
committed
feat(sistent): add guidance section for table
Signed-off-by: Soham Babrekar <soham.babrekar@gmail.com>
1 parent 33e2ed4 commit d74a725

File tree

1 file changed

+59
-0
lines changed

1 file changed

+59
-0
lines changed
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
title: Table Guidance
3+
component: table
4+
description: Guidelines and best practices for using tables effectively.
5+
---
6+
7+
## Function
8+
9+
Tables are used to organize structured data into rows and columns. They help users quickly scan, compare, and understand information.
10+
11+
Tables are useful for:
12+
13+
- Presenting structured data
14+
- Comparing multiple values
15+
- Displaying logs and metrics
16+
- Listing users or resources
17+
18+
---
19+
20+
## Usage
21+
22+
Use tables when:
23+
24+
- Data must be compared
25+
- Information is structured
26+
- Users need quick scanning
27+
- Displaying rows and columns
28+
29+
Avoid using tables when:
30+
31+
- Content is mostly text
32+
- Layout is simple
33+
- Data does not require comparison
34+
35+
---
36+
37+
## Best Practices
38+
39+
Follow these best practices when using tables:
40+
41+
- Use clear headers
42+
- Avoid too many columns
43+
- Keep rows readable
44+
- Use pagination for large datasets
45+
- Maintain consistent spacing
46+
47+
### Use Clear Headers
48+
49+
Always include headers for better readability.
50+
51+
```html
52+
<table>
53+
<thead>
54+
<tr>
55+
<th>Name</th>
56+
<th>Role</th>
57+
</tr>
58+
</thead>
59+
</table>

0 commit comments

Comments
 (0)