Skip to main content

HorizontalNav Props with types

PropsTypeDescriptionDefault
switchToVerticalbooleanSwitch menu orientation to vertical if set to truefalse
hideMenubooleanHide the menu when breakpoint size is reached on window resize.-
breakpointxs | sm | md | lg | xl | xxl | alwaysSet when the sidebar should trigger responsiveness behaviorlg
breakpointsPartial<typeof defaultBreakpoints>Set custom breakpoints when the sidebar should trigger responsiveness behavior-
customBreakpointstringSet custom breakpoint value, this will override breakpoint prop-
customStylesCSSObjectSet custom styling for the horizontal navigation-
verticalNavProps{ width?: number; backgroundColor?: string; backgroundImage?: string; customStyles?: CSSObject; }Change the look of the Vertical navigation when breakpoint is reached width: {260}
verticalNavContent{ ({ children }: ChildrenType) => JSX.Element }Change the content of the Vertical navigation when breakpoint is reached width: {260}

Here is the defaultBreakpoints props type:

defaultBreakpoints: Record<BreakpointType, string> = {
xs: '480px',
sm: '600px',
md: '900px',
lg: '1200px',
xl: '1536px',
xxl: '1920px',
always: 'always'
}