kvision-bootstrap/io.kvision.offcanvas/Offcanvas

Offcanvas

open class Offcanvas( caption: String? = null, placement: OffPlacement = OffPlacement.START, closeButton: Boolean = true, dark: Boolean = false, responsiveType: OffResponsiveType? = null, scrollableBody: Boolean = false, backdrop: Boolean = true, escape: Boolean = true, className: String? = null, init: Offcanvas.() -> Unit? = null)

The Bootstrap offcanvas component.

Parameters

caption

the offcanvas caption

placement

the offcanvas placement

closeButton

determines if Close button is visible

dark

dark mode

responsiveType

the offcanvas responsive type

scrollableBody

determines if the page body is scrollable

backdrop

determines if the backdrop is visible

escape

determines if the offcanvas can be closed with the Esc key

className

CSS class names

init

an initializer extension function

Constructors

fun Offcanvas( caption: String? = null, placement: OffPlacement = OffPlacement.START, closeButton: Boolean = true, dark: Boolean = false, responsiveType: OffResponsiveType? = null, scrollableBody: Boolean = false, backdrop: Boolean = true, escape: Boolean = true, className: String? = null, init: Offcanvas.() -> Unit? = null)

Types

object Companion

Functions

open fun add(child: <Error class: unknown class>): Offcanvas

open fun add(position: Int, child: <Error class: unknown class>): Offcanvas

open fun addAll(children: List<<Error class: unknown class>>): Offcanvas

open fun afterInsert(node: <Error class: unknown class>)

open fun buildClassSet(classSetBuilder: <Error class: unknown class>)

open fun disposeAll(): Offcanvas

open fun getChildren(): List<<Error class: unknown class>>

open fun hide(): <Error class: unknown class>

fun hideBootstrap()

Hide offcanvas with Bootstrap function.

open fun remove(child: <Error class: unknown class>): Offcanvas

open fun removeAll(): Offcanvas

open fun removeAt(position: Int): Offcanvas

fun showBootstrap()

Show offcanvas with Bootstrap function.

open fun toggle()

Toggle offcanvas visibility.

Properties

val body: <Error class: unknown class>

The offcanvas body component.

var caption: <Error class: unknown class>

The offcanvas caption text.

val captionTag: <Error class: unknown class>

The offcanvas caption component.

var closeButton: <Error class: unknown class>

Determines if Close button is visible.

var dark: <Error class: unknown class>

Dark mode.

val headerTag: <Error class: unknown class>

The offcanvas header component.

var placement: <Error class: unknown class>

The offcanvas placement.

var responsiveType: <Error class: unknown class>

The offcanvas responsive type.