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

* [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

View File

@@ -36,6 +36,7 @@ export class SidebarActionMenuComponent {
@Input()
expanded: boolean;
/** Width in pixels for sidebar action menu options. */
@Input()
width: number = 272;

View File

@@ -31,15 +31,25 @@ export class SidenavLayoutComponent implements OnInit, AfterViewInit, OnDestroy
static STEP_OVER = 600;
/** The side that the drawer is attached to 'start' | 'end' page */
/** The side that the drawer is attached to. Possible values are 'start' and 'end'. */
@Input() position = 'start';
/** Minimum size of the navigation region. */
@Input() sidenavMin: number;
/** Maximum size of the navigation region. */
@Input() sidenavMax: number;
/** Screen size at which display switches from small screen to large screen configuration. */
@Input() stepOver: number;
/** Toggles showing/hiding the navigation region. */
@Input() hideSidenav = false;
/** Should the navigation region be expanded initially? */
@Input() expandedSidenav = true;
/** Emitted when the menu toggle and the collapsed/expanded state of the sideNav changes. */
@Output() expanded = new EventEmitter<boolean>();
@ContentChild(SidenavLayoutHeaderDirective) headerDirective: SidenavLayoutHeaderDirective;