kvision/io.kvision.html

Package-level declarations

Components supporting complete set of HTML tags, with dedicated classes for buttons, images, links, lists and iframe. Support for Handlebars.js templates is included.

Types

Link copied to clipboard
open class Address(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Address.() -> Unit? = null) : Tag

Simple component rendered as address.

Link copied to clipboard
enum Align : Enum<Align> , CssClass

CSS align attributes.

Link copied to clipboard
open class Article(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Article.() -> Unit? = null) : Tag

Simple component rendered as article.

Link copied to clipboard
enum Autocomplete : Enum<Autocomplete>

Input types.

Link copied to clipboard
open class B(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: B.() -> Unit? = null) : Tag

Simple component rendered as b.

Link copied to clipboard
open class Br(className: String? = null, init: Br.() -> Unit? = null) : Tag

Simple component rendered as br.

Link copied to clipboard
open class Button(text: String, icon: String? = null, style: ButtonStyle = ButtonStyle.PRIMARY, type: ButtonType = ButtonType.BUTTON, disabled: Boolean = false, separator: String? = null, labelFirst: Boolean = true, className: String? = null, init: Button.() -> Unit? = null) : SimplePanel

Button component.

Link copied to clipboard
enum ButtonSize : Enum<ButtonSize> , CssClass

Button sizes.

Link copied to clipboard
enum ButtonStyle : Enum<ButtonStyle> , CssClass

Button styles.

Link copied to clipboard
enum ButtonType : Enum<ButtonType>

Button types.

Link copied to clipboard
open class Canvas(canvasWidth: Int? = null, canvasHeight: Int? = null, className: String? = null, init: Canvas.() -> Unit? = null) : Widget

Canvas component.

Link copied to clipboard
open class Code(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Code.() -> Unit? = null) : Tag

Simple component rendered as code.

Link copied to clipboard
open class CustomTag(elementName: String, content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, attributes: Map<String, String>? = null, init: CustomTag.() -> Unit? = null) : Tag

HTML custom tag component.

Link copied to clipboard
open class Div(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Div.() -> Unit? = null) : Tag

Simple component rendered as div.

Link copied to clipboard
open class Em(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Em.() -> Unit? = null) : Tag

Simple component rendered as em.

Link copied to clipboard
open class Fieldset(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Fieldset.() -> Unit? = null) : Tag

Simple component rendered as fieldset.

Link copied to clipboard
open class Figcaption(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Figcaption.() -> Unit? = null) : Tag

Simple component rendered as figcaption.

Link copied to clipboard
open class Figure(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Figure.() -> Unit? = null) : Tag

Simple component rendered as figure.

Link copied to clipboard
open class Footer(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Footer.() -> Unit? = null) : Tag

Simple component rendered as footer.

Link copied to clipboard
open class H1(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: H1.() -> Unit? = null) : Tag

Simple component rendered as h1.

Link copied to clipboard
open class H2(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: H2.() -> Unit? = null) : Tag

Simple component rendered as h2.

Link copied to clipboard
open class H3(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: H3.() -> Unit? = null) : Tag

Simple component rendered as h3.

Link copied to clipboard
open class H4(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: H4.() -> Unit? = null) : Tag

Simple component rendered as h4.

Link copied to clipboard
open class H5(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: H5.() -> Unit? = null) : Tag

Simple component rendered as h5.

Link copied to clipboard
open class H6(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: H6.() -> Unit? = null) : Tag

Simple component rendered as h6.

Link copied to clipboard
open class Header(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Header.() -> Unit? = null) : Tag

Simple component rendered as header.

Link copied to clipboard
open class I(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: I.() -> Unit? = null) : Tag

Simple component rendered as i.

Link copied to clipboard
open class Icon(icon: String, init: Icon.() -> Unit? = null) : Tag

Icon component with support for FontAwesome and Bootstrap glyphicons.

Link copied to clipboard
open class Iframe(src: String? = null, srcdoc: String? = null, name: String? = null, iframeWidth: Int? = null, iframeHeight: Int? = null, sandbox: Set<Sandbox>? = null, className: String? = null) : Widget

Iframe component.

Link copied to clipboard
open class Image(src: ResString?, alt: String? = null, responsive: Boolean = false, shape: ImageShape? = null, centered: Boolean = false, className: String? = null, init: Image.() -> Unit? = null) : Widget

Image component.

Link copied to clipboard
enum ImageShape : Enum<ImageShape> , CssClass

Image shapes.

Link copied to clipboard
open class Input(type: InputType? = null, className: String? = null, init: Input.() -> Unit? = null) : Widget

Generic input element.

Link copied to clipboard
enum InputType : Enum<InputType>

Input types.

Link copied to clipboard
open class Label(content: String? = null, rich: Boolean = false, forId: String? = null, className: String? = null, init: Label.() -> Unit? = null) : Tag

Simple component rendered as label.

Link copied to clipboard
open class Li(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Li.() -> Unit? = null) : Tag

Simple component rendered as li.

Link copied to clipboard
open class Link(label: String, url: String? = null, icon: String? = null, image: ResString? = null, separator: String? = null, labelFirst: Boolean = true, target: String? = null, dataNavigo: Boolean? = null, className: String? = null, init: Link.() -> Unit? = null) : SimplePanel

Link component.

Link copied to clipboard
open class ListTag(type: ListType, elements: List<String>? = null, rich: Boolean = false, className: String? = null, init: ListTag.() -> Unit? = null) : SimplePanel

HTML list component.

Link copied to clipboard
enum ListType : Enum<ListType>

HTML list types.

Link copied to clipboard
open class Main(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Main.() -> Unit? = null) : Tag

Simple component rendered as main.

Link copied to clipboard
open class Nav(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Nav.() -> Unit? = null) : Tag

Simple component rendered as nav.

Link copied to clipboard
open class Ol(elements: List<String>? = null, rich: Boolean = false, className: String? = null, init: Ol.() -> Unit? = null) : ListTag

Simple component rendered as ol.

Link copied to clipboard
open class P(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: P.() -> Unit? = null) : Tag

Simple component rendered as p.

Link copied to clipboard
enum Sandbox : Enum<Sandbox>

Iframe sandbox options.

Link copied to clipboard
open class Section(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Section.() -> Unit? = null) : Tag

Simple component rendered as section.

Link copied to clipboard
open class Small(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Small.() -> Unit? = null) : Tag

Simple component rendered as small.

Link copied to clipboard
open class Span(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Span.() -> Unit? = null) : Tag

Simple component rendered as span.

Link copied to clipboard
open class Strong(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Strong.() -> Unit? = null) : Tag

Simple component rendered as strong.

Link copied to clipboard
open class Table(className: String? = null, init: Table.() -> Unit? = null) : Tag

Simple component rendered as table.

Link copied to clipboard
enum TAG : Enum<TAG>

HTML tags.

Link copied to clipboard
open class Tag(type: TAG, content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, attributes: Map<String, String>? = null, init: Tag.() -> Unit? = null) : SimplePanel, Template

HTML tag component.

Link copied to clipboard
@DslMarker
annotation class TagMarker
Link copied to clipboard
open class Tbody(className: String? = null, init: Tbody.() -> Unit? = null) : Tag

Simple component rendered as tbody.

Link copied to clipboard
open class Td(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Td.() -> Unit? = null) : Tag

Simple component rendered as td.

Link copied to clipboard
interface Template

Handlebars templates helper interface.

Link copied to clipboard
open class TextNode(content: String, rich: Boolean = false, init: TextNode.() -> Unit? = null) : Widget

Simple component for rendering text DOM node.

Link copied to clipboard
open class Th(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Th.() -> Unit? = null) : Tag

Simple component rendered as th.

Link copied to clipboard
open class Thead(className: String? = null, init: Thead.() -> Unit? = null) : Tag

Simple component rendered as thead.

Link copied to clipboard
open class Time(datetime: String, content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Time.() -> Unit? = null) : Tag

Simple component rendered as time.

Link copied to clipboard
open class Tr(className: String? = null, init: Tr.() -> Unit? = null) : Tag

Simple component rendered as tr.

Link copied to clipboard
open class Ul(elements: List<String>? = null, rich: Boolean = false, className: String? = null, init: Ul.() -> Unit? = null) : ListTag

Simple component rendered as ul.

Functions

Link copied to clipboard
fun Container.address(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Address.() -> Unit? = null): Address

DSL builder extension function.

Link copied to clipboard
fun Container.article(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Article.() -> Unit? = null): Article

DSL builder extension function.

Link copied to clipboard
fun Container.b(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: B.() -> Unit? = null): B

DSL builder extension function.

Link copied to clipboard
fun Container.br(className: String? = null, init: Br.() -> Unit? = null): Br

DSL builder extension function.

Link copied to clipboard
fun Container.button(text: String, icon: String? = null, style: ButtonStyle = ButtonStyle.PRIMARY, type: ButtonType = ButtonType.BUTTON, disabled: Boolean = false, separator: String? = null, labelFirst: Boolean = true, className: String? = null, init: Button.() -> Unit? = null): Button

DSL builder extension function.

Link copied to clipboard
fun Container.canvas(canvasWidth: Int? = null, canvasHeight: Int? = null, className: String? = null, init: Canvas.() -> Unit? = null): Canvas

DSL builder extension function.

Link copied to clipboard
fun Container.code(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Code.() -> Unit? = null): Code

DSL builder extension function.

Link copied to clipboard
fun Container.customTag(elementName: String, content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, attributes: Map<String, String>? = null, init: CustomTag.() -> Unit? = null): CustomTag

DSL builder extension function.

Link copied to clipboard
fun Container.div(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Div.() -> Unit? = null): Div

DSL builder extension function.

Link copied to clipboard
fun Container.em(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Em.() -> Unit? = null): Em

DSL builder extension function.

Link copied to clipboard
fun Container.fieldset(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Fieldset.() -> Unit? = null): Fieldset

DSL builder extension function.

Link copied to clipboard
fun Container.figcaption(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Figcaption.() -> Unit? = null): Figcaption

DSL builder extension function.

Link copied to clipboard
fun Container.figure(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Figure.() -> Unit? = null): Figure

DSL builder extension function.

Link copied to clipboard
fun Container.footer(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Footer.() -> Unit? = null): Footer

DSL builder extension function.

Link copied to clipboard
fun Container.h1(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: H1.() -> Unit? = null): H1

DSL builder extension function.

Link copied to clipboard
fun Container.h2(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: H2.() -> Unit? = null): H2

DSL builder extension function.

Link copied to clipboard
fun Container.h3(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: H3.() -> Unit? = null): H3

DSL builder extension function.

Link copied to clipboard
fun Container.h4(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: H4.() -> Unit? = null): H4

DSL builder extension function.

Link copied to clipboard
fun Container.h5(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: H5.() -> Unit? = null): H5

DSL builder extension function.

Link copied to clipboard
fun Container.h6(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: H6.() -> Unit? = null): H6

DSL builder extension function.

Link copied to clipboard
fun Container.header(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Header.() -> Unit? = null): Header

DSL builder extension function.

Link copied to clipboard
fun Container.i(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: I.() -> Unit? = null): I

DSL builder extension function.

Link copied to clipboard
fun Container.icon(icon: String, init: Icon.() -> Unit? = null): Icon

DSL builder extension function.

Link copied to clipboard
fun Container.iframe(src: String? = null, srcdoc: String? = null, name: String? = null, iframeWidth: Int? = null, iframeHeight: Int? = null, sandbox: Set<Sandbox>? = null, className: String? = null, init: Iframe.() -> Unit? = null): Iframe

DSL builder extension function.

Link copied to clipboard
fun Container.image(src: ResString?, alt: String? = null, responsive: Boolean = false, shape: ImageShape? = null, centered: Boolean = false, className: String? = null, init: Image.() -> Unit? = null): Image

DSL builder extension function.

Link copied to clipboard
fun Container.input(type: InputType? = null, className: String? = null, init: Input.() -> Unit? = null): Input

DSL builder extension function.

Link copied to clipboard
fun Container.label(content: String? = null, rich: Boolean = false, forId: String? = null, className: String? = null, init: Label.() -> Unit? = null): Label

DSL builder extension function.

Link copied to clipboard
fun Container.li(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Li.() -> Unit? = null): Li

DSL builder extension function.

Link copied to clipboard
fun Container.link(label: String, url: String? = null, icon: String? = null, image: ResString? = null, separator: String? = null, labelFirst: Boolean = true, target: String? = null, dataNavigo: Boolean? = null, className: String? = null, init: Link.() -> Unit? = null): Link

DSL builder extension function.

Link copied to clipboard
fun Container.listTag(type: ListType, elements: List<String>? = null, rich: Boolean = false, className: String? = null, init: ListTag.() -> Unit? = null): ListTag

DSL builder extension function.

Link copied to clipboard
fun Container.main(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Main.() -> Unit? = null): Main

DSL builder extension function.

Link copied to clipboard
fun Container.nav(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Nav.() -> Unit? = null): Nav

DSL builder extension function.

Link copied to clipboard
fun Container.ol(elements: List<String>? = null, rich: Boolean = false, className: String? = null, init: Ol.() -> Unit? = null): Ol

DSL builder extension function.

Link copied to clipboard
fun Container.p(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: P.() -> Unit? = null): P

DSL builder extension function.

Link copied to clipboard
fun Container.section(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Section.() -> Unit? = null): Section

DSL builder extension function.

Link copied to clipboard
inline fun <K : Any> Template.setData(obj: K)
fun <K> Template.setData(obj: K, serializer: <Error class: unknown class><K>)

Extension function to set serializable object as a template data.

Link copied to clipboard
fun Container.small(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Small.() -> Unit? = null): Small

DSL builder extension function.

Link copied to clipboard
fun Container.span(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Span.() -> Unit? = null): Span

DSL builder extension function.

Link copied to clipboard
fun Container.strong(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Strong.() -> Unit? = null): Strong

DSL builder extension function.

Link copied to clipboard
fun Container.table(className: String? = null, init: Table.() -> Unit? = null): Table

DSL builder extension function.

Link copied to clipboard
fun Container.tag(type: TAG, content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, attributes: Map<String, String>? = null, init: Tag.() -> Unit? = null): Tag

DSL builder extension function.

Link copied to clipboard
fun Table.tbody(className: String? = null, init: Tbody.() -> Unit? = null): Tbody

DSL builder extension function.

Link copied to clipboard
fun Tr.td(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Td.() -> Unit? = null): Td

DSL builder extension function.

Link copied to clipboard
fun Container.textNode(content: String, rich: Boolean = false, init: TextNode.() -> Unit? = null): TextNode

DSL builder extension function.

Link copied to clipboard
fun Tr.th(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Th.() -> Unit? = null): Th

DSL builder extension function.

Link copied to clipboard
fun Table.thead(className: String? = null, init: Thead.() -> Unit? = null): Thead

DSL builder extension function.

Link copied to clipboard
fun Container.time(datetime: String, content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Time.() -> Unit? = null): Time

DSL builder extension function.

Link copied to clipboard
fun Container.tr(className: String? = null, init: Tr.() -> Unit? = null): Tr

DSL builder extension function.

Link copied to clipboard
fun Container.ul(elements: List<String>? = null, rich: Boolean = false, className: String? = null, init: Ul.() -> Unit? = null): Ul

DSL builder extension function.