kvision-bootstrap/io.kvision.dropdown/DropDown

DropDown

open class DropDown(text: String, elements: List<<ERROR CLASS>>?, icon: String?, style: <ERROR CLASS>, direction: Direction, disabled: Boolean, forNavbar: Boolean, forDropDown: Boolean, dark: Boolean, className: String?, init: DropDown.() -> Unit?)

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

className

CSS class names

init

an initializer extension function

Constructors

DropDown

fun DropDown(text: String, elements: List<<ERROR CLASS>>? = null, icon: String? = null, style: <ERROR CLASS> = ButtonStyle.PRIMARY, direction: Direction = Direction.DROPDOWN, disabled: Boolean = false, forNavbar: Boolean = false, forDropDown: Boolean = false, dark: Boolean = false, className: String? = null, init: DropDown.() -> Unit? = null)

Types

Companion

object Companion

Functions

add

open fun add(child: <ERROR CLASS>): DropDown

open fun add(position: Int, child: <ERROR CLASS>): DropDown

addAll

open fun addAll(children: List<<ERROR CLASS>>): DropDown

buildClassSet

open fun buildClassSet(classSetBuilder: <ERROR CLASS>)

buttonId

fun buttonId(): <ERROR CLASS>

disposeAll

open fun disposeAll(): DropDown

getChildren

open fun getChildren(): List<<ERROR CLASS>>

remove

open fun remove(child: <ERROR CLASS>): DropDown

removeAll

open fun removeAll(): DropDown

removeAt

open fun removeAt(position: Int): DropDown

toggle

open fun toggle()

Toggles dropdown visibility.

Properties

autoClose

var autoClose: <ERROR CLASS>

The auto closing mode of the dropdown menu.

block

var block: <ERROR CLASS>

Determines if the dropdown button takes all the space horizontally.

button

val button: DropDownButton

dark

var dark: <ERROR CLASS>

Use dark background for the dropdown.

direction

var direction: <ERROR CLASS>

The direction of the dropdown.

disabled

var disabled: <ERROR CLASS>

Determines if the dropdown is disabled.

forDropDown

val forDropDown: Boolean = false

forNavbar

val forNavbar: Boolean = false

icon

var icon: <ERROR CLASS>

The icon of the dropdown button.

image

var image: <ERROR CLASS>

The image on the dropdown button.

size

var size: <ERROR CLASS>

The size of the dropdown button.

style

var style: <ERROR CLASS>

The style of the dropdown button.

text

var text: <ERROR CLASS>

Label of the dropdown button.

width

open var width: <ERROR CLASS>?

Width of the dropdown button.

Extensions

ddLink

fun DropDown.ddLink(label: String, url: String? = null, icon: String? = null, image: <ERROR CLASS>? = null, className: String? = null, init: <ERROR CLASS>.() -> Unit? = null): <ERROR CLASS>

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

ddLinkDisabled

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

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

header

fun DropDown.header(content: String? = null, className: String? = null): Header

DSL builder extension function.

separator

fun DropDown.separator(className: String? = null): Separator

DSL builder extension function.