Docs Quickstart Figma Flowbite
1.3.0
Getting started
Customize
Components
API Reference NEW
components / Class

SidebarComponent

Decorators:@Component
Selectors:flowbite-sidebar
Extends:BaseComponent<FlowbiteClass>
Implements:OnInit

No documentation has been provided.

See Also

Properties

NameTypeDescription
color
ModelSignal<keyof SidebarColors>

Set the sidebar color

contentClasses
inherited from BaseComponent
Signal<TClass>

Computed signal storing the component classes used in its template

customStyle
ModelSignal<{ root?: { base?: string | undefined; isRounded?: { enabled?: string | undefined; disabled?: string | undefined; } | undefined; } | undefined; }>

Set the custom style for this sidebar

displayMode
ModelSignal<keyof SidebarDisplayMode>

Set the sidebar display mode

flowbiteId
r
inherited from BaseComponent
WritableSignal<Guid>

Auto generated GUID for each flowbite-angular component

Its default value is 00000000-0000-0000-0000-000000000000, and is set to a random GUID inside the afterNextRender hook

injector
r
inherited from BaseComponent
Injector

Injector instance injected to be used as an injector context where there is no default one.

Example usage
public ngOnInit(): void {
  afterNextRender(
     () => {},
     { injector: this.injector }
  );
}
isOpen
ModelSignal<boolean>

Set is the sidebar is open

isRounded
ModelSignal<boolean>

Set is the sidebar is rounded

sidebarMenuChild
r
Signal<SidebarMenuComponent>

The child SidebarMenuComponent

sidebarPageContentChild
r
Signal<SidebarPageContentComponent>

The child SidebarPageContentComponent

themeService
r
SidebarThemeService

Service injected used to generate class

Methods

fetchClass()

implements BaseComponent

Function to load component's classes

Presentation
fetchClass(): FlowbiteClass;
Returns

init()

inherited from BaseComponent

Function loaded during OnInit lifecycle hook. It initialize requirments for the component.

Presentation
init(): void;
Returns
void

ngOnInit()

inherited from BaseComponent

Initialize component.

A call to verify and init function is done. Then a new Guid is set in the afterNextRender hook.

Presentation
ngOnInit(): void;
Returns
void

toggleVisibility()

Toggle sidebar visibility

Presentation
toggleVisibility(isOpen?: boolean | undefined): void;
Parameters
NameTypeDescription
isOpen
boolean | undefined

If provided force isOpen value

Returns
void
Flowbite

© 2019-2024 Flowbite™ is a registered trademark. All Rights Reserved.