Off Canvas

Build a nestable slide-in panel for navigation, search, mini-cart, wishlist, or other content. The panel can use click, hover, or scroll triggers, and its content remains editable in Bricks.

Setup and First Use


Before starting, enable the relevant element or feature family under Bricks → BricksUltimate → General Elements, save, and reopen the Bricks editor. Integrations also require their corresponding plugin to be active.

  1. Add (BU)Off-Canvas to a template loaded wherever the panel is needed.
  2. Add the panel contents as nested children and include an obvious close control.
  3. Choose Trigger on. For Click or Hover, assign a unique class to an external trigger and enter the matching Trigger selector, such as .open-navigation.
  4. Set Panel Position and a responsive width or height suitable for that direction.
  5. Configure Placement, backdrop, transition duration, and Disable scroll as needed.
  6. Test opening, closing, keyboard use, inner scrolling, and background scrolling on desktop and mobile.

Controls and Settings


ControlPurpose and usage
Trigger on / Offset(px)Click and Hover use a selector; Scroll uses the configured offset. Prefer Click for essential touch-accessible controls.
Trigger selectorA CSS selector matching a real trigger on the rendered page. Use a unique class per panel.
PlacementCurrent position, after body, or above the closing body area can change how the overlay interacts with surrounding layout.
PanelSet direction, dimensions, spacing, background, border, and shadow independently of the backdrop.
Extra ActionsConfigure Escape closing, hash-link closing, pushing body content, and reveal-on-load only for the intended workflow.
Backdrop / ScrollbarStyle the overlay and available scrollbar controls. Prevent click to close panel changes backdrop behavior.
Mini Cart / Mini Wishlist / Mini CompareOptional reveal, delay, duration, and auto-close controls respond to the corresponding supported feature actions.

Closing and Scroll Behavior


Add a distinct close button inside the panel, then include its class in Trigger selector along with the open trigger, for example .open-navigation, .close-navigation. The supported click triggers toggle the panel, so the nested control closes an open panel. Keep Escape/backdrop closing available unless there is a clear alternative. Disable scroll is intended to lock the background, not the panel contents. Allow internal scrolling when content is taller than the viewport.

Avoid Overlay Conflicts


A transformed or clipped parent can affect a fixed panel; consider a different Placement before applying arbitrary offsets. Do not give the same trigger selector to several unrelated panels. If you put a mini-cart or slider inside, verify its first open and AJAX refreshes as well as the panel animation.

Practical Example


Create a right-side navigation panel with .open-navigation on the external trigger and .close-navigation on an accessible nested close button. Enter both selectors in Trigger selector, enable Disable scroll, and test the complete keyboard and touch flow.

Troubleshooting


  • Panel does not open: verify trigger selector, page/template presence, and trigger event.
  • Cannot close: restore a close control and review Escape/backdrop restrictions.
  • Background shifts or content clips: inspect scroll locks, transformed ancestors, and duplicate overlays.
  • Auto-close too soon: check the feature-specific duration and disable-auto-close settings.

Related Documentation