quarkdown-html/com.quarkdown.rendering.html/HtmlTagBuilder

HtmlTagBuilder

class HtmlTagBuilder(name: String, renderer: BaseHtmlNodeRenderer, pretty: Boolean) : TagBuilder

A builder of an HTML tag.

Example:

val builder = tagBuilder("html") {
    tag("head") {
        tag("meta")
            .attribute("charset", "UTF-8")
            .void(true)
    }
    tag("body") {
        +node.children
    }

Constructors

HtmlTagBuilder

constructor(name: String, renderer: BaseHtmlNodeRenderer, pretty: Boolean)

Properties

isEmpty

val isEmpty: Boolean

Functions

acceptEmpty

fun acceptEmpty(): HtmlTagBuilder

Adds a data-accept-empty attribute to this tag as a flag that this element is to keep even if it has no content. By default, empty elements, such as paragraphs without text, are hidden to avoid unwanted empty spaces.

append

open override fun append(content: CharSequence)

attribute

fun attribute(key: String, value: Any): HtmlTagBuilder

Adds an attribute to this tag.

build

open override fun build(): String

className

fun className(className: String?): HtmlTagBuilder

Applies a single class name via the class attribute to this tag.

classNames

fun classNames(vararg classNames: String?): HtmlTagBuilder

Applies a sequence of class names via the class attribute to this tag.

hidden

fun hidden(): HtmlTagBuilder

Adds a data-hidden attribute to this tag as a flag that this is a hidden element. A page that has either zero elements or only hidden elements is considered blank. This attribute is usually read by external stylesheets and scripts.

optionalAttribute