API Reference
Class
OffcanvasSettings
Settings sub-builder for TablerOffcanvas.
Inheritance
- Object
- OffcanvasSettings
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Method OffcanvasSettings.Backdrop
- Method OffcanvasSettings.CloseButton
- Method OffcanvasSettings.Keyboard
- Method OffcanvasSettings.Placement
- Method OffcanvasSettings.Scroll
- Method OffcanvasSettings.Title
Accepted by parameters
- Method TablerOffcanvas.Settings
Methods
public OffcanvasSettings Backdrop(Nullable<Boolean> enable = true) #Returns:
OffcanvasSettingsControls whether the backdrop is shown while the offcanvas is open.
Parameters
- enable System.Nullable{System.Boolean} = true
public OffcanvasSettings CloseButton(Boolean show = true) #Returns:
OffcanvasSettingsShows or hides the header close button.
Parameters
- show System.Boolean = true
public TablerOffcanvas End() #Returns:
TablerOffcanvasReturns control to the root offcanvas builder.
public OffcanvasSettings Keyboard(Nullable<Boolean> enable = true) #Returns:
OffcanvasSettingsControls whether the offcanvas can be dismissed with the Escape key.
Parameters
- enable System.Nullable{System.Boolean} = true
public OffcanvasSettings Placement(TablerOffcanvasPlacement placement) #Returns:
OffcanvasSettingsSets where the offcanvas appears from.
Parameters
- placement HtmlForgeX.TablerOffcanvasPlacement
public OffcanvasSettings Scroll(Nullable<Boolean> enable = true) #Returns:
OffcanvasSettingsControls whether the page is allowed to scroll while the offcanvas is open.
Parameters
- enable System.Nullable{System.Boolean} = true
public OffcanvasSettings Title(String title) #Returns:
OffcanvasSettingsSets the offcanvas title.
Parameters
- title System.String