Skip to main content

ISidebarBaseProps

Admin Docs


Interface: ISidebarBaseProps

Defined in: src/types/SidebarBase/interface.ts:4

Interface for SidebarBase component props.

Properties​

backgroundColor?​

optional backgroundColor: string

Defined in: src/types/SidebarBase/interface.ts:18

(Optional) Background color override


children​

children: ReactNode

Defined in: src/types/SidebarBase/interface.ts:12

Navigation items and other content


footerContent?​

optional footerContent: ReactNode

Defined in: src/types/SidebarBase/interface.ts:16

(Optional) Footer content


headerContent?​

optional headerContent: ReactNode

Defined in: src/types/SidebarBase/interface.ts:14

(Optional) Content after branding (e.g., org section)


hideDrawer​

hideDrawer: boolean

Defined in: src/types/SidebarBase/interface.ts:6

State indicating whether the sidebar is hidden


persistToggleState?​

optional persistToggleState: boolean

Defined in: src/types/SidebarBase/interface.ts:20

(Optional) Whether to persist toggle state to localStorage


portalType​

portalType: "user" | "admin"

Defined in: src/types/SidebarBase/interface.ts:10

Type of portal (admin or user)


setHideDrawer​

setHideDrawer: Dispatch<SetStateAction<boolean>>

Defined in: src/types/SidebarBase/interface.ts:8

Function to toggle sidebar visibility