Skip to content

Commit 4760539

Browse files
committed
updating documentaion
1 parent 6cb6059 commit 4760539

File tree

2 files changed

+22
-14
lines changed

2 files changed

+22
-14
lines changed

projects/dxc-ngx-cdk-site/src/app/components/examples/layout/app-layout-api/app-layout-api.component.html

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -51,45 +51,51 @@
5151
<p>
5252
Everything in this component will be displayed as content inside a sidenav at
5353
the left. This is optional and if not specified, the sidenav will not be
54-
shown. Check
55-
<dxc-link
56-
text="DxcSidenav"
57-
href=""
58-
underlined="false"
59-
(click)="navigateToRoute('sidenav'); $event.preventDefault()"
60-
></dxc-link>
61-
for more information regarding its props. This also applies to the themming.
54+
shown.
6255
</p>
6356

6457
<dxc-heading
6558
[level]="5"
6659
weight="normal"
67-
text="Additional props"
60+
text="Props"
6861
[margin]="{ bottom: 'small' }"
6962
></dxc-heading>
7063

71-
<dxc-table [margin]="{bottom: 'medium'}">
64+
<dxc-table [margin]="{ bottom: 'medium' }">
7265
<tr>
7366
<th>Name</th>
7467
<th>Default</th>
7568
<th>Description</th>
7669
</tr>
7770
<tr>
78-
<td>mode: 'overlay' | 'push' </td>
71+
<td>mode: 'overlay' | 'push'</td>
7972
<td>
8073
<code>'push'</code>
8174
</td>
8275
<td>
83-
Default action over the content of the page, overlay the content or
84-
push to the right.
76+
Default action over the content of the page, overlay the content or push
77+
to the right. In lower resolutions the mode will always be overlay.
8578
</td>
8679
</tr>
8780
<tr>
8881
<td>displayArrow: boolean</td>
8982
<td>
9083
<code>true</code>
9184
</td>
92-
<td>If false, the arrow button is hidden.</td>
85+
<td>
86+
If false, the arrow button is hidden. In lower resolutions the arrow will
87+
be always displayed.
88+
</td>
89+
</tr>
90+
<tr>
91+
<td>padding: string | object</td>
92+
<td></td>
93+
<td>
94+
Size of the padding to be applied to the custom area ('xxsmall' | 'xsmall'
95+
| 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge'). You can pass an
96+
object with 'top', 'bottom', 'left' and 'right' properties in order to
97+
specify different padding sizes.
98+
</td>
9399
</tr>
94100
</dxc-table>
95101

projects/dxc-ngx-cdk/src/lib/dxc-application-layout/dxc-application-layout-sidenav/dxc-application-layout-sidenav.component.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ export class DxcApplicationLayoutSidenavComponent implements OnInit, OnChanges {
4444
@HostBinding("class") sidenavStyles;
4545
/**
4646
* Default action over the content of the page, overlay the content or push to the right ('push' | 'overlay').
47+
* In lower resolutions the mode will always be overlay.
4748
*/
4849
@Input() mode: Mode = "push";
4950
/**
@@ -53,6 +54,7 @@ export class DxcApplicationLayoutSidenavComponent implements OnInit, OnChanges {
5354
@Input() padding: Space | Padding;
5455
/**
5556
* If false, the arrow button is hidden.
57+
* In lower resolutions the arrow will be always displayed.
5658
*/
5759
@Input()
5860
get displayArrow(): boolean {

0 commit comments

Comments
 (0)