inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2026-09-09 18:03:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ADF-3551] Doc review updates (#3793)

Browse Source 
* [ADF-3551] Updated docs and JSDocs

* [ADF-3551] Updated docs and JSDocs

* [ADF-3551] Updated docs and JSDocs
This commit is contained in:
Andy Stark
2018-09-14 14:41:25 +01:00
committed by Eugenio Romano
parent a67263462c
commit 58d765a355
18 changed files with 104 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/core/sidenav-layout.component.md
+7 -7
View File
@@ -1,7 +1,7 @@
---
Added: v2.3.0
Status: Active
Last reviewed: 2018-06-08
Last reviewed: 2018-09-14
---
# Sidenav Layout component
@@ -69,17 +69,17 @@ sub-components (note the use of `<ng-template>` in the sub-components' body sect
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| expandedSidenav | `boolean` | true | Should the navigation region be expanded initially? |
| hideSidenav | `boolean` | false | Toggles showing/hiding the navigation region |
| sidenavMax | `number` | | Maximum size of the navigation region |
| sidenavMin | `number` | | Minimum size of the navigation region |
| stepOver | `number` | | Screen size at which display switches from small screen to large screen configuration |
| position | `string` | 'start' | The side that the drawer is attached to 'start' or 'end' page |
| hideSidenav | `boolean` | false | Toggles showing/hiding the navigation region. |
| position | `string` | "start" | The side that the drawer is attached to. Possible values are 'start' and 'end'. |
| sidenavMax | `number` | | Maximum size of the navigation region. |
| sidenavMin | `number` | | Minimum size of the navigation region. |
| stepOver | `number` | | Screen size at which display switches from small screen to large screen configuration. |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| expanded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when the menu toggle and the collapsed/expanded state of the sideNav changes |
| expanded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when the menu toggle and the collapsed/expanded state of the sideNav changes. |
## Details