Sidebar

A composable, themeable and customizable sidebar component.

Source Tailwind CSS JavaScript

package showcase

import "github.com/templui/templui/internal/components/sidebar"
import "github.com/templui/templui/internal/components/icon"
import "github.com/templui/templui/internal/components/collapsible"
import "github.com/templui/templui/internal/components/dropdown"
import "github.com/templui/templui/internal/components/avatar"

templ SidebarDefault() {
	@sidebar.Layout() {
		@sidebar.Sidebar(sidebar.Props{
			Collapsible: sidebar.CollapsibleIcon,
			Variant:     sidebar.VariantFloating,
		}) {
			@sidebar.Header() {
				@sidebar.Menu() {
					@sidebar.MenuItem() {
						@sidebar.MenuButton(sidebar.MenuButtonProps{
							Href: "#",
						}) {
							@icon.LayoutPanelLeft(icon.Props{Class: "size-4"})
							<span class="font-semibold">Acme Inc</span>
						}
					}
				}
			}
			@sidebar.Content() {
				@sidebar.Group() {
					@sidebar.GroupLabel() {
						Platform
					}
					@sidebar.Menu() {
						@sidebar.MenuItem() {
							@sidebar.MenuButton(sidebar.MenuButtonProps{
								Href:    "#",
								Tooltip: "Home",
							}) {
								@icon.House(icon.Props{Class: "size-4"})
								<span>Home</span>
							}
						}
						@sidebar.MenuItem() {
							@sidebar.MenuButton(sidebar.MenuButtonProps{
								Href:    "#",
								Tooltip: "Inbox",
							}) {
								@icon.Inbox(icon.Props{Class: "size-4"})
								<span>Inbox</span>
								@sidebar.MenuBadge() {
									3
								}
							}
						}
						@sidebar.MenuItem() {
							@collapsible.Collapsible(collapsible.Props{
								Open:  true,
								Class: "group/collapsible w-full",
							}) {
								@collapsible.Trigger() {
									@sidebar.MenuButton(sidebar.MenuButtonProps{
										Tooltip: "Documents",
									}) {
										@icon.FileText(icon.Props{Class: "size-4"})
										<span>Documents</span>
										@icon.ChevronRight(icon.Props{
											Class: "ml-auto size-4 transition-transform group-data-[tui-collapsible-state=open]/collapsible:rotate-90",
										})
									}
								}
								@collapsible.Content() {
									@sidebar.MenuSub() {
										@sidebar.MenuSubItem() {
											@sidebar.MenuSubButton(sidebar.MenuSubButtonProps{
												Href: "#",
											}) {
												<span>Reports</span>
											}
										}
										@sidebar.MenuSubItem() {
											@sidebar.MenuSubButton(sidebar.MenuSubButtonProps{
												Href: "#",
											}) {
												<span>Invoices</span>
											}
										}
										@sidebar.MenuSubItem() {
											@sidebar.MenuSubButton(sidebar.MenuSubButtonProps{
												Href:     "#",
												IsActive: true,
											}) {
												<span>Receipts</span>
											}
										}
									}
								}
							}
						}
					}
				}
				@sidebar.Separator()
				@sidebar.Group() {
					@sidebar.GroupLabel() {
						Projects
					}
					@sidebar.Menu() {
						@sidebar.MenuItem() {
							@sidebar.MenuButton(sidebar.MenuButtonProps{
								Href:    "#",
								Tooltip: "Project Alpha",
							}) {
								@icon.Folder(icon.Props{Class: "size-4"})
								<span>Project Alpha</span>
								@sidebar.MenuBadge() {
									12
								}
							}
						}
						@sidebar.MenuItem() {
							<div class="w-full">
								@sidebar.MenuButton(sidebar.MenuButtonProps{
									Tooltip: "Project Beta",
								}) {
									@icon.Folder(icon.Props{Class: "size-4"})
									<span>Project Beta</span>
								}
								@sidebar.MenuSub() {
									@sidebar.MenuSubItem() {
										@sidebar.MenuSubButton(sidebar.MenuSubButtonProps{
											Href: "#",
										}) {
											<span>Overview</span>
										}
									}
									@sidebar.MenuSubItem() {
										@sidebar.MenuSubButton(sidebar.MenuSubButtonProps{
											Href: "#",
										}) {
											<span>Analytics</span>
										}
									}
									@sidebar.MenuSubItem() {
										@sidebar.MenuSubButton(sidebar.MenuSubButtonProps{
											Href: "#",
										}) {
											<span>Reports</span>
										}
									}
								}
							</div>
						}
					}
				}
				@sidebar.Separator()
				@sidebar.Group() {
					@sidebar.Menu() {
						@sidebar.MenuItem() {
							@sidebar.MenuButton(sidebar.MenuButtonProps{
								Href:    "#",
								Tooltip: "Team",
							}) {
								@icon.Users(icon.Props{Class: "size-4"})
								<span>Team</span>
							}
						}
						@sidebar.MenuItem() {
							@collapsible.Collapsible(collapsible.Props{
								Open:  false,
								Class: "group/collapsible w-full",
							}) {
								@collapsible.Trigger() {
									@sidebar.MenuButton(sidebar.MenuButtonProps{
										Tooltip: "Settings",
									}) {
										@icon.Settings(icon.Props{Class: "size-4"})
										<span>Settings</span>
										@icon.ChevronRight(icon.Props{
											Class: "ml-auto size-4 transition-transform group-data-[tui-collapsible-state=open]/collapsible:rotate-90",
										})
									}
								}
								@collapsible.Content() {
									@sidebar.MenuSub() {
										@sidebar.MenuSubItem() {
											@sidebar.MenuSubButton(sidebar.MenuSubButtonProps{
												Href: "#",
											}) {
												<span>General</span>
											}
										}
										@sidebar.MenuSubItem() {
											@sidebar.MenuSubButton(sidebar.MenuSubButtonProps{
												Href: "#",
											}) {
												<span>Security</span>
											}
										}
										@sidebar.MenuSubItem() {
											@sidebar.MenuSubButton(sidebar.MenuSubButtonProps{
												Href: "#",
											}) {
												<span>Notifications</span>
											}
										}
									}
								}
							}
						}
					}
				}
			}
			@sidebar.Footer() {
				@sidebar.Menu() {
					@sidebar.MenuItem() {
						@dropdown.Dropdown() {
							@dropdown.Trigger() {
								@sidebar.MenuButton(sidebar.MenuButtonProps{
									Size: sidebar.MenuButtonSizeLg,
								}) {
									@avatar.Avatar(avatar.Props{Class: "size-8 rounded-lg"}) {
										@avatar.Image(avatar.ImageProps{
											Src: "https://avatars.githubusercontent.com/u/26936893?v=4",
										})
									}
									<div class="grid flex-1 text-left text-sm leading-tight">
										<span class="truncate font-medium">John Doe</span>
										<span class="truncate text-xs">[email protected]</span>
									</div>
									@icon.ChevronsUpDown(icon.Props{Class: "ml-auto size-4"})
								}
							}
							@dropdown.Content(dropdown.ContentProps{
								Class:     "w-56",
								Placement: dropdown.PlacementTopStart,
							}) {
								@dropdown.Label() {
									John Doe
								}
								@dropdown.Separator()
								@dropdown.Item() {
									<span class="flex items-center">
										@icon.User(icon.Props{Size: 16, Class: "mr-2"})
										Profile
									</span>
								}
								@dropdown.Item() {
									<span class="flex items-center">
										@icon.Settings(icon.Props{Size: 16, Class: "mr-2"})
										Settings
									</span>
								}
								@dropdown.Separator()
								@dropdown.Item() {
									<span class="flex items-center">
										@icon.LogOut(icon.Props{Size: 16, Class: "mr-2"})
										Log out
									</span>
								}
							}
						}
					}
				}
			}
		}
		@sidebar.Inset() {
			<div class="flex h-full flex-col">
				<div class="flex h-14 items-center gap-4 px-6">
					@sidebar.Trigger()
					<span class="text-sm text-muted-foreground">Press Ctrl+B to toggle sidebar</span>
				</div>
				<div class="flex-1 p-6"></div>
			</div>
		}
	}
}

Installation

Install the component
```
templui add sidebar
```
Add the JavaScript to your layout
```
@sidebar.Script()
@dialog.Script()
@popover.Script()
```
Call this template in your base layout file (e.g., in the <head> section).

Persisted State

The sidebar supports persisting its state across page reloads using cookies. When the sidebar state changes, a cookie named sidebar_state is set with the current open/closed state ("true" for expanded or "false" for collapsed).

To persist sidebar state in your Go application and avoid flicker on page loads, read the cookie server-side and set the Collapsed prop:

func MyHandler(w http.ResponseWriter, r *http.Request) {
    // Read sidebar state from cookie
    cookie, _ := r.Cookie("sidebar_state")
    // "false" means collapsed, "true" or no cookie means expanded
    collapsed := cookie != nil && cookie.Value == "false"
    
    // Pass to template
    component := MyPage(collapsed)
    component.Render(context.Background(), w)
}

templ MyPage(collapsed bool) {
    @sidebar.Layout() {
        @sidebar.Sidebar(sidebar.Props{
            Collapsed: collapsed,
        }) {
            // Sidebar content
        }
        @sidebar.Inset() {
            // Main content
        }
    }
}

Note: The JavaScript will not automatically restore the state from cookies to prevent flicker. Always read the cookie server-side for the best user experience.

Custom Width

The sidebar width is controlled via the CSS variable --sidebar-width (default: 16rem). You can set it to any valid CSS value using the Attributes prop.

Example

@sidebar.Sidebar(sidebar.Props{
    Attributes: templ.Attributes{
        "style": "--sidebar-width:20rem", // Any CSS unit works: px, %, vw, etc.
    },
}) {
    // sidebar content
}

Note: You can use any valid CSS unit (rem, px, %, vw) or even dynamic values like calc(), min(), or clamp() for responsive designs.

API Reference

Required parameter

Hover for description

Layout

Root layout container that manages sidebar and main content layout.

Name	Type	Default
`ID` Unique identifier for the layout container.	`string`	`auto-generated`
`Class` Additional CSS classes to apply to the layout container.	`string`	-
`Attributes` Additional HTML attributes to apply to the layout element.	`templ.Attributes`	-

Sidebar

Main sidebar container that holds all sidebar components.

Name	Type	Default
`ID` Unique identifier for the sidebar. Auto-generated if not provided.	`string`	`auto-generated`
`Class` Additional CSS classes to apply to the sidebar.	`string`	-
`Attributes` Additional HTML attributes to apply to the sidebar element.	`templ.Attributes`	-
`Side` Position of the sidebar. Options: 'left' or 'right'.	`Side`	`left`
`Variant` Visual style variant. Options: 'sidebar' (default), 'floating', 'inset'.	`Variant`	`sidebar`
`Collapsed` Whether the sidebar starts in collapsed state.	`bool`	`false`
`Collapsible` Collapsible behavior. Options: 'offcanvas' (slides off screen), 'icon' (collapses to icon width), 'none' (cannot be collapsed).	`Collapsible`	`offcanvas`
`KeyboardShortcut` Keyboard shortcut key for toggling the sidebar (used with Cmd/Ctrl).	`string`	`b`

Trigger

Button component to toggle the sidebar visibility.

Name	Type	Default
`ID` Unique identifier for the trigger button.	`string`	-
`Class` Additional CSS classes to apply to the trigger button.	`string`	-
`Attributes` Additional HTML attributes to apply to the trigger button.	`templ.Attributes`	-

Header

Header section of the sidebar, typically contains logo and title. This section is sticky and remains visible when content scrolls.

Name	Type	Default
`ID` Unique identifier for the header element.	`string`	-
`Class` Additional CSS classes to apply to the header.	`string`	-
`Attributes` Additional HTML attributes to apply to the header element.	`templ.Attributes`	-

Content

Main content area of the sidebar, typically contains navigation menu. This section is scrollable when content exceeds the available height.

Name	Type	Default
`ID` Unique identifier for the content element.	`string`	-
`Class` Additional CSS classes to apply to the content area.	`string`	-
`Attributes` Additional HTML attributes to apply to the content element.	`templ.Attributes`	-

Footer

Footer section of the sidebar, typically contains user info or settings. This section is sticky at the bottom and remains visible when content scrolls.

Name	Type	Default
`ID` Unique identifier for the footer element.	`string`	-
`Class` Additional CSS classes to apply to the footer.	`string`	-
`Attributes` Additional HTML attributes to apply to the footer element.	`templ.Attributes`	-

Name	Type	Default
`ID` Unique identifier for the menu element.	`string`	-
`Class` Additional CSS classes to apply to the menu.	`string`	-
`Attributes` Additional HTML attributes to apply to the menu element.	`templ.Attributes`	-

MenuItem

Individual menu item wrapper within the menu.

Name	Type	Default
`ID` Unique identifier for the menu item element.	`string`	-
`Class` Additional CSS classes to apply to the menu item.	`string`	-
`Attributes` Additional HTML attributes to apply to the menu item element.	`templ.Attributes`	-

MenuButton

Clickable menu button or link within a menu item.

Name	Type	Default
`ID` Unique identifier for the menu button element.	`string`	-
`Class` Additional CSS classes to apply to the menu button.	`string`	-
`Attributes` Additional HTML attributes to apply to the menu button element.	`templ.Attributes`	-
`Href` URL for the menu link. When provided, renders an anchor tag instead of button.	`string`	-
`IsActive` Whether the menu item is currently active/selected.	`bool`	`false`
`Size` Size of the menu button. Options: 'sm', 'default', 'lg'.	`MenuButtonSize`	`default`
`Tooltip` Tooltip text to display when sidebar is collapsed to icon mode.	`string`	-

MenuSub

Container for nested submenu items.

Name	Type	Default
`ID` Unique identifier for the submenu element.	`string`	-
`Class` Additional CSS classes to apply to the submenu.	`string`	-
`Attributes` Additional HTML attributes to apply to the submenu element.	`templ.Attributes`	-

MenuSubItem

Individual submenu item wrapper.

Name	Type	Default
`ID` Unique identifier for the submenu item element.	`string`	-
`Class` Additional CSS classes to apply to the submenu item.	`string`	-
`Attributes` Additional HTML attributes to apply to the submenu item element.	`templ.Attributes`	-

MenuSubButton

Clickable submenu button or link.

Name	Type	Default
`ID` Unique identifier for the submenu button element.	`string`	-
`Class` Additional CSS classes to apply to the submenu button.	`string`	-
`Attributes` Additional HTML attributes to apply to the submenu button element.	`templ.Attributes`	-
`Href` URL for the submenu link. When provided, renders an anchor tag instead of button.	`string`	-
`IsActive` Whether the submenu item is currently active/selected.	`bool`	`false`
`Size` Size of the submenu button. Options: 'sm', 'md'.	`MenuSubButtonSize`	`sm`

Inset

Main content wrapper that adapts to sidebar state.

Name	Type	Default
`ID` Unique identifier for the inset element.	`string`	-
`Class` Additional CSS classes to apply to the inset.	`string`	-
`Attributes` Additional HTML attributes to apply to the inset element.	`templ.Attributes`	-

Group

Groups related menu items together with optional label.

Name	Type	Default
`ID` Unique identifier for the group element.	`string`	-
`Class` Additional CSS classes to apply to the group.	`string`	-
`Attributes` Additional HTML attributes to apply to the group element.	`templ.Attributes`	-

GroupLabel

Label for a sidebar group, typically used to name sections like 'Platform' or 'Projects'.

Name	Type	Default
`ID` Unique identifier for the group label element.	`string`	-
`Class` Additional CSS classes to apply to the group label.	`string`	-
`Attributes` Additional HTML attributes to apply to the group label element.	`templ.Attributes`	-

MenuBadge

Badge within a menu item, typically used to show counts or notifications.

Name	Type	Default
`ID` Unique identifier for the menu badge element.	`string`	-
`Class` Additional CSS classes to apply to the menu badge.	`string`	-
`Attributes` Additional HTML attributes to apply to the menu badge element.	`templ.Attributes`	-

Separator

Visual separator between sidebar sections.

Name	Type	Default
`ID` Unique identifier for the separator element.	`string`	-
`Class` Additional CSS classes to apply to the separator.	`string`	-
`Attributes` Additional HTML attributes to apply to the separator element.	`templ.Attributes`	-

Menu

Getting Started

Components

Sidebar

Installation

Persisted State

Custom Width

Example

API Reference

Layout

Sidebar

Trigger

Header

Content

Footer

Menu

MenuItem

MenuButton

MenuSub

MenuSubItem

MenuSubButton

Inset

Group

GroupLabel

MenuBadge

Separator