alfresco-ng2-components/docs/core/header.component.md
Georgiana Roman c4d3bf231a [ADF-3177] added general header component (#3537)
* [ADF-3177] added general header component

* [ADF-3177] added documentation and removed user info mobile behaviour

* [ADF-3177] eddited doc file

* [ADF-3177] renamed folder and style changes

* [ADF-3177] style changes

* [ADF-3177] fix tests

* [ADF-3177] fix lint errors and tests

* [APM-3177] css changes

* [ADF-3177] fix pr

* [ADF-3177] updated documentation

* [ADF-3177] expose module with old name

* [ADF-3177] expose module with old name
2018-08-14 15:42:07 +01:00

1.2 KiB

Added, Status
Added Status
v2.4.0 Experimental

Header component

Reuseble header for Alfresco applications

Basic usage

<adf-layout-header 
    title="title" 
    logo="logo.png" 
    color="primary"
    (toggled)=toggleMenu($event)>

    <app-search-bar fxFlex="0 1 auto"></app-search-bar>
    <app-theme-picker></app-theme-picker>
<adf-layout>

Class members

Properties

Name Type Description
title string Title of the application
logo string Path to an image file for the application logo.
color string Primary color for the header
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<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.