@acoustic-content-sdk/app 中文文档教程
这个示意图 允许向您的 Angular 应用程序添加 Acoustic Content SDK 支持。
Prereq
- Install the Angular CLI
- Make sure you have an Angular project set up
Usage
从应用程序文件夹中的命令行运行
npx ng add @acoustic-content-sdk/app
该命令会将 Acoustic Content SDK 添加到您的项目并安装所需的依赖项。
Next Steps
- Consult @acoustic-content-sdk/schematics for a list of commands that you can use to develop your Acoustic Content application.
- Follow the guide to begin writing awesome applications for Acoustic Content.
Concepts
为 Acoustic Content 构建的应用程序有两个版本,view
和edit
版本。 这些版本的不同之处在于它们在应用程序引导程序时从 Acoustic Content SDK 中提取的模块集时间,实际的应用程序代码,即这些版本之间的应用程序组件是相同的。
拆分是有道理的,因为 edit
版本为应用程序启用了内联编辑功能,与没有编辑功能的应用程序相比,这需要引入更多的依赖项。 因此,edit
的应用程序构建比view
的应用程序构建更大。 但是,重要的是要使 view
的应用程序大小尽可能小,以提供最佳的应用程序性能。 因此分裂。
不同的构建版本在 angular.json
文件中表示为 configurations
。 例如,您可以在生产调用 ng build --configuration=production,view
或编辑模式 ng build --configuration=production,edit
中构建应用程序。 相同的叠加技术适用于其他构建目标。
Documentation
Home > @acoustic-content-sdk/app
app package
角度示意图用于添加应用支持对于声音内容。
Functions
Function | Description |
---|---|
addToApplication(options) | Adds SDK support to an existing Angular application |
Variables
Variable | Description |
---|---|
VERSION | Version and build number of the package |
Home > @acoustic-content-sdk/app > addToApplication
addToApplication() function
将 SDK 支持添加到现有的 Angular 应用程序
签名:
export declare function addToApplication(options: Schema): Rule;
Parameters
Parameter | Type | Description |
---|---|---|
options | Schema | the schematics object used to describe the applicatiojn |
返回:
规则
原理图rule that executes the transform
Home > @acoustic-content-sdk/app > VERSION
VERSION variable
软件包的版本和构建号
签名:
VERSION: {
version: {
major: string;
minor: string;
patch: string;
branch: string;
};
build: Date;
}
This schematics allows to add Acoustic Content SDK support to your Angular application.
Prereq
- Install the Angular CLI
- Make sure you have an Angular project set up
Usage
From the command line from within you application folder run
npx ng add @acoustic-content-sdk/app
This will ask for the API_URL of your Acoustic Content tenant.
The command will add the Acoustic Content SDK to your project and install the required dependencies.
Next Steps
- Consult @acoustic-content-sdk/schematics for a list of commands that you can use to develop your Acoustic Content application.
- Follow the guide to begin writing awesome applications for Acoustic Content.
Concepts
An application built for Acoustic Content is delivered in two versions, a view
and an edit
version. The versions differ in the set of modules they pull in from the Acoustic Content SDK at application bootstrap time, the actual application code, i.e. the application components are identical between these versions.
The split makes sense, because the edit
version enables inline edit features for the application and this requires to pull in more dependencies than there are required for an application without edit capabilities. So the application build for edit
is larger than that for view
. It is important however to keep the application size for view
as small as possible to deliver the best application performance possible. Hence the split.
The different build versions are represented as configurations
in the angular.json
file. You can e.g. build the application in view mode for production calling ng build --configuration=production,view
or in edit mode ng build --configuration=production,edit
. The same overlay technique works for other build targets.
Documentation
Home > @acoustic-content-sdk/app
app package
Angular schematics used to add application support for Acoustic Content.
Functions
Function | Description |
---|---|
addToApplication(options) | Adds SDK support to an existing Angular application |
Variables
Variable | Description |
---|---|
VERSION | Version and build number of the package |
Home > @acoustic-content-sdk/app > addToApplication
addToApplication() function
Adds SDK support to an existing Angular application
Signature:
export declare function addToApplication(options: Schema): Rule;
Parameters
Parameter | Type | Description |
---|---|---|
options | Schema | the schematics object used to describe the applicatiojn |
Returns:
Rule
the schematics rule that executes the transform
Home > @acoustic-content-sdk/app > VERSION
VERSION variable
Version and build number of the package
Signature:
VERSION: {
version: {
major: string;
minor: string;
patch: string;
branch: string;
};
build: Date;
}