@stratio/egeo
Version:
60 lines (44 loc) • 1.96 kB
Markdown
The header component is a main component of an application. This component must be on top and scroll with page, when scroll is in a calculated position, the header shrinks and fix to top.
| Property | Type | Req | Description | Default |
| ----------------- | -------------------- | ----- | ----------------------------------------------------------------------------------------------- | ------- |
| menu | StHeaderMenuOption[] | False | Array with menu option to show | |
| navigateByDefault | Boolean | False | True if we want menu to manage navigation, false if navigation will be managed from the outside | |
| Property | Type | Description |
| ---------- | ----------------- | -------------------------------- |
| selectMenu | StHeaderSelection | Notify any menu option selection |
```html
<st-header [menu]="headerMenuSchema"
id="header">
<div class="st-header-logo">
<!-- Logo as svg, image, etc. -->
</div>
<div class="st-header-user-menu">
<!-- Right header menu, with user menu, notifications, etc -->
</div>
</st-header>
```
*Header menu options* (StHeaderMenuOption)
```typescript
export class StHeaderMenuOption {
icon ? : string; // Icon to show on left of menu label
label: string; // Menu label to show
subMenus: StHeaderSubMenuOption[]; // List of submenu options
link: string;
external ? : boolean;
openInNewPage ? : boolean;
}
```
*Submenu options* (StHeaderSubMenuOption)
```typescript
export class StHeaderSubMenuOption {
label: string; // Label to show
link: string;
external ? : boolean;
openInNewPage ? : boolean;
}
```