ktor-server-html-builder/io.ktor.server.html

Package-level declarations

Types

class ~~HtmlContent~~(val status: HttpStatusCode? = null, builder: HTML.() -> Unit) : OutgoingContent.WriteChannelContent

Represents an OutgoingContent build using kotlinx.html.

Placeholder

open class Placeholder<TOuter>

A placeholder that is inserted inside TOuter.

PlaceholderItem

class PlaceholderItem<TOuter>(val index: Int, val collection: List<PlaceholderItem<TOuter>>) : Placeholder<TOuter>

An item of a PlaceholderList when it is expanded.

PlaceholderList

open class PlaceholderList<TOuter, TInner>

A placeholder that can be used to insert the content that appears multiple times (for example, list items).

Template

interface Template<in TOuter>

A template that expands inside TOuter.

TemplatePlaceholder

open class TemplatePlaceholder<TTemplate>

A placeholder that is also a Template. It can be used to insert child templates and create nested layouts.

Functions

each

fun <TOuter, TInner> TOuter.each(items: PlaceholderList<TOuter, TInner>, itemTemplate: TOuter.(PlaceholderItem<TInner>) -> Unit)

Inserts every element of PlaceholderList.

insert

fun <TOuter> TOuter.insert(placeholder: Placeholder<TOuter>)

Inserts Placeholder.

fun <TTemplate : Template<TOuter>, TOuter> TOuter.insert(template: TTemplate, placeholder: TemplatePlaceholder<TTemplate>)

fun <TOuter, TTemplate : Template<TOuter>> TOuter.insert(template: TTemplate, build: TTemplate.() -> Unit)

respondHtml

suspend fun ApplicationCall.respondHtml(status: HttpStatusCode = HttpStatusCode.OK, block: HTML.() -> Unit)

Responds to a client with an HTML response using the specified block to build an HTML page. You can learn more from HTML DSL.

respondHtmlFragment

suspend fun ApplicationCall.respondHtmlFragment(status: HttpStatusCode = HttpStatusCode.OK, block: FlowContent.() -> Unit)

Responds to a client with an HTML response using the specified block to build an HTML fragment. Unlike respondHtml, this function does not wrap the content in <!DOCTYPE html>, <html>, or <body> tags. This is useful for returning partial HTML content, such as HTMX responses. You can learn more from HTML DSL.

respondHtmlTemplate

suspend fun <TTemplate : Template<HTML>> ApplicationCall.respondHtmlTemplate(template: TTemplate, status: HttpStatusCode = HttpStatusCode.OK, body: TTemplate.() -> Unit)

Responds to a client with an HTML response built based on a specified template. You can learn more from HTML DSL.