HtmlForgeX

API Reference

Class

OffcanvasSettings

Namespace HtmlForgeX
Assembly HtmlForgeX
Modifiers sealed

Settings sub-builder for TablerOffcanvas.

Inheritance

  • Object
  • OffcanvasSettings

Methods

public OffcanvasSettings Backdrop(Nullable<Boolean> enable = true) #
Returns: OffcanvasSettings

Controls whether the backdrop is shown while the offcanvas is open.

Parameters

enable System.Nullable{System.Boolean} = true optionalposition: 0
public OffcanvasSettings CloseButton(Boolean show = true) #
Returns: OffcanvasSettings

Shows or hides the header close button.

Parameters

show System.Boolean = true optionalposition: 0
public TablerOffcanvas End() #
Returns: TablerOffcanvas

Returns control to the root offcanvas builder.

public OffcanvasSettings Keyboard(Nullable<Boolean> enable = true) #
Returns: OffcanvasSettings

Controls whether the offcanvas can be dismissed with the Escape key.

Parameters

enable System.Nullable{System.Boolean} = true optionalposition: 0
public OffcanvasSettings Placement(TablerOffcanvasPlacement placement) #
Returns: OffcanvasSettings

Sets where the offcanvas appears from.

Parameters

placement HtmlForgeX.TablerOffcanvasPlacement requiredposition: 0
public OffcanvasSettings Scroll(Nullable<Boolean> enable = true) #
Returns: OffcanvasSettings

Controls whether the page is allowed to scroll while the offcanvas is open.

Parameters

enable System.Nullable{System.Boolean} = true optionalposition: 0
public OffcanvasSettings Title(String title) #
Returns: OffcanvasSettings

Sets the offcanvas title.

Parameters

title System.String requiredposition: 0