Package org.springframework.web.reactive.result.view

Interface FragmentsRendering

public interface FragmentsRendering

Public API to render HTML fragments. A fragment is a portion of an HTML page. Normally HTML is rendered with a single model and view. This API allows using multiple model and view pairs, one for each HTML fragment.

For use with frontends technologies such as htmx where multiple page fragments may be rendered in one response.

Supported as a return value from annotated controller methods. For full page rendering with a single model and view, use Rendering.

Since:

6.2

Author:

Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	FragmentsRendering.Builder	Defines a builder for FragmentsRendering.

Method Summary

Modifier and Type	Method	Description
static FragmentsRendering.Builder	fragment(String viewName)	Create a builder with one HTML fragment, also inheriting attributes from the shared model for the request.
static FragmentsRendering.Builder	fragment(String viewName, Map<String,Object> model)	Create a builder with one HTML fragment.
reactor.core.publisher.Flux<Fragment>	fragments()	Return the fragments to render.
static FragmentsRendering.Builder	fragments(Collection<Fragment> fragments)	Create a builder with multiple HTML fragments.
static FragmentsRendering.Builder	fragmentsProducer(Object fragmentsProducer)	Variant of fragmentsPublisher(Publisher) that allows using any producer that can be resolved to Publisher via ReactiveAdapterRegistry.
static <P extends Publisher<Fragment>> FragmentsRendering.Builder	fragmentsPublisher(P fragmentsPublisher)	Create a builder with a Publisher of fragments.
HttpHeaders	headers()	Return headers to add to the response.
HttpStatusCode	status()	Return the HTTP status to set the response to.
static FragmentsRendering.Builder	with(String viewName)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of fragment(String)
static FragmentsRendering.Builder	with(String viewName, Map<String,Object> model)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of fragment(String, Map)
static FragmentsRendering.Builder	withCollection(Collection<Fragment> fragments)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of fragments(Collection)
static FragmentsRendering.Builder	withProducer(Object fragmentsProducer)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of fragmentsProducer(Object)
static <P extends Publisher<Fragment>> FragmentsRendering.Builder	withPublisher(P fragmentsPublisher)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of fragmentsPublisher(Publisher)

Method Details

status

@Nullable
HttpStatusCode status()

Return the HTTP status to set the response to.

headers

HttpHeaders headers()

Return headers to add to the response.

fragments

reactor.core.publisher.Flux<Fragment> fragments()

Return the fragments to render.

fragment

static FragmentsRendering.Builder fragment(String viewName)

Create a builder with one HTML fragment, also inheriting attributes from the shared model for the request.

Parameters:

viewName - the name of the view for the fragment

Returns:

this builder

Since:

6.2.1

fragment

static FragmentsRendering.Builder fragment(String viewName,
 Map<String,Object> model)

Create a builder with one HTML fragment.

Parameters:

viewName - the view name for the fragment

model - attributes for the fragment, in addition to attributes from the shared model for the request

Returns:

this builder

Since:

6.2.1

fragments

static FragmentsRendering.Builder fragments(Collection<Fragment> fragments)

Create a builder with multiple HTML fragments.

Parameters:

fragments - the fragments to add; each fragment also inherits attributes from the shared model for the request

Returns:

the created builder

Since:

6.2.1

fragmentsPublisher

static <P extends Publisher<Fragment>>
FragmentsRendering.Builder fragmentsPublisher(P fragmentsPublisher)

Create a builder with a Publisher of fragments.

Parameters:

fragmentsPublisher - the fragments to add; each fragment also inherits model attributes from the shared model for the request

Returns:

the created builder

Since:

6.2.1

fragmentsProducer

static FragmentsRendering.Builder fragmentsProducer(Object fragmentsProducer)

Variant of fragmentsPublisher(Publisher) that allows using any producer that can be resolved to Publisher via ReactiveAdapterRegistry.

Since:

6.2.1

with

@Deprecated(since="6.2.1",
            forRemoval=true)
static FragmentsRendering.Builder with(String viewName)

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of fragment(String)

Create a builder with one HTML fragment, also inheriting attributes from the shared model for the request.

Parameters:

viewName - the name of the view for the fragment

Returns:

this builder

with

@Deprecated(since="6.2.1",
            forRemoval=true)
static FragmentsRendering.Builder with(String viewName,
 Map<String,Object> model)

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of fragment(String, Map)

Create a builder with one HTML fragment.

Parameters:

viewName - the view name for the fragment

model - attributes for the fragment, in addition to attributes from the shared model for the request

Returns:

this builder

withCollection

@Deprecated(since="6.2.1",
            forRemoval=true)
static FragmentsRendering.Builder withCollection(Collection<Fragment> fragments)

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of fragments(Collection)

Create a builder with multiple HTML fragments.

Parameters:

fragments - the fragments to add; each fragment also inherits attributes from the shared model for the request

Returns:

the created builder

withPublisher

@Deprecated(since="6.2.1",
            forRemoval=true)
static <P extends Publisher<Fragment>>
FragmentsRendering.Builder withPublisher(P fragmentsPublisher)

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of fragmentsPublisher(Publisher)

Create a builder with a Publisher of fragments.

Parameters:

fragmentsPublisher - the fragments to add; each fragment also inherits model attributes from the shared model for the request

Returns:

the created builder

withProducer

@Deprecated(since="6.2.1",
            forRemoval=true)
static FragmentsRendering.Builder withProducer(Object fragmentsProducer)

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of fragmentsProducer(Object)

Variant of fragmentsPublisher(Publisher) that allows using any producer that can be resolved to Publisher via ReactiveAdapterRegistry.