mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-3745] Updates for doc review (20-11-2018) (#3992)
This commit is contained in:
committed by
Eugenio Romano
parent
383b74151a
commit
0a394869f5
@@ -24,15 +24,34 @@ import { Component, Input, Output, EventEmitter, ViewEncapsulation, OnInit } fro
|
||||
host: { class: 'adf-layout-header' }
|
||||
})
|
||||
export class HeaderLayoutComponent implements OnInit {
|
||||
/** Title of the application. */
|
||||
@Input() title: string;
|
||||
|
||||
/** Path to an image file for the application logo. */
|
||||
@Input() logo: string;
|
||||
|
||||
/** The router link for the application logo, when clicked. */
|
||||
@Input() redirectUrl: string | any[] = '/';
|
||||
|
||||
/** The tooltip text for the application logo. */
|
||||
@Input() tooltip: string;
|
||||
|
||||
/**
|
||||
* Background color for the header. It can be any hex color code or one
|
||||
* of the Material theme colors: 'primary', 'accent' or 'warn'.
|
||||
*/
|
||||
@Input() color: string;
|
||||
|
||||
/**
|
||||
* Toggles whether the sidenav button will be displayed in the header
|
||||
* or not.
|
||||
*/
|
||||
@Input() showSidenavToggle: boolean = true;
|
||||
|
||||
/** Emitted when the sidenav button is clicked. */
|
||||
@Output() clicked = new EventEmitter<any>();
|
||||
|
||||
/** The side that the drawer is attached to 'start' | 'end' page */
|
||||
/** The side of the page that the drawer is attached to (can be 'start' or 'end') */
|
||||
@Input() position = 'start';
|
||||
|
||||
toggleMenu() {
|
||||
|
@@ -32,7 +32,7 @@ export abstract class DynamicComponentMapper {
|
||||
protected types: { [key: string]: DynamicComponentResolveFunction } = {};
|
||||
|
||||
/**
|
||||
* Gets the currently active ComponentTypeResolver function for a field type.
|
||||
* Gets the currently active DynamicComponentResolveFunction for a field type.
|
||||
* @param type The type whose resolver you want
|
||||
* @param defaultValue Default type returned for types that are not yet mapped
|
||||
* @returns Resolver function
|
||||
@@ -45,7 +45,7 @@ export abstract class DynamicComponentMapper {
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets or optionally replaces a ComponentTypeResolver function for a field type.
|
||||
* Sets or optionally replaces a DynamicComponentResolveFunction for a field type.
|
||||
* @param type The type whose resolver you want to set
|
||||
* @param resolver The new resolver function
|
||||
* @param override The new resolver will only replace an existing one if this parameter is true
|
||||
|
Reference in New Issue
Block a user