0.23.0

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

ExportBlock

abstract class ExportBlock @Inject constructor(kobwebFolder: KobwebFolder)(source)

A sub-block for defining properties related to configuring the kobweb export step.

Constructors

@Inject

constructor(kobwebFolder: KobwebFolder)

Types

ExportFilterContext

class ExportFilterContext(val route: String)

class TraceConfig(val root: Path, val filter: (String) -> Boolean, val includeScreenshots: Boolean)

Configuration values for taking a trace at the export step.

Properties

abstract val browser: Property<Browser>

Which browser to use for the export step.

abstract val filter: Property<AppBlock.ExportBlock.ExportFilterContext.() -> Boolean>

A filter which, if set, will be invoked for every page to test if it should be exported.

includeSourceMap

abstract val includeSourceMap: Property<Boolean>

Whether to include a source map when exporting your site.

suppressLayoutWarning

abstract val suppressLayoutWarning: Property<Boolean>

If true, hide the warning shown about using an incorrect export layout.

suppressNoRootWarning

abstract val suppressNoRootWarning: Property<Boolean>

If true, hide the warning shown the projects that don't define a root route.

abstract val timeout: Property<Duration>

The max timeout to allow for each export.

Functions

fun addExtraRoute(route: String, exportPath: String? = null)

Add a route to export on top of what's normally discovered.

fun enableTraces(tracesRoot: Path = kobwebFolder.path.resolve("export-traces"), filter: (String) -> Boolean = { true }, showScreenshots: Boolean = true)

Enable traces for your export.