Class: ServerPageRenderer
@ima/react-page-renderer.ServerPageRenderer
Server-side page renderer. The renderer renders the page into the HTML markup and sends it to the client.
Hierarchy
default
↳
ServerPageRenderer
Constructors
constructor
• new ServerPageRenderer(factory
, helpers
, dispatcher
, settings
)
Initializes the server-side page renderer.
Parameters
Name | Type | Description |
---|---|---|
factory | PageRendererFactory | Factory for receive $Utils to view. |
helpers | __module | The IMA.js helper methods. |
dispatcher | default | Dispatcher fires events to app. |
settings | Settings | Application setting for the current application environment. |
Overrides
AbstractPageRenderer.constructor
Defined in
packages/react-page-renderer/src/renderer/ServerPageRenderer.ts:34
Properties
_dispatcher
• Protected
_dispatcher: default
Inherited from
AbstractPageRenderer._dispatcher
Defined in
packages/react-page-renderer/src/renderer/AbstractPageRenderer.ts:33
_factory
• Protected
_factory: PageRendererFactory
Inherited from
AbstractPageRenderer._factory
Defined in
packages/react-page-renderer/src/renderer/AbstractPageRenderer.ts:34
_helpers
• Protected
_helpers: __module
Inherited from
AbstractPageRenderer._helpers
Defined in
packages/react-page-renderer/src/renderer/AbstractPageRenderer.ts:35
_settings
• Protected
_settings: Settings
Inherited from
AbstractPageRenderer._settings
Defined in
packages/react-page-renderer/src/renderer/AbstractPageRenderer.ts:36
_viewAdapter
• Protected
Optional
_viewAdapter: ComponentType
<{}>
Inherited from
AbstractPageRenderer._viewAdapter
Defined in
packages/react-page-renderer/src/renderer/AbstractPageRenderer.ts:37
_viewAdapterProps
• Protected
_viewAdapterProps: UnknownParameters
= {}
Inherited from
AbstractPageRenderer._viewAdapterProps
Defined in
packages/react-page-renderer/src/renderer/AbstractPageRenderer.ts:38
Methods
_generateViewAdapterProps
▸ Protected
_generateViewAdapterProps(managedRootView
, pageView
, state?
): ViewAdapterProps
Generate properties for view from state.
Parameters
Name | Type |
---|---|
managedRootView | ComponentType <{}> |
pageView | ComponentType <{}> |
state | UnknownParameters |
Returns
ViewAdapterProps
Inherited from
AbstractPageRenderer._generateViewAdapterProps
Defined in
packages/react-page-renderer/src/renderer/AbstractPageRenderer.ts:124
_getDocumentView
▸ Protected
_getDocumentView(routeOptions
): ComponentType
<{}>
Returns the class constructor of the specified document view component.
Parameters
Name | Type | Description |
---|---|---|
routeOptions | RouteOptions | The current route options. |
Returns
ComponentType
<{}>
The constructor of the document view component.
Inherited from
AbstractPageRenderer._getDocumentView
Defined in
packages/react-page-renderer/src/renderer/AbstractPageRenderer.ts:172
_getViewAdapterElement
▸ _getViewAdapterElement(props?
): undefined
| ReactElement
<{}, string
| JSXElementConstructor
<any
>>
Inherit Doc
Parameters
Name | Type |
---|---|
props | Object |
Returns
undefined
| ReactElement
<{}, string
| JSXElementConstructor
<any
>>
Inherited from
AbstractPageRenderer._getViewAdapterElement
Defined in
packages/react-page-renderer/src/renderer/AbstractPageRenderer.ts:111
_prepareViewAdapter
▸ Protected
_prepareViewAdapter(controller
, pageView
, routeOptions
): void
Returns wrapped page view component with managed root view and view adapter.
Parameters
Name | Type | Description |
---|---|---|
controller | default | - |
pageView | ComponentType <{}> | - |
routeOptions | RouteOptions | The current route options. |
Returns
void
Inherited from
AbstractPageRenderer._prepareViewAdapter
Defined in
packages/react-page-renderer/src/renderer/AbstractPageRenderer.ts:144
mount
▸ mount(controller
, pageView
, pageResources
, routeOptions
): Promise
<void
| PageData
>
Inherit Doc
Parameters
Name | Type |
---|---|
controller | default |
pageView | ComponentType <{}> |
pageResources | UnknownPromiseParameters |
routeOptions | RouteOptions |
Returns
Promise
<void
| PageData
>
Overrides
AbstractPageRenderer.mount
Defined in
packages/react-page-renderer/src/renderer/ServerPageRenderer.ts:46
setState
▸ setState(): Promise
<void
>
Returns
Promise
<void
>
Overrides
AbstractPageRenderer.setState
Defined in
packages/react-page-renderer/src/renderer/ServerPageRenderer.ts:72
unmount
▸ unmount(): void
Inherit Doc
Returns
void
Overrides
AbstractPageRenderer.unmount
Defined in
packages/react-page-renderer/src/renderer/ServerPageRenderer.ts:88
update
▸ update(): Promise
<never
>
Inherit Doc
Returns
Promise
<never
>
Overrides
AbstractPageRenderer.update
Defined in
packages/react-page-renderer/src/renderer/ServerPageRenderer.ts:79