Edit on Github

Offcanvas

in namespace DotVVM.Bootstrap5.Controls

Renders a hidden modal-like sidebar control.

Usage & Scenarios

Renders a Bootstrap offcanvas component.

https://getbootstrap.com/docs/5.2/components/offcanvas/

Sample 1: Placement

Offcanvas is a sidebar component that can be toggled to appear from the Left, Right, Top, or Bottom edge of the viewport by property Placement.

Required property to work with Offcanvas is property IsCollapsed, which is true when offcanvas is hidden and false when is shown.


<bs:Offcanvas HeaderText="Header" BodyText="Body Text" IsCollapsed="{value: IsCollapsed}" Placement="Top" />
public class ViewModel : DotvvmViewModelBase
{
    public bool IsCollapsed { get; set; } = true;
}

Sample 2: Offcanvas text

The header content of Offcanvas can be set by one of two ways: using the HeaderText property or using HeaderTemplate.

The main content can be set using Text or ContentTemplate. This property is required, so it must be set.


<bs:Offcanvas HeaderText="Sample Header" BodyText="This is body text of offcanvas component" IsCollapsed="{value: IsCollapsed}" />

<bs:Offcanvas HeaderText="{value: HeaderText}" BodyText="{value: BodyText}" IsCollapsed="{value: IsCollapsed2}" />

<bs:Offcanvas IsCollapsed="{value: IsCollapsed3}">
    <HeaderTemplate>
        <h2>Custom header</h2>
        <bs:Button Click="{staticCommand: IsCollapsed3 = !IsCollapsed3}" Text="Close" />
    </HeaderTemplate>
    <BodyTemplate>
        <bs:Button Click="{staticCommand: IsCollapsed3 = !IsCollapsed3}" Text="Another close button" />
        <p>Bustom body content</p>
    </BodyTemplate>
</bs:Offcanvas>
public class ViewModel : DotvvmViewModelBase
{
    public bool IsCollapsed { get; set; } = true;
    public bool IsCollapsed2 { get; set; } = true;
    public bool IsCollapsed3 { get; set; } = true;
    public string BodyText { get; set; } = "Bindable Body Text";
    public string HeaderText { get; set; } = "Bindable Header Text";
}

Sample 3: Scrolling

Scrolling the body element is disabled when an offcanvas and its backdrop are visible. Use the property BackDrop attribute to enable body scrolling.

  • BodyScrolling to enable body scrolling
  • BackDrop to disable body scrolling with visible backdrop
  • BodyScrollingAndBackdrop to enable body scrolling with visible backdrop

<bs:Offcanvas BackDrop="BodyScrolling" IsCollapsed="{value: Scrolling}" BodyText="Body Scrolling" HeaderText="BodyScrolling"/>
<bs:Offcanvas BackDrop="Backdrop" IsCollapsed="{value: Drop}" BodyText="Backdrop" HeaderText="With Backdrop"/>
<bs:Offcanvas BackDrop="BodyScrollingAndBackdrop" IsCollapsed="{value: Scrollingdrop}" BodyText="Body Scrooling and Backdrop" HeaderText="BodyScrolling and Backdrop"/>

public class ViewModel : DotvvmViewModelBase
{
    public bool Scrolling { get; set; } = true;
    public bool Drop { get; set; } = true;
    public bool Scrollingdrop { get; set; } = true;
}

Properties

Name Type Description Notes Default Value
property icon Backdrop OffcanvasBackdrop Gets or sets a backdrop settings. Page content srolling can be enabled or disabled.
attribute
inner element
static value
bindable
default
 Backdrop
property icon BodyTemplate ITemplate Gets or sets the content inside the Offcanvas body.
attribute
inner element
static value
bindable
default
 null
property icon BodyText String Gets or sets a plain text inside the Offcanvas body.
attribute
inner element
static value
bindable
default
 null
property icon HeaderTemplate ITemplate Gets or sets the content inside the Offcanvas header.
attribute
inner element
static value
bindable
default
 null
property icon HeaderText String Gets or sets a plain text inside the Offcanvas header.
attribute
inner element
static value
bindable
default
 null
property icon IsExpanded IValueBinding<Boolean> A boolean binding that gets or sets whether the Offcanvas is expanded.
attribute
inner element
static value
bindable
default
 null
property icon Placement OffcanvasPlacement Gets or sets the Offcanvas position.
attribute
inner element
static value
bindable
default
 Left
property icon Visible Boolean Gets or sets whether the control is visible. When set to false, `style="display: none"` will be added to this control.
attribute
inner element
static value
bindable
default
 True

HTML produced by the control

Information about cookies

We use cookies to analyze our traffic, personalize content and ads, and to provide some social media features. We also share information about your use of our site with our social media, advertising and analytics partners who may combine it with other information that you've provided to them or that they've collected from your use of their services.

Edit options

Information about cookies

We use cookies to analyze our traffic, personalize content and ads, and to provide some social media features. We also share information about your use of our site with our social media, advertising and analytics partners who may combine it with other information that you've provided to them or that they've collected from your use of their services.

Choose which cookies you want to enable

Necessary cookies Always allowed

Necessary cookies are essential and maintain information based on your activity on our site, like remembering your signed in account, selection of your language, or products added to the shopping cart. The website cannot work properly without these cookies.

Google Analytics

We use these cookies to measure, collect, analyse and report how users interact with our sites to better understand their behavior. Thanks to this, we can improve the site and provide better experience. The analytics service is provided by Google Inc.

Google Ads

We use these cookies to measure conversions from our advertisement and banners distributed via Google Ads. This allows us to better target the ads and make them more relevant to you.

Facebook Pixel

We use these cookies to measure conversions from our advertisement and banners distributed via Facebook. This allows us to better target the ads and make them more relevant to you.

Smartlook

We use these cookies to measure, collect, analyse and report how users interact with our sites to better understand their behavior. Thanks to this, we can improve the site and provide better experience. The analytics service is provided by Smartlook.

Google ads user data

Google ads ad personalization