Interface PageRendererExecution

Page renderer execution context.

This is passed to page renderer when the latter executed on page load event.

Hierarchy

  • FragmentRendererExecution
    • PageRendererExecution

Properties

config: RenderScheduleConfig

A configuration of rendering schedule the render shot is executed by.

content: DocumentFragment

The content of the rendered fragment.

fragment: DrekFragment<[DrekContentStatus]>

Rendered fragment instance.

A page load response.

supply: Supply

Renderer supply. The rendering would stop once this supply is cut off.

This is the same supply as the one returned from ComponentRenderCtl.renderBy.

Methods

  • Stops fragment re-rendering.

    After calling this method the rendered fragment will be placed to the document once and no further rendering would happen, unless a renderBy is also called.

    Parameters

    • this: void

    Returns void

  • Postpones render shot so that it is executed after all currently executed render shots.

    This may be useful e.g. when the render shot issues a synchronous page reflow. In this case postponing it until after all DOM modifications done would help reduce layout thrashing.

    Postponed render shots are executed in reverse order.

    Parameters

    Returns void

  • Delegates component rendering to another renderer.

    After this method call the provided renderer will be used to render the component instead of currently executing one.

    The given renderer will be executed immediately after currently executing one, unless they are the same.

    Parameters

    • this: void
    • renderer: ComponentRenderer<ComponentRendererExecution>

      A renderer to delegate component rendering to.

    Returns void

  • Allows to retain the document content instead of replacing it with pre-rendered one.

    Parameters

    • Optional retain: boolean

      Whether to retain the document content. true by default.

    Returns void

Generated using TypeDoc