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) : SimplePanel(source)

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

Offcanvas

constructor(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

Companion

object Companion

Properties

_archivedState

var _archivedState: dynamic

alignContent

open var alignContent: AlignContent?

alignItems

open var alignItems: AlignItems?

alignSelf

open var alignSelf: AlignItems?

background

open var background: Background?

body

val body: SimplePanel

The offcanvas body component.

border

open var border: Border?

borderBottom

open var borderBottom: Border?

borderLeft

open var borderLeft: Border?

borderRadius

open var borderRadius: CssSize?

borderRadiusList

open var borderRadiusList: List<CssSize>?

borderRight

open var borderRight: Border?

borderTop

open var borderTop: Border?

bottom

open var bottom: CssSize?

boxShadow

open var boxShadow: BoxShadow?

boxShadowList

open var boxShadowList: List<BoxShadow>?

caption

var caption: String?

The offcanvas caption text.

captionTag

val captionTag: H5

The offcanvas caption component.

clear

open var clear: Clear?

closeButton

var closeButton: Boolean

Determines if Close button is visible.

color

open var color: Color?

colorHex

open var colorHex: Int?

colorName

open var colorName: Col?

cursor

open var cursor: Cursor?

dark

var dark: Boolean

Dark mode.

display

open var display: Display?

draggable

var draggable: Boolean?

eventTarget

var eventTarget: Widget?

flexBasis

open var flexBasis: CssSize?

flexDirection

open var flexDirection: FlexDirection?

flexGrow

open var flexGrow: Int?

flexShrink

open var flexShrink: Int?

flexWrap

open var flexWrap: FlexWrap?

float

open var float: PosFloat?

fontFamily

open var fontFamily: String?

fontSize

open var fontSize: CssSize?

fontStyle

open var fontStyle: FontStyle?

fontVariant

open var fontVariant: FontVariant?

fontWeight

open var fontWeight: FontWeight?

gridArea

open var gridArea: String?

gridAutoColumns

open var gridAutoColumns: String?

gridAutoFlow

open var gridAutoFlow: GridAutoFlow?

gridAutoRows

open var gridAutoRows: String?

gridColumnEnd

open var gridColumnEnd: String?

gridColumnGap

open var gridColumnGap: Int?

gridColumnStart

open var gridColumnStart: Int?

gridRowEnd

open var gridRowEnd: String?

gridRowGap

open var gridRowGap: Int?

gridRowStart

open var gridRowStart: Int?

gridTemplateAreas

open var gridTemplateAreas: List<String>?

gridTemplateColumns

open var gridTemplateColumns: String?

gridTemplateRows

open var gridTemplateRows: String?

headerTag

val headerTag: SimplePanel

The offcanvas header component.

height

open var height: CssSize?

var id: String?

justifyContent

open var justifyContent: JustifyContent?

justifyItems

open var justifyItems: JustifyItems?

justifySelf

open var justifySelf: JustifyItems?

kvscope

var kvscope: dynamic

left

open var left: CssSize?

letterSpacing

open var letterSpacing: CssSize?

lineBreak

open var lineBreak: LineBreak?

lineHeight

open var lineHeight: CssSize?

listStyle

open var listStyle: ListStyle?

margin

open var margin: CssSize?

marginBottom

open var marginBottom: CssSize?

marginLeft

open var marginLeft: CssSize?

marginRight

open var marginRight: CssSize?

marginTop

open var marginTop: CssSize?

maxHeight

open var maxHeight: CssSize?

maxWidth

open var maxWidth: CssSize?

minHeight

open var minHeight: CssSize?

minWidth

open var minWidth: CssSize?

opacity

open var opacity: Double?

order

open var order: Int?

outline

open var outline: Outline?

overflow

open var overflow: Overflow?

overflowWrap

open var overflowWrap: OverflowWrap?

overflowX

open var overflowX: Overflow?

overflowY

open var overflowY: Overflow?

padding

open var padding: CssSize?

paddingBottom

open var paddingBottom: CssSize?

paddingLeft

open var paddingLeft: CssSize?

paddingRight

open var paddingRight: CssSize?

paddingTop

open var paddingTop: CssSize?

parent

open override var parent: Container?

placement

var placement: OffPlacement

The offcanvas placement.

popoverHooksActive

var popoverHooksActive: Boolean

popoverOptions

var popoverOptions: dynamic

position

open var position: Position?

resize

open var resize: Resize?

responsiveType

var responsiveType: OffResponsiveType?

The offcanvas responsive type.

right

open var right: CssSize?

role

var role: String?

tabindex

var tabindex: Int?

textAlign

open var textAlign: TextAlign?

textDecoration

open var textDecoration: TextDecoration?

textDirection

open var textDirection: Direction?

textIndent

open var textIndent: CssSize?

textOverflow

open var textOverflow: TextOverflow?

textShadow

open var textShadow: TextShadow?

textTransform

open var textTransform: TextTransform?

title

var title: String?

tooltipHooksActive

var tooltipHooksActive: Boolean

tooltipOptions

var tooltipOptions: dynamic

top

open var top: CssSize?

transition

open var transition: Transition?

transitionList

open var transitionList: List<Transition>?

unicodeBidi

open var unicodeBidi: UnicodeBidi?

verticalAlign

open var verticalAlign: VerticalAlign?

visible

open override var visible: Boolean

whiteSpace

open var whiteSpace: WhiteSpace?

width

open var width: CssSize?

wordBreak

open var wordBreak: WordBreak?

wordSpacing

open var wordSpacing: CssSize?

zIndex

open var zIndex: Int?

Functions

add

open override fun add(child: Component)

open override fun add(position: Int, child: Component)

addAfterCreateHook

open override fun addAfterCreateHook(hook: (VNode) -> Unit): Boolean

addAfterDestroyHook

open override fun addAfterDestroyHook(hook: () -> Unit): Boolean

addAfterInsertHook

open override fun addAfterInsertHook(hook: (VNode) -> Unit): Boolean

addAll

open override fun addAll(children: List<Component>)

addBeforeDisposeHook

open override fun addBeforeDisposeHook(hook: () -> Unit): Boolean

addBsBgColor

fun Component.addBsBgColor(bsBgColor: BsBgColor)

addBsBorder

fun Component.addBsBorder(vararg bsBorder: BsBorder)

addBsClearfix

fun Component.addBsClearfix()

addBsColor

fun Component.addBsColor(bsColor: BsColor)

addBsRounded

fun Component.addBsRounded(vararg bsRounded: BsRounded)

addCssClass

open override fun addCssClass(css: String)

addCssStyle

open override fun addCssStyle(css: Style)

addSurroundingCssClass

open override fun addSurroundingCssClass(css: String)

addSurroundingCssStyle

open override fun addSurroundingCssStyle(css: Style)

badge

fun Container.badge(content: String? = null, bsColor: BsColor = BsColor.SECONDARYBG, rounded: Boolean = false, position: BadgePosition? = null, init: Badge.() -> Unit = {}): Badge

DSL builder extension function.

blur

open fun blur()

buttonGroup

fun Container.buttonGroup(size: ButtonGroupSize? = null, vertical: Boolean = false, className: String? = null, init: ButtonGroup.() -> Unit? = null): ButtonGroup

DSL builder extension function.

clearAfterCreateHooks

open override fun clearAfterCreateHooks()

clearAfterDestroyHooks

open override fun clearAfterDestroyHooks()

clearAfterInsertHooks

open override fun clearAfterInsertHooks()

clearBeforeDisposeHooks

open override fun clearBeforeDisposeHooks()

clearDragDropData

open fun clearDragDropData()

clearParent

open override fun clearParent()

collapse

fun Container.collapse(id: String, groupId: String? = null, horizontal: Boolean = false, opened: Boolean = false, init: Collapse.() -> Unit): Collapse

DSL builder extension function. It takes the same parameters as the constructor of the built component.

contextMenu

fun Widget.contextMenu(fixedPosition: Boolean = false, className: String? = null, init: ContextMenu.() -> Unit? = null): ContextMenu

DSL builder extension function.

disablePopover

fun Widget.disablePopover()

Disables popover for the current widget.

disableTooltip

fun Widget.disableTooltip()

Disables tooltip for the current widget.

dispatchEvent

open fun dispatchEvent(type: String, eventInitDict: CustomEventInit): Boolean?

dispose

open override fun dispose()

disposeAll

open override fun disposeAll()

dropDown

fun Container.dropDown(text: String, elements: List<StringPair>? = null, icon: String? = null, style: ButtonStyle = ButtonStyle.PRIMARY, direction: Direction = Direction.DROPDOWN, disabled: Boolean = false, forNavbar: Boolean = false, forDropDown: Boolean = false, dark: Boolean = false, rightAligned: Boolean = false, autoClose: AutoClose = AutoClose.TRUE, arrowVisible: Boolean = true, className: String? = null, init: DropDown.() -> Unit? = null): DropDown

DSL builder extension function.

enablePopover

fun Widget.enablePopover(options: PopoverOptions = PopoverOptions())

Enables popover for the current widget.

enableTooltip

fun Widget.enableTooltip(options: TooltipOptions = TooltipOptions())

Enables tooltip for the current widget.

focus

open fun focus()

getAttribute

open override fun getAttribute(name: String): String?

getChildren

open override fun getChildren(): List<Component>

getElement

open override fun getElement(): HTMLElement?

getElementD

open override fun getElementD(): dynamic

getRoot

open override fun getRoot(): Root?

getSnStyle

open fun getSnStyle(): dynamic

getStyle

fun getStyle(name: String): String?

hasCssClass

open override fun hasCssClass(css: String): Boolean

hide

open override fun hide()

hideBootstrap

fun hideBootstrap()

Hide offcanvas with Bootstrap function.

hidePopover

fun Widget.hidePopover()

Hides popover for the current widget.

hideTooltip

fun Widget.hideTooltip()

Hides tooltip for the current widget.

invoke

open operator fun invoke(vararg children: Component)

navbar

fun Container.navbar(label: String? = null, link: String? = null, type: NavbarType? = null, expand: NavbarExpand? = NavbarExpand.LG, nColor: NavbarColor? = null, bgColor: BsBgColor = BsBgColor.BODYTERTIARY, collapseOnClick: Boolean = false, dataNavigo: Boolean? = null, containerType: ContainerType = ContainerType.FLUID, className: String? = null, init: Navbar.() -> Unit? = null): Navbar

DSL builder extension function.

offcanvas

fun Container.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): Offcanvas

DSL builder extension function.

progress

fun <T> Container.progress(bounds: Bounds<T>, className: String? = null, init: Progress<T>.() -> Unit? = null): Progress<T>

fun Container.progress(min: Number = 0, max: Number = 100, className: String? = null, init: Progress<Number>.() -> Unit? = null): Progress<Number>

DSL builder extension function.

refresh

open override fun refresh()

remove

open override fun remove(child: Component)

removeAfterCreateHook

open override fun removeAfterCreateHook(hook: (VNode) -> Unit): Boolean

removeAfterDestroyHook

open override fun removeAfterDestroyHook(hook: () -> Unit): Boolean

removeAfterInsertHook

open override fun removeAfterInsertHook(hook: (VNode) -> Unit): Boolean

removeAll

open override fun removeAll()

removeAt

open override fun removeAt(position: Int)

removeAttribute

open override fun removeAttribute(name: String)

removeBeforeDisposeHook

open override fun removeBeforeDisposeHook(hook: () -> Unit): Boolean

removeBsBgColor

fun Component.removeBsBgColor(bsBgColor: BsBgColor)

removeBsBorder

fun Component.removeBsBorder(vararg bsBorder: BsBorder)

removeBsClearfix

fun Component.removeBsClearfix()

removeBsColor

fun Component.removeBsColor(bsColor: BsColor)

removeBsRounded

fun Component.removeBsRounded(vararg bsRounded: BsRounded)

removeCssClass

open override fun removeCssClass(css: String)

removeCssStyle

open override fun removeCssStyle(css: Style)

removeEventListener

open fun removeEventListener(id: Int)

removeEventListeners

open fun removeEventListeners()

removeStyle

fun removeStyle(name: String)

removeSurroundingCssClass

open override fun removeSurroundingCssClass(css: String)

removeSurroundingCssStyle

open override fun removeSurroundingCssStyle(css: Style)

renderVNode

open override fun renderVNode(): VNode

responsiveGridPanel

fun Container.responsiveGridPanel(gridSize: GridSize = GridSize.MD, rows: Int = 0, cols: Int = 0, align: Align? = null, className: String? = null, init: ResponsiveGridPanel.() -> Unit? = null): ResponsiveGridPanel

DSL builder extension function.

setAttribute

open override fun setAttribute(name: String, value: String)

setContextMenu

fun Widget.setContextMenu(contextMenu: ContextMenu)

Sets context menu for the current widget.

setDragDropData

open fun setDragDropData(format: String, data: String)

setDropTarget

open fun setDropTarget(format: String, callback: (DragEvent) -> Unit)

open fun setDropTarget(formats: Set<String>?, callback: (DragEvent) -> Unit)

setDropTargetData

open fun setDropTargetData(format: String, callback: (String?) -> Unit)

setEventListener

open fun <T : Widget> setEventListener(block: SnOn<T>.() -> Unit): Int

setStyle

fun setStyle(name: String, value: String)

show

open fun show()

showBootstrap

fun showBootstrap()

Show offcanvas with Bootstrap function.

showPopover

fun Widget.showPopover()

Shows popover for the current widget.

showTooltip

fun Widget.showTooltip()

Shows tooltip for the current widget.

singleRender

open override fun <T> singleRender(block: () -> T): T

singleRenderAsync

open override fun singleRenderAsync(block: () -> Unit)

switch

fun Container.switch(value: Boolean = false, name: String? = null, labelFirst: Boolean = false, label: String? = null, rich: Boolean = false, init: Switch.() -> Unit? = null): Switch

DSL builder extension function.

switchInput

fun Container.switchInput(value: Boolean = false, className: String? = null, init: SwitchInput.() -> Unit? = null): SwitchInput

DSL builder extension function.

table

fun Container.table(headerNames: List<String>? = null, types: Set<TableType> = setOf(), caption: String? = null, responsiveType: ResponsiveType? = null, tableColor: TableColor? = null, theadColor: TableColor? = null, tbodyDivider: Boolean = false, className: String? = null, init: Table.() -> Unit? = null): Table

DSL builder extension function.

tabPanel

fun Container.tabPanel(tabPosition: TabPosition = TabPosition.TOP, sideTabSize: SideTabSize = SideTabSize.SIZE_3, scrollableTabs: Boolean = false, draggableTabs: Boolean = false, className: String? = null, init: TabPanel.() -> Unit? = null): TabPanel

DSL builder extension function.

themeSwitcher

fun Container.themeSwitcher(title: String? = "Switch color theme", style: ButtonStyle = ButtonStyle.SECONDARY, round: Boolean = false, disabled: Boolean = false, className: String? = null, init: ThemeSwitcher.() -> Unit? = null): ThemeSwitcher

DSL builder extension function.

toggle

open fun toggle()

Toggle offcanvas visibility.

toggleVisible

open fun toggleVisible()

toolbar

fun Container.toolbar(size: ButtonGroupSize? = null, spacing: Int = 2, vertical: Boolean = false, className: String? = null, init: Toolbar.() -> Unit? = null): Toolbar

DSL builder extension function.

translate

open fun translate(text: String): String

open fun translate(text: String?): String?

unaryPlus

open operator fun String.unaryPlus()

useSnabbdomDistinctKey

open fun useSnabbdomDistinctKey()

window

fun Container.window(caption: String? = null, contentWidth: CssSize? = CssSize(0, UNIT.auto), contentHeight: CssSize? = CssSize(0, UNIT.auto), isResizable: Boolean = true, isDraggable: Boolean = true, closeButton: Boolean = false, maximizeButton: Boolean = false, minimizeButton: Boolean = false, icon: String? = null, className: String? = null, init: Window.() -> Unit? = null): Window

DSL builder extension function.