@acoustic-content-sdk/ng-app-preview

Module that contains a default configuration to run an Angular application against Acoustic Content in preview mode.

Usage no npm install needed!

<script type="module">
  import acousticContentSdkNgAppPreview from 'https://cdn.skypack.dev/@acoustic-content-sdk/ng-app-preview';
</script>

README

npm

Module that contains a default configuration to run an Angular application against Acoustic Content in preview mode.

Table of Contents

General Concepts

Applications on Acoustic Content can run in preview mode and in live mode. In preview mode they are augmented with inline edit capabilities and optimited for inline edit experience, in live mode they run in read-only mode optimized for size and performance.

The difference in runtime behaviour is achieved by building the application twice with different dependency providers for services that the application relies on.

Providers for preview mode are supplied by the ng-app-preview module, for live mode via the ng-app-live module and general purpose providers that apply to both modes by the ng-app-base module.

Home > @acoustic-content-sdk/ng-app-preview

ng-app-preview package

Module that contains a default configuration to run an Angular application against Acoustic Content in preview mode.

Classes

Class Description
AcNgAppPreviewModule Imports the modules required for inline edit functionality. This module makes the following choices:- Inline edit functionality is accessed from the controlling parent window - Data access is implemented by accessing the redux store - The redux store is accessed from the controlling parent windowThis module assumes that the controlling parent window runs in the same origin than the application window. If this is not the case for your application, select different providers for ACOUSTIC_TOKEN_INLINE_EDIT_PROVIDER and ACOUSTIC_TOKEN_REDUX_STORE

Variables

Variable Description
MODULE Module name
VERSION Version and build number of the package

Home > @acoustic-content-sdk/ng-app-preview > AcNgAppPreviewModule

AcNgAppPreviewModule class

Imports the modules required for inline edit functionality. This module makes the following choices:

  • Inline edit functionality is accessed from the controlling parent window - Data access is implemented by accessing the redux store - The redux store is accessed from the controlling parent window

This module assumes that the controlling parent window runs in the same origin than the application window. If this is not the case for your application, select different providers for ACOUSTIC_TOKEN_INLINE_EDIT_PROVIDER and ACOUSTIC_TOKEN_REDUX_STORE

Signature:

export declare class AcNgAppPreviewModule

Constructors

Constructor Modifiers Description
(constructor)(aCurrentWindow, aHostWindow, aLoggerService) Constructs a new instance of the AcNgAppPreviewModule class

Properties

Property Modifiers Type Description
VERSION WchSdkVersion Exposes the version information of this module

Home > @acoustic-content-sdk/ng-app-preview > MODULE

MODULE variable

Module name

Signature:

MODULE = "@acoustic-content-sdk/ng-app-preview"

Home > @acoustic-content-sdk/ng-app-preview > VERSION

VERSION variable

Version and build number of the package

Signature:

VERSION: {
    version: {
        major: string;
        minor: string;
        patch: string;
        branch: string;
    };
    build: Date;
}

Home > @acoustic-content-sdk/ng-app-preview > AcNgAppPreviewModule > (constructor)

AcNgAppPreviewModule.(constructor)

Constructs a new instance of the AcNgAppPreviewModule class

Signature:

constructor(aCurrentWindow: WindowType, aHostWindow: WindowType, aLoggerService: LoggerService);

Parameters

Parameter Type Description
aCurrentWindow WindowType
aHostWindow WindowType
aLoggerService LoggerService

Home > @acoustic-content-sdk/ng-app-preview > AcNgAppPreviewModule > VERSION

AcNgAppPreviewModule.VERSION property

Exposes the version information of this module

Signature:

VERSION: WchSdkVersion;