Package io.kvision.dropdown

Bootstrap dropdown component with support for navigation bars and context menus.

Types

ContextMenu

open class ContextMenu(element: Widget?, fixedPosition: Boolean, classes: Set<String>, init: ContextMenu.() -> Unit?) : Div

Context menu component.

enum DD : Enum<DD>

Useful options for use in DropDown's elements parameter.

Direction

enum Direction : Enum<Direction>

Dropdown directions.

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.

DropDownButton

class DropDownButton(id: String, text: String, icon: String?, style: ButtonStyle, disabled: Boolean, forNavbar: Boolean, forDropDown: Boolean, classes: Set<String>) : Button

A drop down button component.

Header

open class Header(content: String?, classes: Set<String>) : Tag

Menu header component.

Separator

open class Separator(classes: Set<String>) : Div

Menu separator component.

Functions

cmLink

fun ContextMenu.cmLink(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 context menu list.

cmLinkDisabled

fun ContextMenu.cmLinkDisabled(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 context menu list.

contextMenu

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

DSL builder extension function.

fun <S> Widget.contextMenu(state: ObservableState<S>, fixedPosition: Boolean = false, classes: Set<String>? = null, className: String? = null, init: ContextMenu.(S) -> Unit): ContextMenu

DSL builder extension function for observable state.

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.

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

DSL builder extension function.

fun <S> Container.dropDown(state: ObservableState<S>, 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>? = null, className: String? = null, init: DropDown.(S) -> Unit): DropDown

DSL builder extension function for observable state.

header

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

DSL builder extension function.

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

DSL builder extension function.

separator

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

DSL builder extension function.

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

DSL builder extension function.

setContextMenu

fun Widget.setContextMenu(contextMenu: ContextMenu): Widget

Sets context menu for the current widget.