Package io.micronaut.views.turbo

Class TurboStream

java.lang.Object

io.micronaut.views.turbo.TurboStream

All Implemented Interfaces:

Renderable

public final class TurboStream
extends Object
implements Renderable

Turbo Stream. Streams.

Since:

3.3.0

Author:

Sergio del Amo

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TurboStream.Builder	Turbo Stream Builder.

Method Summary

Modifier and Type	Method	Description
static @NonNull TurboStream.Builder	builder()
@NonNull TurboStreamAction	getAction()
boolean	getChildrenOnly()
Optional<String>	getRequestId()
@NonNull Optional<String>	getTargetCssQuerySelector()
@NonNull Optional<String>	getTargetDomId()
@NonNull Optional<Object>	getTemplate()
@NonNull Optional<io.micronaut.core.io.Writable>	render()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getAction

@NonNull
public @NonNull TurboStreamAction getAction()

Returns:

Turbo Stream Action.

getTargetDomId

@NonNull
public @NonNull Optional<String> getTargetDomId()

Returns:

Target DOM ID.

getTargetCssQuerySelector

@NonNull
public @NonNull Optional<String> getTargetCssQuerySelector()

Returns:

Target CSS Selector

getRequestId

public Optional<String> getRequestId()

Returns:

request-id attribute, only relevant when action=refresh

getChildrenOnly

public boolean getChildrenOnly()

Returns:

Morph only the children of the element designated by the target dom id.

getTemplate

@NonNull
public @NonNull Optional<Object> getTemplate()

Returns:

Template.

builder

@NonNull
public static @NonNull TurboStream.Builder builder()

Returns:

Creates a TurboStream Builder.

render

@NonNull
public @NonNull Optional<io.micronaut.core.io.Writable> render()

Specified by:

render in interface Renderable

Returns:

Renders a TurboStream as a Writable