Class: PreviewDriver
ghostly-runtime.PreviewDriver
A utility class for rendering a template as HTML to an IFrame in a web browser (not using Ghostly Engine.
Hierarchy
↳
PreviewDriver
Constructors
constructor
• new PreviewDriver(_target, _onGhostlyEvent?)
Parameters
| Name | Type | Description |
|---|---|---|
_target | string | The name of the IFrame to control. |
_onGhostlyEvent? | OnGhostlyEvent | The default event handler to use. Defauts to just logging the event to the console. |
Overrides
Defined in
ghostly-runtime/src/driver.ts:86
Properties
_target
• Protected _target: string
_template
• Protected Optional _template: string
Inherited from
Defined in
ghostly-runtime/src/driver.ts:5
Methods
clearPreview
▸ clearPreview(): Promise<void>
Clears the preview IFrame by loading about:blank.
Returns
Promise<void>
Defined in
ghostly-runtime/src/driver.ts:163
ghostlyEnd
▸ ghostlyEnd(): Promise<void>
This optional method is invoked when all processing of the model is done. May be used to purge caches and other resources.
Returns
Promise<void>
Inherited from
Defined in
ghostly-runtime/src/driver.ts:54
ghostlyFetch
▸ ghostlyFetch(info): Promise<GhostlyTypes>
Asks the template to render an attachment. This call should not return or resolve until the attachment is stable and fully rendered.
Parameters
| Name | Type |
|---|---|
info | AttachmentInfo<unknown> |
Returns
Promise<GhostlyTypes>
Inherited from
Defined in
ghostly-runtime/src/driver.ts:39
ghostlyInit
▸ ghostlyInit(model): Promise<undefined | ModelInfo>
Used to supply the model (data) that the template should render from.
Parameters
| Name | Type |
|---|---|
model | Model |
Returns
Promise<undefined | ModelInfo>
Inherited from
Defined in
ghostly-runtime/src/driver.ts:12
ghostlyLoad
▸ ghostlyLoad(template): Promise<void>
This optional method will be invoked once the template has been loaded by the browser, or each time the fragment part (hash) changes in a cached template.
Parameters
| Name | Type |
|---|---|
template | string |
Returns
Promise<void>
Inherited from
Defined in
ghostly-runtime/src/driver.ts:7
ghostlyPreview
▸ ghostlyPreview(command?): Promise<PreviewResult>
This method is used by the PreviewDriver to print and to find out the preferred size of the IFrame.
Parameters
| Name | Type |
|---|---|
command | PreviewCommand |
Returns
Promise<PreviewResult>
Inherited from
Defined in
ghostly-runtime/src/driver.ts:43
ghostlyRender
▸ ghostlyRender(view): Promise<GhostlyTypes>
Asks the template to render a specific view. This call should not return or resolve until the view is stable and fully rendered.
Parameters
| Name | Type |
|---|---|
view | View<unknown> |
Returns
Promise<GhostlyTypes>
Inherited from
Defined in
ghostly-runtime/src/driver.ts:35
print
▸ print(): void
Prompt the user to print current view.
Returns
void
Defined in
ghostly-runtime/src/driver.ts:187
renderPreview
▸ renderPreview(template, document, contentType, params?, onGhostlyEvent?): Promise<PreviewAttachment[]>
Renders the provided model as HTML to the target IFrame, and then returns all attachments.
Note that all attachments are returned as-is from the template, so if an attachment is supposed to be rendered by
the engine, data will be null. Only attachments where the template returns actual data will work.
Note that ghostlyEnd will not be invoked by this method, since that would affect the preview result.
Parameters
| Name | Type | Description |
|---|---|---|
template | string | The URL to the Ghostly template to use. |
document | string | object | The model data, as JSON or a string. |
contentType | string | The model's media type, used as an indication to the template how document should be parsed. |
params? | unknown | Optional view params (as JSON). |
onGhostlyEvent? | OnGhostlyEvent | Optional event handler to use. Will fallback to the default event handler if unspecified. |
Returns
Promise<PreviewAttachment[]>
An array of PreviewAttachment objects representing all attachments the template produced.
Defined in
ghostly-runtime/src/driver.ts:108
sendMessage
▸ Protected sendMessage(request): Promise<GhostlyTypes>
A browser-only implementation that just sends the message and directly unpacks the response.
Parameters
| Name | Type | Description |
|---|---|---|
request | GhostlyRequest | The raw request to send. |
Returns
Promise<GhostlyTypes>
The unpacked response.
Overrides
Defined in
ghostly-runtime/src/driver.ts:214
target
▸ Protected target(): HTMLIFrameElement
Returns the target IFrame based on the _target constructor parameter. May be overridden.
Returns
HTMLIFrameElement
The IFrame to preview the template in.