core/header/header.service.ts
A service which defines header functions.
Properties |
Methods |
Accessors |
constructor(options: OptionsService, humanizeAppName: HumanizeAppNamePipe, drawerService: DrawerService)
|
||||||||||||
|
Parameters :
|
| changePageTitle | ||||||||
changePageTitle(newTitle?: string)
|
||||||||
|
Change the page title.
Parameters :
Returns :
void
|
| changeTitle | ||||||||||||
changeTitle(newTitle?, pageTitleUpdate)
|
||||||||||||
|
Change the application title.
Parameters :
Returns :
void
|
| closeNavigator |
closeNavigator()
|
|
Force to close the navigator.
Returns :
void
|
| closeRightDrawer |
closeRightDrawer()
|
|
Force to close the right drawer.
Returns :
void
|
| configNavigator | ||||||||||
configNavigator(config: Partial<>)
|
||||||||||
|
Configures navigation options.
Parameters :
Returns :
void
|
| shouldShowBreadcrumbs |
shouldShowBreadcrumbs()
|
|
Returns :
any
|
| toggle |
toggle()
|
|
Toggles the main header menu in mobile view.
Returns :
void
|
| toggleNavigator |
toggleNavigator()
|
|
Toggles the navigator open status.
Returns :
void
|
| toggleRightDrawer |
toggleRightDrawer()
|
|
Toggles the right drawer open status.
Returns :
void
|
| verifyIfNavOpen |
verifyIfNavOpen()
|
|
This methods checks if the navigator toggles on startup or if an item is added to the navigator node. Delay of 300ms is intended for animation purpose.
Returns :
void
|
| Protected emitNewState |
emitNewState()
|
|
Emits a new state.
Returns :
void
|
| map | ||||||||
map(mappedProperty: (undefined) => void)
|
||||||||
|
Maps to a property and just returns that property.
Parameters :
Returns :
Observable<any>
|
| canToggleNavigator$ |
Type : Observable<boolean>
|
| Readonly DELAY_TO_AVOID_FLICKERING_ON_ASYNC_NODES |
Type : number
|
Default value : 1000
|
| header$ |
Type : Observable<Header>
|
| headerOpen |
Default value : false
|
| hideHeader |
Default value : false
|
| navigatorOpen$ |
Type : Observable<boolean>
|
| rightDrawerOpen$ |
Type : Observable<boolean>
|
| state$ |
Type : BehaviorSubject<Header>
|
Default value : new BehaviorSubject<Header>({
title: undefined,
nav: {
open: false
},
rightDrawer: {
open: false
}
})
|
| title |
Type : literal type | undefined
|
| state |
getstate()
|
| navigatorHiddenOnStartup |
getnavigatorHiddenOnStartup()
|
| largeWidth |
getlargeWidth()
|
| shouldToggle |
getshouldToggle()
|