Unpoly
3.11
API Tutorial Demo Install Changes Support GitHub Menu
Menu
Edit this page

API class up.RenderResult

Instances of up.RenderResult describe the effects of rendering.

Functions like up.render(), up.follow() or up.submit() return a promise that resolve with an up.RenderResult:

let result = await up.render('.target', content: 'foo')
console.log(result.fragments)     // result: [<div class="target">...</div>]
console.log(result.layer)         // result: up.Layer.Root
console.log(result.renderOptions) // result: { target: '.target', content: 'foo', ... }

Features

All features

JS
up.RenderResult.prototype.fragment stable

Returns the inserted fragment.

JS
up.RenderResult.prototype.fragments stable

The effective fragments that ended up being inserted.

JS
up.RenderResult.prototype.layer stable

The updated layer.

JS
up.RenderResult.prototype.none stable

Whether this render pass did not result in any fragments being rendered.

JS
up.RenderResult.prototype.ok experimental

Whether this render pass has rendered a successful response.

JS
up.RenderResult.prototype.renderOptions experimental

The render options used to produce this result.

JS
up.RenderResult.prototype.target stable

The effective target selector for the rendered fragments.

Made by Henning Koch
Imprint
Privacy policy