kvision-bootstrap/io.kvision.dropdown/DropDown

DropDown

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

Bootstrap dropdown component.

Parameters

text

the label of the dropdown button

elements

an optional list of link elements (special options from DD enum class can be used as values)

icon

the icon of the dropdown button

style

the style of the dropdown button

direction

the direction of the dropdown

disabled

determines if the component is disabled on start

forNavbar

determines if the component will be used in a navbar

forDropDown

determines if the component will be used in a dropdown

dark

use dark background

rightAligned

right align the dropdown menu

autoClose

the auto closing mode of the dropdown menu

arrowVisible

show button arrow

className

CSS class names

init

an initializer extension function

Constructors

DropDown

constructor(text: String, elements: List<<Error class: unknown class>>? = null, icon: String? = null, style: <Error class: unknown class> = 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)

Types

Companion

object Companion

Properties

arrowVisible

var arrowVisible: <Error class: unknown class>

Show button arrow.

autoClose

var autoClose: <Error class: unknown class>

The auto closing mode of the dropdown menu.

block

var block: <Error class: unknown class>

Determines if the dropdown button takes all the space horizontally.

button

val button: DropDownButton

dark

var dark: <Error class: unknown class>

Use dark background for the dropdown.

direction

var direction: <Error class: unknown class>

The direction of the dropdown.

disabled

var disabled: <Error class: unknown class>

Determines if the dropdown is disabled.

forDropDown

val forDropDown: Boolean = false

forNavbar

val forNavbar: Boolean = false

icon

var icon: <Error class: unknown class>

The icon of the dropdown button.

image

var image: <Error class: unknown class>

The image on the dropdown button.

val menu: DropDownMenu

rightAligned

var rightAligned: <Error class: unknown class>

Right align the dropdown menu.

size

var size: <Error class: unknown class>

The size of the dropdown button.

style

var style: <Error class: unknown class>

The style of the dropdown button.

text

var text: <Error class: unknown class>

Label of the dropdown button.

width

open var width: <Error class: unknown class>?

Width of the dropdown button.

Functions

add

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

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

addAll

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

buildClassSet

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

buttonId

fun buttonId(): <Error class: unknown class>

ddLink

fun DropDown.ddLink(label: String, url: String? = null, icon: String? = null, image: <Error class: unknown class>? = null, dataNavigo: Boolean? = null, className: String? = null, init: <Error class: unknown class>.() -> Unit? = null): <Error class: unknown class>

DSL builder extension function for a link in a dropdown list.

ddLinkDisabled

fun DropDown.ddLinkDisabled(label: String, icon: String? = null, image: <Error class: unknown class>? = null, className: String? = null, init: <Error class: unknown class>.() -> Unit? = null): <Error class: unknown class>

DSL builder extension function for a disabled link in a dropdown list.

disposeAll

open fun disposeAll()

getChildren