@manta-eu/react/sidebar

Type Aliases

CompanyItem

CompanyItem = object

Properties

active

active: boolean

badge?

optional badge?: string

disabled?

optional disabled?: boolean

disabledReason?

optional disabledReason?: string

id

id: string

logoUrl?

optional logoUrl?: string

name

name: string

---

CompanyLike

CompanyLike = object

Properties

branding?

optional branding?: { iconLogo?: { secureUrl?: string | null; } | null; } | null

id

id: string

name

name: string

---

CompanyPickerProps

CompanyPickerProps = object

Properties

companies

companies: CompanyItem[]

emptyMessage?

optional emptyMessage?: string

isLoading?

optional isLoading?: boolean

isSwitching?

optional isSwitching?: boolean

onCompanySelected

onCompanySelected: (companyId) => void

Parameters

companyId

string

Returns

void

onCreateCompany?

optional onCreateCompany?: () => void

Returns

void

onSearchTermChange?

optional onSearchTermChange?: (value) => void

Parameters

value

string

Returns

void

searchAutoFocus?

optional searchAutoFocus?: boolean

searchPlaceholder?

optional searchPlaceholder?: string

searchTerm?

optional searchTerm?: string

---

InitialsArgs

InitialsArgs = object

Properties

className?

optional className?: string

name

name: string

---

NavItem

NavItem = NavLeafItem | NavSubmenuItem

---

NavItemBase

NavItemBase = object

Properties

badge?

optional badge?: ReactNode

badgeLabel?

optional badgeLabel?: string

disabled?

optional disabled?: boolean

icon

icon: ComponentType<{ className?: string; height?: number; width?: number; }>

id?

optional id?: string

isActive?

optional isActive?: boolean

shortcut?

optional shortcut?: ReactNode

title

title: string

tooltip?

optional tooltip?: string

---

NavLeafItem

NavLeafItem = NavItemBase & object

Type Declaration

href?

optional href?: string

items?

optional items?: never

onClick?

optional onClick?: () => void

Returns

void

---

NavMenuArgs

NavMenuArgs = object

Properties

className?

optional className?: string

items

items: NavItem[]

linkComponent?

optional linkComponent?: NavMenuLinkComponent

submenuVariant?

optional submenuVariant?: NavMenuSubmenuVariant

---

NavMenuLinkComponent

NavMenuLinkComponent = ComponentType<NavMenuLinkProps>

---

NavMenuLinkProps

NavMenuLinkProps = ComponentPropsWithoutRef<"a"> & object

Type Declaration

href

href: string

---

NavMenuSubmenuVariant

NavMenuSubmenuVariant = "list" | "dropdown"

---

NavSubItem

NavSubItem = object

Properties

href?

optional href?: string

isActive?

optional isActive?: boolean

onClick?

optional onClick?: () => void

Returns

void

shortcut?

optional shortcut?: ReactNode

title

title: string

---

NavSubmenuItem

NavSubmenuItem = NavItemBase & object

Type Declaration

href?

optional href?: never

items

items: NavSubItem[]

onClick?

optional onClick?: never

---

NavUserArgs

NavUserArgs = object

Properties

accountExtraSlot?

optional accountExtraSlot?: ReactNode

children?

optional children?: ReactNode

className?

optional className?: string

currentDatastore

currentDatastore: object

name

name: string

name

name: string

onCloseAutoFocus?

optional onCloseAutoFocus?: (event) => void

Parameters

event

Event

Returns

void

onLogout

onLogout: () => void

Returns

void

onNavigateToAccount

onNavigateToAccount: () => void

Returns

void

pickerSlot?

optional pickerSlot?: ReactNode

picture?

optional picture?: string | null

topSlot?

optional topSlot?: ReactNode

---

SidebarContextProps

SidebarContextProps = object

Properties

isMobile

isMobile: boolean

open

open: boolean

openMobile

openMobile: boolean

setOpen

setOpen: (_open) => void

Parameters

_open

boolean

Returns

void

setOpenMobile

setOpenMobile: (_open) => void

Parameters

_open

boolean

Returns

void

state

state: "expanded" | "collapsed"

toggleSidebar

toggleSidebar: () => void

Returns

void

---

SidebarTriggerProps

SidebarTriggerProps = Omit<IconOnlyButtonProps, "icon" | "iconOnly" | "aria-label"> & object

Type Declaration

aria-label?

optional aria-label?: string

---

UserAvatarArgs

UserAvatarArgs = object

Properties

className?

optional className?: string

name

name: string

picture?

optional picture?: string | null

Variables

sidebarStorageKey

const sidebarStorageKey: "sidebar_state" = "sidebar_state"

Functions

CompanyPicker()

CompanyPicker(props): Element

Parameters

props

CompanyPickerProps

Returns

Element

---

Initials()

Initials(args): Element

Parameters

args

InitialsArgs

Returns

Element

---

NavMenu()

NavMenu(props): Element

Parameters

props

NavMenuArgs

Returns

Element

---

NavUser()

NavUser(args): Element

Parameters

args

NavUserArgs

Returns

Element

---

Sidebar()

Sidebar(__namedParameters): Element

Parameters

__namedParameters

ClassAttributes<HTMLDivElement> & HTMLAttributes<HTMLDivElement> & object

Returns

Element

---

SidebarContent()

SidebarContent(__namedParameters): Element

Parameters

__namedParameters

DetailedHTMLProps<HTMLAttributes<HTMLDivElement>>

Returns

Element

---

SidebarFooter()

SidebarFooter(__namedParameters): Element

Parameters

__namedParameters

DetailedHTMLProps<HTMLAttributes<HTMLDivElement>>

Returns

Element

---

SidebarGroup()

SidebarGroup(__namedParameters): Element

Parameters

__namedParameters

DetailedHTMLProps<HTMLAttributes<HTMLDivElement>>

Returns

Element

---

SidebarGroupAction()

SidebarGroupAction(__namedParameters): Element

Parameters

__namedParameters

ClassAttributes<HTMLButtonElement> & ButtonHTMLAttributes<HTMLButtonElement> & object

Returns

Element

---

SidebarGroupContent()

SidebarGroupContent(__namedParameters): Element

Parameters

__namedParameters

DetailedHTMLProps<HTMLAttributes<HTMLDivElement>>

Returns

Element

---

SidebarGroupLabel()

SidebarGroupLabel(__namedParameters): Element

Parameters

__namedParameters

ClassAttributes<HTMLDivElement> & HTMLAttributes<HTMLDivElement> & object

Returns

Element

---

SidebarHeader()

SidebarHeader(__namedParameters): Element

Parameters

__namedParameters

DetailedHTMLProps<HTMLAttributes<HTMLDivElement>>

Returns

Element

---

SidebarInput()

SidebarInput(__namedParameters): Element

Parameters

__namedParameters

Omit<InputArgs, "ref"> & RefAttributes<HTMLInputElement>

Returns

Element

---

SidebarInset()

SidebarInset(__namedParameters): Element

Parameters

__namedParameters

DetailedHTMLProps<HTMLAttributes<HTMLDivElement>>

Returns

Element

---

SidebarMenu()

SidebarMenu(__namedParameters): Element

Parameters

__namedParameters

DetailedHTMLProps<HTMLAttributes<HTMLUListElement>>

Returns

Element

---

SidebarMenuAction()

SidebarMenuAction(__namedParameters): Element

Parameters

__namedParameters

ClassAttributes<HTMLButtonElement> & ButtonHTMLAttributes<HTMLButtonElement> & object

Returns

Element

---

SidebarMenuBadge()

SidebarMenuBadge(__namedParameters): Element

Parameters

__namedParameters

DetailedHTMLProps<HTMLAttributes<HTMLDivElement>>

Returns

Element

---

SidebarMenuButton()

SidebarMenuButton(__namedParameters): Element

Parameters

__namedParameters

ClassAttributes<HTMLButtonElement> & ButtonHTMLAttributes<HTMLButtonElement> & object

Returns

Element

---

SidebarMenuItem()

SidebarMenuItem(__namedParameters): Element

Parameters

__namedParameters

DetailedHTMLProps<LiHTMLAttributes<HTMLLIElement>>

Returns

Element

---

SidebarMenuSkeleton()

SidebarMenuSkeleton(__namedParameters): Element

Parameters

__namedParameters

ClassAttributes<HTMLDivElement> & HTMLAttributes<HTMLDivElement> & object

Returns

Element

---

SidebarMenuSub()

SidebarMenuSub(__namedParameters): Element

Parameters

__namedParameters

DetailedHTMLProps<HTMLAttributes<HTMLUListElement>>

Returns

Element

---

SidebarMenuSubButton()

SidebarMenuSubButton(__namedParameters): Element

Parameters

__namedParameters

ClassAttributes<HTMLAnchorElement> & AnchorHTMLAttributes<HTMLAnchorElement> & object

Returns

Element

---

SidebarMenuSubItem()

SidebarMenuSubItem(__namedParameters): Element

Parameters

__namedParameters

DetailedHTMLProps<LiHTMLAttributes<HTMLLIElement>>

Returns

Element

---

SidebarProvider()

SidebarProvider(__namedParameters): Element

Parameters

__namedParameters

ClassAttributes<HTMLDivElement> & HTMLAttributes<HTMLDivElement> & object

Returns

Element

---

SidebarRail()

SidebarRail(__namedParameters): Element

Parameters

__namedParameters

DetailedHTMLProps<ButtonHTMLAttributes<HTMLButtonElement>>

Returns

Element

---

SidebarSeparator()

SidebarSeparator(__namedParameters): Element

Parameters

__namedParameters

DetailedHTMLProps<HTMLAttributes<HTMLDivElement>>

Returns

Element

---

SidebarTrigger()

SidebarTrigger(props): Element

Parameters

props

SidebarTriggerProps

Returns

Element

---

toCompanyItems()

toCompanyItems(companies, currentCompanyId?): CompanyItem[]

Parameters

companies

readonly CompanyLike[] | undefined

currentCompanyId?

string

Returns

CompanyItem[]

---

useIsMobile()

useIsMobile(): boolean

Returns

boolean

---

UserAvatar()

UserAvatar(props): Element

Parameters

props

UserAvatarArgs

Returns

Element

---

useSidebar()

useSidebar(): SidebarContextProps

Returns

SidebarContextProps