inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-31 17:38:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ADF-3425] Minor edits to doc files (#3667)

Browse Source
This commit is contained in:
Andy Stark
2018-08-07 17:36:15 +01:00
committed by Eugenio Romano
parent 18a21a59a5
commit cb7a6b0a7a
4 changed files with 39 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
docs/core/header.component.md
View File

@@ -1,9 +1,10 @@
---
Added: v2.4.0
Status: Experimental
Last reviewed: 2018-08-07
---
## Header component
# Header component
Reusable header for Alfresco applications
@@ -25,21 +26,25 @@ Reusable header for Alfresco applications
## Class members
### Properties
| Name | Type | Description |
| -- | -- | -- |
| title | string | Title of the application
| logo | string | Path to an image file for the application logo.
| redirectUrl | string\|any[] | The router link for the application logo.
| tooltip | string | The tooltip text for the application logo.
| color | string | Background color for the header. It can be any hex color code or the Material theme colors: 'primary', 'accent' or 'warn'.
| showSidenavToggle | boolean | Signals if the sidenav button will be displayed in the header or not. By default is true.
| title | `string` | Title of the application
| logo | `string` | Path to an image file for the application logo.
| redirectUrl | `string` \| `any[]` | The router link for the application logo.
| tooltip | `string` | The tooltip text for the application logo.
| color | `string` | Background color for the header. It can be any hex color code or the Material theme colors: 'primary', 'accent' or 'warn'.
| showSidenavToggle | `boolean` | Signals if the sidenav button will be displayed in the header or not. By default is true.
### Events
| Name | Type | Description |
| -- | -- | -- |
| clicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when click on sidenav button
## Details
This component displays a customizable header which can be reused. The left side of the header (title, button) and the primary color for the header can be configured via input parameters.
The right part of the header are existing components which are transcluded in the header component.
This component displays a customizable header that can be reused. Use the input properties to
configure the left side (title, button) and the primary color of the header.
The right part of the header can contain other components which are transcluded in the header component.