Layout Components
CoreUI grid components.
Header
Full Description
# Header API
| Name | Required | Type | Default Value |
|---|---|---|---|
| tag | (Function | string) | header | |
| main HTML tag name | |||
| className | string | ||
| user classes for the main HTML tag | |||
| children | any | ||
| main tag content | |||
| innerRef | (object | Function | string) | ||
| ref to the main tag | |||
| fixed | boolean | true | |
| fixed type | |||
| withSubheader | boolean | ||
| for header with subheader | |||
| colorScheme | string | light | |
| header color | |||
Subheader
# Subheader API
| Name | Required | Type | Default Value |
|---|---|---|---|
| tag | any | div | |
| main HTML tag name | |||
| className | string | ||
| user classes for the main HTML tag | |||
| innerRef | (object | Function | string) | ||
| ref to the main tag | |||
Sidebar
Full Description
# Sidebar API
| Name | Required | Type | Default Value |
|---|---|---|---|
| children | any | ||
| children components | |||
| className | string | ||
| user classes for the main HTML tag | |||
| innerRef | (object | Function | string) | ||
| ref to the main tag | |||
| fixed | boolean | true | |
| set fixed type of sidebar | |||
| unfoldable | boolean | ||
| set unfoldable type of sidebar | |||
| overlaid | boolean | ||
| set overlaid type of sidebar | |||
| breakpoint | (false | | sm | md | lg | xl) | lg | |
| set sidebar breakpoint | |||
| minimize | boolean | ||
| show minimize verson of sidebar | |||
| show | (true | false | responsive) | responsive | |
| show/hide the sidebar | |||
| size | (sm | lg | xl) | ||
| set the size of sidebar | |||
| hideOnMobileClick | boolean | true | |
| determine the hide effect on mobile | |||
| aside | boolean | ||
| set the type to aside | |||
| colorScheme | string | dark | |
| color scheme | |||
| dropdownMode | (openActive | close | closeInactive | noAction) | ||
| set dropdown effect | |||
| onShowChange | Function | ||
| on show state change callback | |||
| onMinimizeChange | Function | ||
| on minimize change callback | |||
Footer
# Footer API
| Name | Required | Type | Default Value |
|---|---|---|---|
| tag | (Function | string) | footer | |
| main HTML tag name | |||
| children | any | ||
| children components | |||
| className | string | ||
| user classes for the main HTML tag | |||
| innerRef | (object | Function | string) | ||
| ref to the main tag | |||
| fixed | boolean | false | |
| set fixed type | |||