mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-10-22 15:11:57 +00:00

Files

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

2018-08-14 15:42:47 +01:00

1.5 KiB

Raw Blame History

Added, Status, Last reviewed

Added	Status	Last reviewed
v2.4.0	Experimental	2018-08-07

Header component

Reusable header for Alfresco applications

Basic usage

<adf-layout-header 
    title="title" 
    logo="logo.png" 
    [redirectUrl]="'/home'"
    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.
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<boolean>`	Emitted when click on sidenav button

Details

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.

1.5 KiB Raw Blame History