kvision / pl.treksoft.kvision.html / Image

Image

open class Image : Widget

Image component.

Constructors

Image(src: ResString, alt: String? = null, responsive: Boolean = false, shape: IMAGESHAPE? = null, centered: Boolean = false, classes: Set<String> = setOf())

Properties

alt	`var alt: String?` The alternative text of the image.
centered	`var centered: Boolean` Determines if the image is rendered as centered.
responsive	`var responsive: Boolean` Determines if the image is rendered as responsive.
shape	`var shape: IMAGESHAPE?` The shape of the image.
src	`var src: ResString` URL of the image.

Inherited Properties

id	`var id: String?` An ID attribute of generated HTML element.
parent	`open var parent: Component?` Parent of the current component.
role	`var role: String?` A role attribute of generated HTML element.
title	`var title: String?` A title attribute of generated HTML element.
visible	`open var visible: Boolean` Visibility state of the current component.

Functions

getSnAttrs	`open fun getSnAttrs(): List<StringPair>` Returns list of element attributes in the form of a List.
getSnClass	`open fun getSnClass(): List<StringBoolPair>` Returns list of CSS class names for current widget in the form of a List.
render	`open fun render(): VNode` Renders current component as a Snabbdom vnode.

Inherited Functions

addCssClass	`open fun addCssClass(css: String): Widget` Adds given value to the set of CSS classes generated in html code of current component.
addSurroundingCssClass	`open fun addSurroundingCssClass(css: String): Widget` Adds given value to the set of CSS classes generated in html code of parent component.
afterCreate	`open fun afterCreate(node: VNode): Unit` Method called after creating Snabbdom vnode.
afterDestroy	`open fun afterDestroy(): Unit` Method called after destroying Snabbdom vnode.
afterInsert	`open fun afterInsert(node: VNode): Unit` Method called after inserting Snabbdom vnode into the DOM.
afterPostpatch	`open fun afterPostpatch(node: VNode): Unit` Method called after updating Snabbdom vnode.
getElement	`open fun getElement(): Node?` Returns DOM element bound to the current component.
getElementJQuery	`open fun getElementJQuery(): JQuery?` Returns JQuery element bound to the current component.
getElementJQueryD	`open fun getElementJQueryD(): dynamic` Returns JQuery element bound to the current component as a dynamic type.
getSnHooks	`open fun getSnHooks(): Hooks?` Returns list of hooks in the form of a Snabbdom Hooks object.
getSnOn	`open fun getSnOn(): On?` Returns list of event handlers in the form of a Snabbdom On object.
hide	`open fun hide(): Widget` Makes current widget invisible.
removeCssClass	`open fun removeCssClass(css: String): Widget` Removes given value from the set of CSS classes generated in html code of current component.
removeEventListeners	`open fun removeEventListeners(): Widget` Removes all event listeners from current widget.
removeSurroundingCssClass	`open fun removeSurroundingCssClass(css: String): Widget` Removes given value from the set of CSS classes generated in html code of parent component.
render	`open fun render(elementName: String): VNode` `open fun render(elementName: String, children: Array<dynamic>): VNode` Renders current component as a Snabbdom vnode.
setEventListener	`open fun <T : Widget> setEventListener(block: SnOn<T>.() -> Unit): Widget` Sets an event listener for current widget, keeping the actual type of component. `open fun setEventListener(block: SnOn<Widget>.() -> Unit): Widget` Sets an event listener for current widget.
show	`open fun show(): Widget` Makes current widget visible.
toggleVisible	`open fun toggleVisible(): Widget` Toggles visibility of current widget.

Companion Object Functions

image

fun Container.image(src: ResString, alt: String? = null, responsive: Boolean = false, shape: IMAGESHAPE? = null, centered: Boolean = false, classes: Set<String> = setOf(), init: Image.() -> Unit = null): Unit

DSL builder extension function