Ktor 1.5.4 Help

HTML DSL

HTML DSL integrates the kotlinx.html library into Ktor and allows you to respond to a client with HTML blocks. With HTML DSL, you can write pure HTML in Kotlin, interpolate variables into views, and even build complex HTML layouts using templates.

Add dependencies

HTML DSL doesn't need installation but requires the ktor-html-builder artifact. You can include it in the build script as follows:

implementation "io.ktor:ktor-html-builder:$ktor_version"
implementation("io.ktor:ktor-html-builder:$ktor_version")
<dependency> <groupId>io.ktor</groupId> <artifactId>ktor-html-builder</artifactId> <version>${ktor_version}</version> </dependency>

Note that this artifact depends on kotlinx-html-jvm, which is placed on a Space Packages repository:

repositories { maven { url "https://maven.pkg.jetbrains.space/public/p/kotlinx-html/maven" } }
repositories { maven { url = uri("https://maven.pkg.jetbrains.space/public/p/kotlinx-html/maven") } }
<repositories> <repository> <id>kotlinx-html</id> <url>https://maven.pkg.jetbrains.space/public/p/kotlinx-html/maven</url> </repository> </repositories>

Send HTML in response

To send an HTML response, call the ApplicationCall.respondHtml method inside the required route:

get("/") { val name = "Ktor" call.respondHtml { head { title { +name } } body { h1 { +"Hello from $name!" } } } }

In this case, the following HTML will be sent to the client:

<head> <title>Ktor</title> </head> <body> <h1>Hello from Ktor!</h1> </body>

To learn more about generating HTML using kotlinx.html, see the kotlinx.html wiki.

Templates

In addition to generating plain HTML, Ktor provides a template engine that can be used to build complex layouts. You can create a hierarchy of templates for different parts of an HTML page, for example, a root template for the entire page, child templates for a page header and footer, and so on. Ktor exposes the following API for working with templates:

  1. To respond with an HTML built based on a specified template, call the ApplicationCall.respondHtmlTemplate method.

  2. To create a template, you need to implement the Template interface and override the Template.apply method providing HTML.

  3. Inside a created template class, you can define placeholders for different content types:
    • Placeholder is used to insert the content. PlaceholderList can be used to insert the content that appears multiple times (for example, list items).

    • TemplatePlaceholder can be used to insert child templates and create nested layouts.

Example

Let's see the example of how to create a hierarchical layout using templates. Imagine we have the following HTML:

<body> <h1>Ktor</h1> <article> <h2>Hello from Ktor!</h2> <p>Kotlin Framework for creating connected systems.</p> </article> </body>

We can split the layout of this page into two parts:

  • A root layout template for a page header and a child template for an article.

  • A child template for the article content.

Let's implement these layouts step-by-step:

  1. Call the respondHtmlTemplate method and pass a template class as a parameter. In our case, this is the LayoutTemplate class that should implement the Template interface:

get("/") { call.respondHtmlTemplate(LayoutTemplate()) { // ... } }

Inside the block, we will be able to access a template and specify its property values. These values will substitute placeholders specified in a template class. We'll create LayoutTemplate and define its properties in the next step.

  1. A root layout template will look in the following way:

class LayoutTemplate: Template<HTML> { val header = Placeholder<FlowContent>() val content = TemplatePlaceholder<ContentTemplate>() override fun HTML.apply() { body { h1 { insert(header) } insert(ContentTemplate(), content) } } }

The class exposes two properties:

  • The header property specifies a content inserted within the h1 tag.

  • The content property specifies a child template for article content.

  1. A child template will look as follows:

class ContentTemplate: Template<FlowContent> { val articleTitle = Placeholder<FlowContent>() val articleText = Placeholder<FlowContent>() override fun FlowContent.apply() { article { h2 { insert(articleTitle) } p { insert(articleText) } } } }

This template exposes the articleTitle and articleText properties, whose values will be inserted inside the article.

  1. Now we are ready to send HTML built using the specified property values:

get("/") { call.respondHtmlTemplate(LayoutTemplate()) { header { +"Ktor" } content { articleTitle { +"Hello from Ktor!" } articleText { +"Kotlin Framework for creating connected systems." } } } }
Last modified: 19 April 2021