Skip to main content

Header

Render an application header with optional left section, right section, content and search button/bar

Storybook Docs

Props

NameTypeDefaultDescription
childrenReactNode-Main content of header
childrenComponentElementTypedivType of element for the children container
hasSearchbooleantrueDisplay the search button and search bar
withBorderbooleantrueDisplay a border on the Header
heightnumber90Height of Header
leftReactNode-Left section
rightReactNode-Right section
searchAriaLabelstring"Search"Aria label of search button
searchThemeMantineThemeOverride-Mantine theme of search bar
searchValuestring-Controlled value of search bar input
onSearchChange(value: string) => void-Called when value of search bar input changes
onSearchSubmit(event: FormEvent) => void-Called when search bar input is submitted
hasResponsiveModeboolean-Control the type of display to show
mobilePropsIHeaderMobileProps-Allows configuring the props of the child component HeaderMobile
...--extends Mantine's HeaderProps