Skip to content

Commit f5dcd3e

Browse files
committed
docs: app-header component props
1 parent 839f1f4 commit f5dcd3e

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
#### CoreUI v2 `app-header` angular component
2+
3+
prop | type | default | example
4+
--- | --- | --- | ---
5+
fixed | boolean | `false` |
6+
navbarBrand | any | |
7+
navbarBrandFull | any | | `{src: 'assets/img/brand/logo.svg', width: 89, height: 25, alt: 'CoreUI Logo'}`
8+
navbarBrandMinimized | any | | `{src: 'assets/img/brand/sygnet.svg', width: 30, height: 30, alt: 'CoreUI Logo'}`
9+
navbarBrandText | any | `{icon: '🅲', text: '🅲 CoreUI'}` |
10+
navbarBrandRouterLink | any[], string | | `['/dashboard']`
11+
sidebarToggler | string, boolean | | `'lg'`
12+
mobileSidebarToggler | boolean |
13+
asideMenuToggler | string, boolean | | `'lg'`
14+
mobileAsideMenuToggler | boolean |
15+
16+
notes:
17+
- `[fixed] = "true"` : set `header-fixed` class
18+
- `[sidebarToggler] = "'lg'"` : toggler breakpoint for desktop/mobile view
19+
- `[sidebarToggler] = "false"` : remove toggler
20+
- `[mobileSidebarToggler] = "false"` : remove mobile toggler
21+
- `[asideMenuToggler] = "false"` : remove toggler
22+
- `[mobileAsideMenuToggler | boolean |] = "false"` : remove mobile toggler
23+
24+
to shift default ( lg, md ) desktop/mobile breakpoint in your template:
25+
1. override `_variables.scss`
26+
```scss
27+
// Variable overrides
28+
$breakpoint-mobile-up: md;
29+
$breakpoint-mobile-down: sm;
30+
```
31+
32+
2. set complementary changes to `default-layout.component.html`
33+
- `<app-header [sidebarToggler]="'md'" ... >`
34+
- `<app-sidebar [display]="'md'" ... >`

0 commit comments

Comments
 (0)