page_sidebar: Create a Shell with Sidebar Panel Layout

In calcite: Bindings to the Calcite Design System 'JavaScript' Component Library

Create a Shell with Sidebar Panel Layout

Description

Similar to bslib::page_sidebar(), this creates a layout with a sidebar panel and main content area — the easiest way to build a standard Calcite app layout. Pass a calcite_panel() as sidebar; it will be wrapped in a calcite_shell_panel() automatically.

Usage

page_sidebar(
  ...,
  sidebar = NULL,
  title = NULL,
  position = c("start", "end"),
  width = c("m", "s", "l"),
  display_mode = c("dock", "overlay", "float-content", "float-all"),
  footer = NULL
)

Arguments

...	Main content area (typically a calcite_panel() or map view)
sidebar	A calcite_panel() for the sidebar. Typically contains calcite_block() components with controls.
title	Optional application title shown in a navigation header.
position	Position of sidebar: "start" (left) or "end" (right).
width	Width of the sidebar: "s", "m", or "l".
display_mode	Display mode for the shell panel: "dock", "overlay", "float-content", or "float-all". Default: "dock".
footer	Optional footer content

Value

An object of class calcite_component containing a configured shell

Examples

page_sidebar(
  title = "Data Explorer",
  sidebar = calcite_panel(
    heading = "Filters",
    calcite_block(
      heading = "Options",
      collapsible = TRUE,
      expanded = TRUE
    )
  ),
  calcite_panel(heading = "Results")
)

calcite documentation built on March 3, 2026, 5:07 p.m.