Skip to content

Commit 0c1ad29

Browse files
authored
docs(design): update container component documentation (#2894)
1 parent eaef7de commit 0c1ad29

File tree

2 files changed

+26
-19
lines changed

2 files changed

+26
-19
lines changed

apps/design-land/src/app/container/container.component.html

+15-11
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,47 @@
11
<h1>Container</h1>
2-
<p>Container is a basic structural element that can be used to restrict content to a specific width. Containers are not responsible for providing padding or margin.</p>
2+
<p>Container is a basic structural element that restricts page content to a specific maximum width.</p>
3+
4+
<h2>Overview</h2>
5+
Container comes with pre-defined sizes that work well with common breakpoints. It's not responsible for providing padding or margin.
36

47
<h2>Size</h2>
58
<p>The size of a container can be defined by using the <code>size</code> property. There is no default size set.</p>
9+
610
<p>Supported sizes: <code>xs | sm | md | lg | xl</code></p>
711

812
<table>
913
<thead>
1014
<tr>
11-
<th>Size</th>
12-
<th>Syntax</th>
13-
<th>Max width</th>
15+
<th>Description</th>
16+
<th>Max Width</th>
17+
<th>Value</th>
1418
</tr>
1519
</thead>
1620
<tbody>
1721
<tr>
18-
<td>Extra small</td>
19-
<td>xs</td>
22+
<td>Extra Small</td>
2023
<td>640px</td>
24+
<td>xs</td>
2125
</tr>
2226
<tr>
2327
<td>Small</td>
24-
<td>sm</td>
2528
<td>800px</td>
29+
<td>sm</td>
2630
</tr>
2731
<tr>
2832
<td>Medium</td>
29-
<td>md</td>
3033
<td>1040px</td>
34+
<td>md</td>
3135
</tr>
3236
<tr>
3337
<td>Large</td>
34-
<td>lg</td>
3538
<td>1340px</td>
39+
<td>lg</td>
3640
</tr>
3741
<tr>
38-
<td>Extra large</td>
39-
<td>xl</td>
42+
<td>Extra Large</td>
4043
<td>1920px</td>
44+
<td>xl</td>
4145
</tr>
4246
</tbody>
4347
</table>

libs/design/container/README.md

+11-8
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,21 @@
11
# Container
2-
Container is a basic structural element that can be used to restrict content to a specific width. Containers are not responsible for providing padding or margin.
2+
Container is a basic structural element that restricts page content to a specific maximum width.
3+
4+
## Overview
5+
Container comes with pre-defined sizes that work well with common breakpoints. It's not responsible for providing padding or margin.
36

47
## Size
58
The size of a container can be defined by using the `size` property. There is no default size set.
69

710
Supported sizes: `xs | sm | md | lg | xl`
811

9-
| Size | Syntax | Max wdith |
10-
| ----------- | ------ | --------- |
11-
| Extra small | xs | 640px |
12-
| Small | sm | 800px |
13-
| Medium | md | 1040px |
14-
| Large | lg | 1340px |
15-
| Extra large | xl | 1920px |
12+
| Description | Max Width | Value |
13+
| ----------- | --------- | ------ |
14+
| Extra Small | 640px | xs |
15+
| Small | 800px | sm |
16+
| Medium | 1040px | md |
17+
| Large | 1340px | lg |
18+
| Extra Large | 1920px | xl |
1619

1720
## Usage
1821
<design-land-example-viewer-container example="container-sizes"></design-land-example-viewer-container>

0 commit comments

Comments
 (0)