DropDown

open class DropDown(text: String, elements: List<StringPair>?, icon: String?, style: ButtonStyle, direction: Direction, disabled: Boolean, forNavbar: Boolean, forDropDown: Boolean, classes: Set<String>, init: DropDown.() -> Unit?) : SimplePanel

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

classes

a set of CSS class names

init

an initializer extension function

Constructors

DropDown

fun 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, classes: Set<String> = setOf(), init: DropDown.() -> Unit? = null)

Types

Companion

object Companion

Functions

add

open override fun add(child: Component): DropDown

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

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>): DropDown

addBeforeDisposeHook

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

addCssClass

open override fun addCssClass(css: String): Widget

addCssStyle

open override fun addCssStyle(css: Style): Widget

addSurroundingCssClass

open override fun addSurroundingCssClass(css: String): Widget

addSurroundingCssStyle

open override fun addSurroundingCssStyle(css: Style): Widget

animate

open fun animate(duration: Int, easing: Easing, complete: () -> Unit?, styles: StyledComponent.() -> Unit)

blur

open fun blur()

buttonId

fun buttonId(): String?

clearDragDropData

open fun clearDragDropData()

clearParent

open override fun clearParent(): Widget

disablePopover

open fun disablePopover(): Widget

disableTooltip

open fun disableTooltip(): Widget

dispose

open override fun dispose()

disposeAll

open override fun disposeAll(): DropDown

enablePopover

open fun enablePopover(options: PopoverOptions): Widget

enableTooltip

open fun enableTooltip(options: TooltipOptions): Widget

fadeIn

open fun fadeIn(duration: Int, easing: Easing, complete: () -> Unit?): Widget

fadeOut

open fun fadeOut(duration: Int, easing: Easing, complete: () -> Unit?): 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(): Node?

getElementJQuery

open override fun getElementJQuery(): JQuery?

getElementJQueryD

open override fun getElementJQueryD(): dynamic

getRoot

open override fun getRoot(): Root?

getSnStyle

open fun getSnStyle(): List<StringPair>

getStyle

fun getStyle(name: String): String?

hasCssClass

open override fun hasCssClass(css: String): Boolean

hide

open fun hide(): Widget

hideAnim

open fun hideAnim(duration: Int, easing: Easing, complete: () -> Unit?): Widget

hidePopover

open fun hidePopover(): Widget

hideTooltip

open fun hideTooltip(): Widget

invoke

open operator fun invoke(vararg children: Component): Container

refresh

open override fun refresh(): Widget

remove

open override fun remove(child: Component): DropDown

removeAll

open override fun removeAll(): DropDown

removeAt

open override fun removeAt(position: Int): DropDown

removeAttribute

open override fun removeAttribute(name: String): Widget

removeCssClass

open override fun removeCssClass(css: String): Widget

removeCssStyle

open override fun removeCssStyle(css: Style): Widget

removeEventListener

open fun removeEventListener(id: Int): Widget

removeEventListeners

open fun removeEventListeners(): Widget

removeStyle

fun removeStyle(name: String): StyledComponent

removeSurroundingCssClass

open override fun removeSurroundingCssClass(css: String): Widget

removeSurroundingCssStyle

open override fun removeSurroundingCssStyle(css: Style): Widget

renderVNode

open override fun renderVNode(): VNode

setAttribute

open override fun setAttribute(name: String, value: String): 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): StyledComponent

show

open fun show(): Widget

showAnim

open fun showAnim(duration: Int, easing: Easing, complete: () -> Unit?): Widget

showPopover

open fun showPopover(): Widget

showTooltip

open fun showTooltip(): Widget

singleRender

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

singleRenderAsync

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

slideDown

open fun slideDown(duration: Int, easing: Easing, complete: () -> Unit?): Widget

slideUp

open fun slideUp(duration: Int, easing: Easing, complete: () -> Unit?): Widget

toggle

open fun toggle()

Toggles dropdown visibility.

toggleVisible

open fun toggleVisible(): Widget

unaryPlus

open operator fun String.unaryPlus()

Properties

alignContent

open var alignContent: AlignContent?

alignItems

open var alignItems: AlignItems?

alignSelf

open var alignSelf: AlignItems?

background

open var background: Background?

block

var block: Boolean

Determines if the dropdown button takes all the space horizontally.

border

open var border: Border?

borderBottom

open var borderBottom: Border?

borderLeft

open var borderLeft: Border?

borderRight

open var borderRight: Border?

borderTop

open var borderTop: Border?

bottom

open var bottom: CssSize?

button

val button: DropDownButton

clear

open var clear: Clear?

color

open var color: Color?

colorHex

open var colorHex: Int?

colorName

open var colorName: Col?

cursor

open var cursor: Cursor?

direction

var direction: Direction

The direction of the dropdown.

disabled

var disabled: Boolean

Determines if the dropdown is disabled.

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?

forDropDown

val forDropDown: Boolean = false

determines if the component will be used in a dropdown

forNavbar

val forNavbar: Boolean = false

determines if the component will be used in a navbar

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?

height

open var height: CssSize?

icon

var icon: String?

The icon of the dropdown button.

var id: String?

image

var image: String?

The image on the dropdown button.

justifyContent

open var justifyContent: JustifyContent?

justifyItems

open var justifyItems: JustifyItems?

justifySelf

open var justifySelf: JustifyItems?

left

open var left: CssSize?

letterSpacing

open var letterSpacing: CssSize?

lineBreak

open var lineBreak: LineBreak?

lineHeight

open var lineHeight: CssSize?

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?

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?

position

open var position: Position?

resize

open var resize: Resize?

right

open var right: CssSize?

role

var role: String?

size

var size: ButtonSize?

The size of the dropdown button.

style

var style: ButtonStyle

The style of the dropdown button.

tabindex

var tabindex: Int?

text

var text: String

Label of the dropdown button.

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?

top

open var top: CssSize?

unicodeBidi

open var unicodeBidi: UnicodeBidi?

verticalAlign

open var verticalAlign: VerticalAlign?

visible

open override var visible: Boolean

whiteSpace

open var whiteSpace: WhiteSpace?

width

open override var width: CssSize?

Width of the dropdown button.

wordBreak

open var wordBreak: WordBreak?

wordSpacing

open var wordSpacing: CssSize?

zIndex

open var zIndex: Int?

Extensions

ddLink

fun DropDown.ddLink(label: String, url: String? = null, icon: String? = null, image: ResString? = null, classes: Set<String>? = null, className: String? = null, init: Link.() -> Unit? = null): Link

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

ddLinkDisabled

fun DropDown.ddLinkDisabled(label: String, icon: String? = null, image: ResString? = null, classes: Set<String>? = null, className: String? = null, init: Link.() -> Unit? = null): Link

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

header

fun DropDown.header(content: String? = null, classes: Set<String>? = null, className: String? = null): Header

DSL builder extension function.

separator

fun DropDown.separator(classes: Set<String>? = null, className: String? = null): Separator

DSL builder extension function.