@engie-group/fluid-design-system
Version:
The Fluid Design System is ENGIE’s open-source library to create, build and deliver ENGIE digital services in a more efficient way.
31 lines (30 loc) • 1.34 kB
TypeScript
export declare const HEADER_LAYOUTS: readonly ["expanded", "responsive", "retracted"];
export type HeaderLayout = (typeof HEADER_LAYOUTS)[number];
export declare const HEADER_LOGO_POSITIONS: readonly ["left", "center"];
export type HeaderLogoPosition = (typeof HEADER_LOGO_POSITIONS)[number];
export type HeaderProperties = {
/**
* The layout of the header, which can be `expanded`, `responsive` or `retracted`.
* - `expanded`: The header is fully expanded.
* - `responsive`: The header is in a responsive state.
* - `retracted`: The header is in a compact state.
*
* @default 'expanded'
**/
layout?: HeaderLayout;
/**
* The position of the logo in the header.
* - 'left': The logo is positioned on the left side.
* - 'center': The logo is centered in the header.
*
* <strong>Caution: </strong>This property only affects the component when the layout is 'responsive'.
**/
logoPosition?: HeaderLogoPosition;
/**
* Whether the header has a burger menu or not.
* This is typically used to indicate if there is a burger menu button that can be clicked to emit a `nj-header-burger-clicked` event.
*
* <strong>Caution: </strong>This property only affects the component when the layout is 'responsive'.
**/
hasBurgerMenu?: boolean;
};