Skip to main content

Class: ServerPageRenderer

Defined in: packages/react-page-renderer/src/renderer/ServerPageRenderer.ts:22

Server-side page renderer. The renderer renders the page into the HTML markup and sends it to the client.

Extends​

  • AbstractPageRenderer

Constructors​

new ServerPageRenderer()​

new ServerPageRenderer(factory, helpers, dispatcher, settings): ServerPageRenderer

Defined in: packages/react-page-renderer/src/renderer/ServerPageRenderer.ts:34

Initializes the server-side page renderer.

Parameters​

factory​

PageRendererFactory

Factory for receive $Utils to view.

helpers​

__module

The IMA.js helper methods.

dispatcher​

Dispatcher

Dispatcher fires events to app.

settings​

Settings

Application setting for the current application environment.

Returns​

ServerPageRenderer

Overrides​

AbstractPageRenderer.constructor

Properties​

_dispatcher​

protected _dispatcher: Dispatcher

Defined in: packages/react-page-renderer/src/renderer/AbstractPageRenderer.ts:37

Inherited from​

AbstractPageRenderer._dispatcher

_factory​

protected _factory: PageRendererFactory

Defined in: packages/react-page-renderer/src/renderer/AbstractPageRenderer.ts:38

Inherited from​

AbstractPageRenderer._factory

_helpers​

protected _helpers: __module

Defined in: packages/react-page-renderer/src/renderer/AbstractPageRenderer.ts:39

Inherited from​

AbstractPageRenderer._helpers

_settings​

protected _settings: Settings

Defined in: packages/react-page-renderer/src/renderer/AbstractPageRenderer.ts:40

Inherited from​

AbstractPageRenderer._settings

_viewAdapter?​

protected optional _viewAdapter: ComponentType

Defined in: packages/react-page-renderer/src/renderer/AbstractPageRenderer.ts:41

Inherited from​

AbstractPageRenderer._viewAdapter

_viewAdapterProps​

protected _viewAdapterProps: UnknownParameters = {}

Defined in: packages/react-page-renderer/src/renderer/AbstractPageRenderer.ts:42

Inherited from​

AbstractPageRenderer._viewAdapterProps

Methods​

_generateViewAdapterProps()​

protected _generateViewAdapterProps(managedRootView, pageView, state): ViewAdapterProps

Defined in: packages/react-page-renderer/src/renderer/AbstractPageRenderer.ts:128

Generate properties for view from state.

Parameters​

managedRootView​

ComponentType

pageView​

ComponentType

state​

UnknownParameters = {}

Returns​

ViewAdapterProps

Inherited from​

AbstractPageRenderer._generateViewAdapterProps

_getDocumentView()​

protected _getDocumentView(routeOptions): ComponentType

Defined in: packages/react-page-renderer/src/renderer/AbstractPageRenderer.ts:176

Returns the class constructor of the specified document view component.

Parameters​

routeOptions​

RouteOptions

The current route options.

Returns​

ComponentType

The constructor of the document view component.

Inherited from​

AbstractPageRenderer._getDocumentView

_getViewAdapterElement()​

_getViewAdapterElement(props): undefined | ReactElement<{}>

Defined in: packages/react-page-renderer/src/renderer/AbstractPageRenderer.ts:115

Parameters​

props​

Returns​

undefined | ReactElement<{}>

Inherit Doc​

Inherited from​

AbstractPageRenderer._getViewAdapterElement

_prepareViewAdapter()​

protected _prepareViewAdapter(controller, pageView, routeOptions): void

Defined in: packages/react-page-renderer/src/renderer/AbstractPageRenderer.ts:148

Returns wrapped page view component with managed root view and view adapter.

Parameters​

controller​

Controller

pageView​

ComponentType

routeOptions​

RouteOptions

The current route options.

Returns​

void

Inherited from​

AbstractPageRenderer._prepareViewAdapter

mount()​

mount(controller, pageView, pageResources, routeOptions): Promise<void | PageData>

Defined in: packages/react-page-renderer/src/renderer/ServerPageRenderer.ts:46

Parameters​

controller​

ControllerDecorator

pageView​

ComponentType<{}>

pageResources​

UnknownPromiseParameters

routeOptions​

RouteOptions

Returns​

Promise<void | PageData>

Inherit Doc​

Overrides​

AbstractPageRenderer.mount

setState()​

setState(): Promise<void>

Defined in: packages/react-page-renderer/src/renderer/ServerPageRenderer.ts:72

Returns​

Promise<void>

Inherit Doc​

Overrides​

AbstractPageRenderer.setState

unmount()​

unmount(): void

Defined in: packages/react-page-renderer/src/renderer/ServerPageRenderer.ts:88

Returns​

void

Inherit Doc​

Overrides​

AbstractPageRenderer.unmount

update()​

update(): Promise<never>

Defined in: packages/react-page-renderer/src/renderer/ServerPageRenderer.ts:79

Returns​

Promise<never>

Inherit Doc​

Overrides​

AbstractPageRenderer.update