kvision-material/io.kvision.material.iconbutton/MdIconButton

MdIconButton

open class MdIconButton : MdFormLabelWidget<String?> , HasIconSlot, HasSelectedSlot(source)

Icon buttons help people take supplementary actions with a single tap.

Standard icon buttons do not have a background or outline, and have the lowest emphasis of the icon buttons.

See https://material-web.dev/components/icon-button/

Author

Maanrifa Bacar Ali

Inheritors

Constructors

Link copied to clipboard
constructor(disabled: Boolean = false, flipIconInRtl: Boolean = false, href: String? = null, target: LinkTarget? = null, ariaLabelSelected: String? = null, toggle: Boolean = false, selected: Boolean = false, type: IconButtonType = IconButtonType.Submit, value: String? = null, name: String? = null, className: String? = null, init: MdIconButton.() -> Unit? = null)

Standard icon button constructor.

Properties

Link copied to clipboard
Link copied to clipboard
open var alignItems: AlignItems?
Link copied to clipboard
open var alignSelf: AlignItems?
Link copied to clipboard
var ariaLabelSelected: String?

The aria-label of the button when the button is toggleable and selected.

Link copied to clipboard
open var background: Background?
Link copied to clipboard
open var border: Border?
Link copied to clipboard
open var borderBottom: Border?
Link copied to clipboard
open var borderLeft: Border?
Link copied to clipboard
open var borderRadius: CssSize?
Link copied to clipboard
Link copied to clipboard
open var borderRight: Border?
Link copied to clipboard
open var borderTop: Border?
Link copied to clipboard
open var bottom: CssSize?
Link copied to clipboard
open var boxShadow: BoxShadow?
Link copied to clipboard
Link copied to clipboard
open var clear: Clear?
Link copied to clipboard
open var color: Color?
Link copied to clipboard
open var colorHex: Int?
Link copied to clipboard
open var colorName: Col?
Link copied to clipboard
open var cursor: Cursor?
Link copied to clipboard
var disabled: Boolean

Whether or not the widget is disabled.

Link copied to clipboard
open var display: Display?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open var flexBasis: CssSize?
Link copied to clipboard
Link copied to clipboard
open var flexGrow: Int?
Link copied to clipboard
open var flexShrink: Int?
Link copied to clipboard
open var flexWrap: FlexWrap?
Link copied to clipboard
var flipIconInRtl: Boolean

Flips the icon if it is in an RTL context at startup.

Link copied to clipboard
open var float: PosFloat?
Link copied to clipboard
open var fontFamily: String?
Link copied to clipboard
open var fontSize: CssSize?
Link copied to clipboard
open var fontStyle: FontStyle?
Link copied to clipboard
Link copied to clipboard
open var fontWeight: FontWeight?
Link copied to clipboard
val form: HTMLFormElement?

The associated form element with which this element's value will submit.

Link copied to clipboard
open var gridArea: String?
Link copied to clipboard
open var gridAutoColumns: String?
Link copied to clipboard
Link copied to clipboard
open var gridAutoRows: String?
Link copied to clipboard
open var gridColumnEnd: String?
Link copied to clipboard
open var gridColumnGap: Int?
Link copied to clipboard
open var gridColumnStart: Int?
Link copied to clipboard
open var gridRowEnd: String?
Link copied to clipboard
open var gridRowGap: Int?
Link copied to clipboard
open var gridRowStart: Int?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open var height: CssSize?
Link copied to clipboard
var href: String?

The URL that the link iconButton points to.

Link copied to clipboard
var id: String?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
var kvscope: dynamic
Link copied to clipboard
val labels: NodeList?

The labels this element is associated with.

Link copied to clipboard
open var left: CssSize?
Link copied to clipboard
open var letterSpacing: CssSize?
Link copied to clipboard
open var lineBreak: LineBreak?
Link copied to clipboard
open var lineHeight: CssSize?
Link copied to clipboard
open var listStyle: ListStyle?
Link copied to clipboard
open var margin: CssSize?
Link copied to clipboard
open var marginBottom: CssSize?
Link copied to clipboard
open var marginLeft: CssSize?
Link copied to clipboard
open var marginRight: CssSize?
Link copied to clipboard
open var marginTop: CssSize?
Link copied to clipboard
open var maxHeight: CssSize?
Link copied to clipboard
open var maxWidth: CssSize?
Link copied to clipboard
open var minHeight: CssSize?
Link copied to clipboard
open var minWidth: CssSize?
Link copied to clipboard
var name: String?

The name to use in form submission.

Link copied to clipboard
open var opacity: Double?
Link copied to clipboard
open var order: Int?
Link copied to clipboard
open var outline: Outline?
Link copied to clipboard
open var overflow: Overflow?
Link copied to clipboard
Link copied to clipboard
open var overflowX: Overflow?
Link copied to clipboard
open var overflowY: Overflow?
Link copied to clipboard
open var padding: CssSize?
Link copied to clipboard
open var paddingBottom: CssSize?
Link copied to clipboard
open var paddingLeft: CssSize?
Link copied to clipboard
open var paddingRight: CssSize?
Link copied to clipboard
open var paddingTop: CssSize?
Link copied to clipboard
open override var parent: Container?
Link copied to clipboard
Link copied to clipboard
var popoverOptions: dynamic
Link copied to clipboard
open var position: Position?
Link copied to clipboard
open var resize: Resize?
Link copied to clipboard
open var right: CssSize?
Link copied to clipboard
var role: String?
Link copied to clipboard
var selected: Boolean

Sets the selected state. When false, displays the default icon. When true, displays the selected icon, or the default icon if no slot="selected" icon is provided.

Link copied to clipboard
var tabindex: Int?
Link copied to clipboard
var target: LinkTarget?

Where to display the linked href URL for a link iconButton. Common options include _blank to open in a new tab.

Link copied to clipboard
open var textAlign: TextAlign?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open var textIndent: CssSize?
Link copied to clipboard
Link copied to clipboard
open var textShadow: TextShadow?
Link copied to clipboard
Link copied to clipboard
var title: String?
Link copied to clipboard
var toggle: Boolean

When true, the button will toggle between selected and unselected states.

Link copied to clipboard
Link copied to clipboard
var tooltipOptions: dynamic
Link copied to clipboard
open var top: CssSize?
Link copied to clipboard
open var transition: Transition?
Link copied to clipboard
Link copied to clipboard
var type: IconButtonType

Button type.

Link copied to clipboard
Link copied to clipboard
var value: String?

The value that is submitted to the form.

Link copied to clipboard
Link copied to clipboard
open override var visible: Boolean
Link copied to clipboard
open var whiteSpace: WhiteSpace?
Link copied to clipboard
open var width: CssSize?
Link copied to clipboard
open var wordBreak: WordBreak?
Link copied to clipboard
open var wordSpacing: CssSize?
Link copied to clipboard
open var zIndex: Int?

Functions

Link copied to clipboard
open override fun addAfterCreateHook(hook: (VNode) -> Unit): Boolean
Link copied to clipboard
open override fun addAfterDestroyHook(hook: () -> Unit): Boolean
Link copied to clipboard
open override fun addAfterInsertHook(hook: (VNode) -> Unit): Boolean
Link copied to clipboard
open override fun addBeforeDisposeHook(hook: () -> Unit): Boolean
Link copied to clipboard
open override fun addCssClass(css: String)
Link copied to clipboard
open override fun addCssStyle(css: Style)
Link copied to clipboard
open override fun addSurroundingCssClass(css: String)
Link copied to clipboard
open override fun addSurroundingCssStyle(css: Style)
Link copied to clipboard
open fun blur()
Link copied to clipboard
open override fun clearAfterCreateHooks()
Link copied to clipboard
open override fun clearAfterDestroyHooks()
Link copied to clipboard
open override fun clearAfterInsertHooks()
Link copied to clipboard
open override fun clearBeforeDisposeHooks()
Link copied to clipboard
open fun clearDragDropData()
Link copied to clipboard
open override fun clearParent()
Link copied to clipboard
open fun dispatchEvent(type: String, eventInitDict: CustomEventInit): Boolean?
Link copied to clipboard
open override fun dispose()
Link copied to clipboard
open fun focus()
Link copied to clipboard
open override fun getAttribute(name: String): String?
Link copied to clipboard
open override fun getElement(): HTMLElement?
Link copied to clipboard
open override fun getElementD(): dynamic
Link copied to clipboard
open override fun getRoot(): Root?
Link copied to clipboard
open fun getSnStyle(): dynamic
Link copied to clipboard
fun getStyle(name: String): String?
Link copied to clipboard
open override fun hasCssClass(css: String): Boolean
Link copied to clipboard
open fun hide()
Link copied to clipboard
open override fun icon(component: Component?)
Link copied to clipboard
fun HasIconSlot.icon(name: String): MdIcon

Sets the icon identified by name to the icon slot.

Link copied to clipboard
open override fun refresh()
Link copied to clipboard
open override fun removeAfterCreateHook(hook: (VNode) -> Unit): Boolean
Link copied to clipboard
open override fun removeAfterDestroyHook(hook: () -> Unit): Boolean
Link copied to clipboard
open override fun removeAfterInsertHook(hook: (VNode) -> Unit): Boolean
Link copied to clipboard
open override fun removeAttribute(name: String)
Link copied to clipboard
open override fun removeBeforeDisposeHook(hook: () -> Unit): Boolean
Link copied to clipboard
open override fun removeCssClass(css: String)
Link copied to clipboard
open override fun removeCssStyle(css: Style)
Link copied to clipboard
open fun removeEventListener(id: Int)
Link copied to clipboard
Link copied to clipboard
fun removeStyle(name: String)
Link copied to clipboard
open override fun removeSurroundingCssClass(css: String)
Link copied to clipboard
open override fun removeSurroundingCssStyle(css: Style)
Link copied to clipboard
open override fun renderVNode(): VNode
Link copied to clipboard
open override fun selected(component: Component?)
Link copied to clipboard
fun HasSelectedSlot.selectedIcon(name: String): MdIcon

Sets the icon identified by name to the selected slot.

Link copied to clipboard
open override fun setAttribute(name: String, value: String)
Link copied to clipboard
open fun setDragDropData(format: String, data: String)
Link copied to clipboard
open fun setDropTarget(format: String, callback: (DragEvent) -> Unit)
open fun setDropTarget(formats: Set<String>?, callback: (DragEvent) -> Unit)
Link copied to clipboard
open fun setDropTargetData(format: String, callback: (String?) -> Unit)
Link copied to clipboard
open fun <T : Widget> setEventListener(block: SnOn<T>.() -> Unit): Int
Link copied to clipboard
fun setStyle(name: String, value: String)
Link copied to clipboard
open fun show()
Link copied to clipboard
open override fun <T> singleRender(block: () -> T): T
Link copied to clipboard
open override fun singleRenderAsync(block: () -> Unit)
Link copied to clipboard
open fun toggleVisible()
Link copied to clipboard
open fun translate(text: String): String
open fun translate(text: String?): String?
Link copied to clipboard