offcanvasRef

@Composable
fun IComponent.offcanvasRef(caption: String? = null, placement: OffPlacement = OffPlacement.OffcanvasStart, responsiveType: OffResponsiveType? = null, closeButton: Boolean = true, bodyScrolling: Boolean = false, backdrop: Boolean = true, escape: Boolean = true, className: String? = null, id: String? = null, content: @Composable IOffcanvas.() -> Unit = {}): Offcanvas

Creates an Offcanvas component, returning a reference.

Return

the Offcanvas component

Parameters

caption

the caption of the offcanvas

placement

the placement of the offcanvas

responsiveType

the responsive type of the offcanvas

closeButton

determines if the close button is visible

bodyScrolling

determines if the body is scrolling

backdrop

determines if the backdrop is visible

escape

determines if the offcanvas can be closed with Esc key

className

the CSS class name

id

the ID attribute of the offcanvas

content

the content of the offcanvas