application/com.varabyte.kobweb.gradle.application.extensions/AppBlock/IndexBlock

IndexBlock

abstract class IndexBlock @Inject constructor(val basePath: BasePath) : ExtensionAware(source)

A sub-block for defining properties related to the "index.html" document generated by Kobweb

Constructors

Link copied to clipboard
@Inject
constructor(basePath: BasePath)

Types

Link copied to clipboard
abstract class InterceptUrlsBlock @Inject constructor : ExtensionAware

Configuration for intercepting URLs found inside a block.

Properties

Link copied to clipboard
@get:Internal
val basePath: BasePath
Link copied to clipboard
@get:Input
@get:Optional
abstract val description: Property<String>

The default description for the site.

Link copied to clipboard
@get:Input
abstract val excludeHtmlForDependencies: ListProperty<String>

A list of dependencies that should be excluded from generating html elements in the index.html file.

Link copied to clipboard
@get:Input
abstract val faviconPath: Property<String>

The path to use for the favicon for the site.

Link copied to clipboard
@get:Internal
abstract val head: ListProperty<HEAD.() -> Unit>

A list of element builders to add to the <head> of the generated index.html file.

Link copied to clipboard
Link copied to clipboard
@get:Input
@get:Optional
abstract val lang: Property<String>

The language code to set in the html tag.

Link copied to clipboard
@get:Internal
val routePrefix: BasePath
Link copied to clipboard
@get:Input
abstract val scriptAttributes: MapProperty<String, String>

A list of attribute key / value pairs to add to the script tag that imports your site.

Link copied to clipboard
@get:Input
abstract val suppressHtmlWarningsForDependencies: ListProperty<String>

A list of dependencies that you don't want the "excludeHtmlForDependencies" warning to show up for.

Functions

Link copied to clipboard
Link copied to clipboard
@Internal
abstract fun getExtensions(): ExtensionContainer