@acoustic-content-sdk/edit-api 中文文档教程
Table of Contents
General Concepts
内联编辑 API 定义了应用程序如何将 DOM 元素注册为可内联编辑,以及 API 实现者如何注册内联编辑功能可以连接到系统中。 消费者面向接口WchInlineEditServiceV2
的目的是为了方便使用服务,提供者面向接口WchInlineEditProviderV2
的目的是实现服务。 两者之间的粘合层是 SDK 的通用实现。
请参阅框架特定模块以了解如何访问服务。
Provider
编辑提供程序是一段实现内联编辑功能的 javascript 代码。 它由 SPA 动态加载(通常通过 SDK)。 提供者需要符合以下模式:
Initialization
编辑模块实现了WchInlineEditProviderV2
接口,即它公开了一个register
函数。 将为每个可编辑的 HTML 元素调用此函数,并允许编辑提供程序将所需的编辑挂钩附加到元素。 该方法提供:
- a reference to the actual HTML element
- an accessor expression that identifies the element on a content item to be edited. This expression is relative to the current rendering context
- a reactive stream of rendering contexts. Note that the rendering contexts can change during the lifetime of this registration. Also there is no guarantee that the element pointed to by the accessor actually exists on the context. If a provider subscribes to the sequence of rendering contexts, it needs to make sure to NOT throw an exception in the subscribe block under any circumstances
Result
注册的结果是一个事件提供者。 此提供程序的目的是将 HTML 元素上的内联编辑操作传达给主机,即主机在该事件提供程序上注册事件,编辑提供程序负责触发这些事件(如果支持该事件)。
事件提供者可以选择实现 Disposable
接口。 如果实现,主机将在注册后调用其 dispose
方法,在 HTML 元素从 DOM 中删除之前(因此它是注册调用的逆操作)。
Notifications
WchInlineEditProviderV2
的实现者也可以选择性地实现EventTargetLike
接口,即成为一个事件发射器。 这允许提供者向 SDK 传达信息,例如关于启用或禁用内联编辑模式的信息。
当前支持的通知有:
wchInlineEditStart
to notify about entering inline edit modewchInlineEditEnd
to notify about leaving inline edit mode
WchInlineEditService
WchInlineEditServiceV2
接口允许客户端与内联编辑实现交互。 此接口的实现确保加载内联编辑提供程序并履行与提供程序的接口合同。
该接口的使用者为每个应该被编辑的 HTML 元素调用 registerComponent
消息。 此调用的结果是一个 Observable。 内联编辑注册在有人订阅此可观察对象后立即开始,并在订阅结束后立即结束。 消费者有责任确保 HTML 元素在订阅期间存在。
@acoustic-content-sdk/edit-api
edit-api package
编辑 API 为内联编辑功能的消费者和提供者定义了接口。
Interfaces
Interface | Description |
---|---|
DataTransferContentItem | Data transfer format for content items |
Disposable | Implemented by objects that expose a life cycle. Calling the dispose method signals the end of this life cycle. |
InlineEditSelectionProvider | Service that exposes inline edit info |
WchConfig | Exposes server side configuration for the current tenant |
WchEditableEvent | Event issued by the edit provider. |
WchInlineEditEvent | Event issued by the edit library |
WchInlineEditProvider | |
WchInlineEditProviderV2 | Interface exposed by an inline edit provider implementationImplementors may also implement EventTargetLike to send item independent events |
WchInlineEditRequireMap | Helper interface that defines the mappings from module name to actual type |
WchInlineEditRequireMapV2 | Helper interface that defines the mappings from module name to actual type. This is a simple dependency injection mechanism from the inline edit host to the inline edit provider. |
WchInlineEditService | Implementation of the edit service used by the wchEditable directive. |
WchInlineEditServiceV2 | Implementation of the edit service used by the wchEditable directive. |
Variables
Variable | Description |
---|---|
ACOUSTIC_ACTIVE_PAGE_MODULE | Token used to require the active page service PromiseLike |
ACOUSTIC_CONFIG_MODULE | Token used to require the [[WchConfig]] service PromiseLike |
ACOUSTIC_HTTP_MODULE | Token used to access the http service PromiseLike |
ACOUSTIC_INFO_MODULE | Token used to require the [[WchInfo]] service PromiseLike |
ACOUSTIC_LOGGER_MODULE | Token used to require the [[LoggerService]] PromiseLike |
ATTR_DATA_SELECTABLE | |
EVENT_EDIT_END | |
EVENT_EDIT_START | |
EVENT_INLINE_EDIT_END | |
EVENT_INLINE_EDIT_SET_SELECTED_CELL | |
EVENT_INLINE_EDIT_START | |
INLINE_EDIT_PROVIDER_ID | Identifier used to identify an WchInlineEditProviderV2 instance on a context, e.g. the window |
TRANSFER_FORMAT | Transfer format for our custom dnd components |
VERSION | Version and build number of the package |
WCH_ACTIVE_PAGE_MODULE | |
WCH_CONFIG_MODULE | |
WCH_HTTP_MODULE | |
WCH_INFO_MODULE | |
WCH_LOGGER_MODULE |
Type Aliases
Type Alias | Description |
---|---|
AccessorType | The accessor string, a property path relative to the root of a content item that points to the element value to be edited. A value of null denotes the root level element. |
EventTargetLike | |
WchInlineEditRegistration | |
WchInlineEditRegistrationResult | Result of an inline edit registration. This is at least an event emitter but may optionally also expose the Disposable interface to allow deregistration |
WchInlineEditRegistrationV2 | Type definition of the register method that allows to register DOM elements with an inline edit provider. |
WchInlineEditRequire | Interface of the require function, strongly typed |
WchInlineEditRequireV2 | Interface of the require function, strongly typed |
Home > @acoustic-content-sdk/edit-api > DataTransferContentItem
DataTransferContentItem interface
Data transfer format for content items
Signature:
export interface DataTransferContentItem
Properties
Property | Type | Description |
---|---|---|
accessor | AccessorType |
The accessor string |
id | string |
ID of the content item |
首页 > @acoustic-content-sdk/edit-api > 一次性
Disposable interface
由公开生命周期的对象实现。 调用 dispose 方法标志着此生命周期的结束。
Signature:
export interface Disposable
Properties
Property | Type | Description |
---|---|---|
dispose | () => void |
Home > @acoustic-content-sdk/edit-api > InlineEditSelectionProvider
InlineEditSelectionProvider interface
Service that exposes inline edit info
Signature:
export interface InlineEditSelectionProvider
Properties
Property | Type | Description |
---|---|---|
selectedCell$ | Observable<string | undefined> |
Captures the currently selected cell. The return value is either just an ID or ID#accessor . If a cell is deselected, the service returns i |
首页 > @acoustic-content-sdk/edit-api > WchConfig Exposes
WchConfig interface
server side configuration for the current tenant
Signature:
export interface WchConfig
Properties
Property | Type | Description |
---|---|---|
apiUrl | URL |
API URL for the non-preview host |
authoringUIBaseUrl | URL |
URL of the authoring host |
deliveryUrl | URL |
delivery URL for the non-preview host |
previewApiUrl | URL |
API URL for the preview host |
previewDeliveryUrl | URL |
delivery URL for the preview host |
首页 > @acoustic-content-sdk/edit-api > WchEditableEvent
WchEditableEvent interface
编辑提供者发出的事件。
Signature:
export interface WchEditableEvent
Properties
Property | Type | Description |
---|---|---|
data | any |
|
target | HTMLElement |
|
type | string |
Home > @acoustic-content-sdk/edit-api > WchInlineEditEvent
WchInlineEditEvent interface
Event issued by the edit library
Signature:
export interface WchInlineEditEvent
Properties
Property | Type | Description |
---|---|---|
data | any |
|
type | string |
首页 > @acoustic-content-sdk/edit-api > WchInlineEditProvider
WchInlineEditProvider interface
警告:此 API 现在已过时。
use WchInlineEditProviderV2 instead
Signature:
export interface WchInlineEditProvider
Properties
Property | Type | Description |
---|---|---|
register | WchInlineEditRegistration |
Home > @acoustic-content-sdk/edit-api > WchInlineEditProviderV2
WchInlineEditProviderV2 interface
由内联编辑提供程序实现公开的接口
实现者还可以实现EventTargetLike
以发送项目独立事件
签名:
export interface WchInlineEditProviderV2
Properties
Property | Type | Description |
---|---|---|
register | WchInlineEditRegistrationV2 |
The register method that allows to register DOM elements with the provider |
首页 @acoustic-content-sdk/edit-api > WchInlineEditRequireMap
WchInlineEditRequireMap interface
Helper interface that defines the mappings from module name to actual type
Signature:
export interface WchInlineEditRequireMap
Properties
Property | Type | Description |
---|---|---|
"wch-active-page" | PromiseLike<ActivePage> |
|
"wch-config" | PromiseLike<WchConfig> |
|
"wch-http" | PromiseLike<WchHttp> |
|
"wch-info" | PromiseLike<UrlConfig> |
|
"wch-logger" | PromiseLike<LoggerService> |
主页 > @acoustic-content-sdk/edit-api > WchInlineEditRequireMapV2
WchInlineEditRequireMapV2 interface
定义从模块名称到实际类型的映射的帮助程序接口。 这是从内联编辑主机到内联编辑提供者的简单依赖注入机制。
Signature:
export interface WchInlineEditRequireMapV2
Properties
Property | Type | Description |
---|---|---|
"wch-active-page" | PromiseLike<ActivePageV2> |
|
"wch-config" | PromiseLike<WchConfig> |
|
"wch-info" | PromiseLike<UrlConfig> |
|
"wch-logger" | PromiseLike<LoggerService> |
Home > @acoustic-content-sdk/edit-api > WchInlineEditService
WchInlineEditService interface
wchEditable 指令使用的编辑服务的实现。
Signature:
export interface WchInlineEditService
Methods
Method | Description |
---|---|
fromEvent(aName) | Attaches to an event issued by the edit library |
registerComponent(nativeElement, accessor, onRenderingContext) | Registers a particular DOM element as editable |
Home > @acoustic-content-sdk/edit-api > WchInlineEditServiceV2
WchInlineEditServiceV2 interface
wchEditable 指令使用的编辑服务的实现。
Signature:
export interface WchInlineEditServiceV2
Methods
Method | Description |
---|---|
fromEvent(aName) | Attaches to an event issued by the edit library |
registerComponent(nativeElement, accessor, renderingContext$) | Registers a particular DOM element as editable |
Home > @acoustic-content-sdk/edit-api > ACOUSTIC_ACTIVE_PAGE_MODULE
ACOUSTIC_ACTIVE_PAGE_MODULE variable
Token used to require the active page service
PromiseLike
Signature:
ACOUSTIC_ACTIVE_PAGE_MODULE = "wch-active-page"
主页 > @acoustic-content-sdk/edit-api > ACOUSTIC_CONFIG_MODULE
ACOUSTIC_CONFIG_MODULE variable
Token used to require the [[WchConfig]] service
PromiseLike
Signature:
ACOUSTIC_CONFIG_MODULE = "wch-config"
首页 > @acoustic-content-sdk/edit-api > ACOUSTIC_HTTP_MODULE
ACOUSTIC_HTTP_MODULE variable
Token used to access the http service
PromiseLike
Signature:
ACOUSTIC_HTTP_MODULE = "wch-http"
主页 > @acoustic-content-sdk/edit-api > ACOUSTIC_INFO_MODULE
ACOUSTIC_INFO_MODULE variable
Token used to require the [[WchInfo]] service
PromiseLike
Signature:
ACOUSTIC_INFO_MODULE = "wch-info"
首页 > @acoustic-content-sdk/edit-api > ACOUSTIC_LOGGER_MODULE
ACOUSTIC_LOGGER_MODULE variable
Token used to require the [[LoggerService]]
PromiseLike
Signature:
ACOUSTIC_LOGGER_MODULE = "wch-logger"
主页 > @acoustic-content-sdk/edit-api > ATTR_DATA_SELECTABLE
ATTR_DATA_SELECTABLE variable
Signature:
ATTR_DATA_SELECTABLE = "data-wch-selectable"
Home > ; @acoustic-content-sdk/edit-api > EVENT_EDIT_END
EVENT_EDIT_END variable
Signature:
EVENT_EDIT_END = "EVENT_EDIT_END"
Home > ; @acoustic-content-sdk/edit-api > EVENT_EDIT_START
EVENT_EDIT_START variable
Signature:
EVENT_EDIT_START = "EVENT_EDIT_START"
Home > ; @acoustic-content-sdk/edit-api > EVENT_INLINE_EDIT_END
EVENT_INLINE_EDIT_END variable
Signature:
EVENT_INLINE_EDIT_END = "EVENT_INLINE_EDIT_END"
Home > ; @acoustic-content-sdk/edit-api > EVENT_INLINE_EDIT_SET_SELECTED_CELL
EVENT_INLINE_EDIT_SET_SELECTED_CELL variable
Signature:
EVENT_INLINE_EDIT_SET_SELECTED_CELL = "EVENT_INLINE_EDIT_SET_SELECTED_CELL"
Home > ; @acoustic-content-sdk/edit-api > EVENT_INLINE_EDIT_START
EVENT_INLINE_EDIT_START variable
Signature:
EVENT_INLINE_EDIT_START = "EVENT_INLINE_EDIT_START"
Home > ; @acoustic-content-sdk/edit-api > INLINE_EDIT_PROVIDER_ID
INLINE_EDIT_PROVIDER_ID variable
Identifier used to identify an WchInlineEditProviderV2 instance on a context, eg the window
Signature:
INLINE_EDIT_PROVIDER_ID = "@acoustic-content-sdk/inline-edit-provider"
首页 @acoustic-content-sdk/edit-api > TRANSFER_FORMAT
TRANSFER_FORMAT variable
Transfer format for our custom dnd components
Signature:
TRANSFER_FORMAT = "application/x-dnd-fragment"
首页 > @acoustic-content-sdk/edit-api > VERSION
VERSION variable
Version and build number of the package
Signature:
VERSION: {
version: {
major: string;
minor: string;
patch: string;
branch: string;
};
build: Date;
}
首页 > @acoustic-content-sdk/edit-api > WCH_ACTIVE_PAGE_MODULE
WCH_ACTIVE_PAGE_MODULE variable
警告:此 API 现在已过时。
use ACOUSTIC_ACTIVE_PAGE_MODULE instead
Signature:
WCH_ACTIVE_PAGE_MODULE = "wch-active-page"
Home > @acoustic-content-sdk/edit-api > WCH_CONFIG_MODULE
WCH_CONFIG_MODULE variable
警告:此 API 现在已过时。
use ACOUSTIC_CONFIG_MODULE instead
Signature:
WCH_CONFIG_MODULE = "wch-config"
Home > @acoustic-content-sdk/edit-api > WCH_HTTP_MODULE
WCH_HTTP_MODULE variable
警告:此 API 现在已过时。
use ACOUSTIC_HTTP_MODULE instead
Signature:
WCH_HTTP_MODULE = "wch-http"
Home > @acoustic-content-sdk/edit-api > WCH_INFO_MODULE
WCH_INFO_MODULE variable
警告:此 API 现已过时。
use ACOUSTIC_INFO_MODULE instead
Signature:
WCH_INFO_MODULE = "wch-info"
Home > @acoustic-content-sdk/edit-api > WCH_LOGGER_MODULE
WCH_LOGGER_MODULE variable
警告:此 API 现已过时。
use ACOUSTIC_LOGGER_MODULE instead
Signature:
WCH_LOGGER_MODULE = "wch-logger"
Home > @acoustic-content-sdk/edit-api > AccessorType
AccessorType type
访问器字符串,相对于指向要编辑的元素值的内容项的根的属性路径。 null
值表示根级别元素。
Signature:
export declare type AccessorType = string | null;
Home > @acoustic-content-sdk/edit-api > EventTargetLike
EventTargetLike type
Signature:
export declare type EventTargetLike = Parameters<typeof fromEvent>[0];
Home > ; @acoustic-content-sdk/edit-api > WchInlineEditRegistration
WchInlineEditRegistration type
警告:此 API 现在已过时。
use WchInlineEditRegistrationV2 instead
Signature:
export declare type WchInlineEditRegistration = (nativeElement: any, accessor: AccessorType, onRenderingContext: Observable<RenderingContext>) => WchInlineEditRegistrationResult;
Home > @acoustic-content-sdk/edit-api > WchInlineEditRegistrationResult
WchInlineEditRegistrationResult type
内联编辑注册的结果。 这至少是一个事件发射器,但也可以选择公开 Disposable
接口以允许注销
Signature:
export declare type WchInlineEditRegistrationResult = EventTargetLike | (EventTargetLike & Disposable);
主页 > @acoustic-content-sdk/edit-api > WchInlineEditRegistrationV2
WchInlineEditRegistrationV2 type
允许使用内联编辑提供程序注册 DOM 元素的注册方法的类型定义。
Signature:
export declare type WchInlineEditRegistrationV2 = (nativeElement: any, accessor: AccessorType, renderingContext$: Observable<RenderingContextV2>) => WchInlineEditRegistrationResult;
Home > @acoustic-content-sdk/edit-api > WchInlineEditRequire
WchInlineEditRequire type
Interface of the require function, strongly typed
Signature:
export declare type WchInlineEditRequire = (<T extends keyof WchInlineEditRequireMap>(aModule: T) => WchInlineEditRequireMap[T]) & ((aModule: string) => PromiseLike<string>);
首页 > @acoustic-content-sdk/edit-api > WchInlineEditRequireV2
WchInlineEditRequireV2 type
Interface of the require function, strongly typed
Signature:
export declare type WchInlineEditRequireV2 = (<T extends keyof WchInlineEditRequireMapV2>(aModule: T) => WchInlineEditRequireMapV2[T]) & ((aModule: string) => PromiseLike<string>);
首页 > @acoustic-content-sdk/edit-api > DataTransferContentItem > accessor
DataTransferContentItem.accessor property
The accessor string
Signature:
[KEY_ACCESSOR]: AccessorType;
Home > @acoustic-content-sdk/edit-api > DataTransferContentItem > id
DataTransferContentItem.id property
ID of the content item
Signature:
[KEY_ID]: string;
Home > @acoustic-content-sdk/edit-api > 一次性 > dispose
Disposable.dispose property
Signature:
dispose: () => void;
Home > ; @acoustic-content-sdk/edit-api > InlineEditSelectionProvider > selectedCell$
InlineEditSelectionProvider.selectedCell$ property
捕获当前选定的单元格。 返回值只是一个 ID 或 ID#accessor
。 If a cell is deselected, the service returns i
Signature:
selectedCell$: Observable<string | undefined>;
Home > @acoustic-content-sdk/edit-api > WchEditableEvent > data
WchEditableEvent.data property
Signature:
data: any;
Home > ; @acoustic-content-sdk/edit-api > WchEditableEvent > target
WchEditableEvent.target property
Signature:
target: HTMLElement;
Home > ; @acoustic-content-sdk/edit-api > WchEditableEvent > type
WchEditableEvent.type property
Signature:
type: string;
Home > ; @acoustic-content-sdk/edit-api > WchConfig > apiUrl
WchConfig.apiUrl property
API URL for the non-preview host
Signature:
readonly apiUrl: URL;
首页 > @acoustic-content-sdk/edit-api > WchConfig > authoringUIBaseUrl
WchConfig.authoringUIBaseUrl property
URL of the authoring host
Signature:
readonly authoringUIBaseUrl: URL;
Home > @acoustic-content-sdk/edit-api > WchConfig > deliveryUrl
WchConfig.deliveryUrl property
delivery URL for the non-preview host
Signature:
readonly deliveryUrl: URL;
首页 > @acoustic-content-sdk/edit-api > WchConfig > previewApiUrl
WchConfig.previewApiUrl property
API URL for the preview host
Signature:
readonly previewApiUrl: URL;
首页 > @acoustic-content-sdk/edit-api > WchConfig > previewDeliveryUrl
WchConfig.previewDeliveryUrl property
delivery URL for the preview host
Signature:
readonly previewDeliveryUrl: URL;
首页 > @acoustic-content-sdk/edit-api > WchInlineEditEvent > data
WchInlineEditEvent.data property
Signature:
data: any;
Home > ; @acoustic-content-sdk/edit-api > WchInlineEditEvent > type
WchInlineEditEvent.type property
Signature:
type: string;
Home > ; @acoustic-content-sdk/edit-api > WchInlineEditProvider > register
WchInlineEditProvider.register property
Signature:
register: WchInlineEditRegistration;
Home > ; @acoustic-content-sdk/edit-api > WchInlineEditProviderV2 > register
WchInlineEditProviderV2.register property
The register method that allows to register DOM elements with the provider
Signature:
register: WchInlineEditRegistrationV2;
Home > @acoustic-content-sdk/edit-api > WchInlineEditRequireMapV2 > "wch-active-page"
WchInlineEditRequireMapV2."wch-active-page" property
Signature:
[ACOUSTIC_ACTIVE_PAGE_MODULE]: PromiseLike<ActivePageV2>;
Home > @acoustic-content-sdk/edit-api > WchInlineEditRequireMapV2 > "wch-config"
WchInlineEditRequireMapV2."wch-config" property
Signature:
[ACOUSTIC_CONFIG_MODULE]: PromiseLike<WchConfig>;
Home > @acoustic-content-sdk/edit-api > WchInlineEditRequireMapV2 > "wch-info"
WchInlineEditRequireMapV2."wch-info" property
Signature:
[ACOUSTIC_INFO_MODULE]: PromiseLike<UrlConfig>;
Home > @acoustic-content-sdk/edit-api > WchInlineEditRequireMapV2 > "wch-logger"
WchInlineEditRequireMapV2."wch-logger" property
Signature:
[ACOUSTIC_LOGGER_MODULE]: PromiseLike<LoggerService>;
Home > @acoustic-content-sdk/edit-api > WchInlineEditServiceV2 > fromEvent
WchInlineEditServiceV2.fromEvent() method
Attaches to an event issued by the edit library
Signature:
fromEvent<T>(aName: string): Observable<T>;
Parameters
Parameter | Type | Description |
---|---|---|
aName | string |
name of the event |
Returns:
Observable
a stream of events
Home > @acoustic-content-sdk/edit-api > WchInlineEditServiceV2 > registerComponent
WchInlineEditServiceV2.registerComponent() method
Registers a particular DOM element as editable
Signature:
registerComponent(nativeElement: any, accessor: AccessorType, renderingContext$: Observable<RenderingContextV2>): Observable<EventTargetLike>;
Parameters
Parameter | Type | Description |
---|---|---|
nativeElement | any |
the DOM element to be edited |
accessor | AccessorType |
string identifying the member in the content item record to be edited. The value of 'null' means the the content item itself will be edited. |
renderingContext$ | Observable<RenderingContextV2> |
the rendering context associated with the edit operation. The same DOM element might represent multiple contexts over time |
Returns:
Observable
the observable representing the registration result. The observable exposes an event producer that a client can attach to to receive edit events. The registration will only take place when subscribing to the observable and it will end when unsubscribing.
Home > @acoustic-content-sdk/edit-api > WchInlineEditRequireMap > "wch-active-page"
WchInlineEditRequireMap."wch-active-page" property
Signature:
[ACOUSTIC_ACTIVE_PAGE_MODULE]: PromiseLike<ActivePage>;
Home > @acoustic-content-sdk/edit-api > WchInlineEditRequireMap > "wch-config"
WchInlineEditRequireMap."wch-config" property
Signature:
[ACOUSTIC_CONFIG_MODULE]: PromiseLike<WchConfig>;
Home > @acoustic-content-sdk/edit-api > WchInlineEditRequireMap > "wch-http"
WchInlineEditRequireMap."wch-http" property
Signature:
[ACOUSTIC_HTTP_MODULE]: PromiseLike<WchHttp>;
Home > @acoustic-content-sdk/edit-api > WchInlineEditRequireMap > "wch-info"
WchInlineEditRequireMap."wch-info" property
Signature:
[ACOUSTIC_INFO_MODULE]: PromiseLike<UrlConfig>;
Home > @acoustic-content-sdk/edit-api > WchInlineEditRequireMap > "wch-logger"
WchInlineEditRequireMap."wch-logger" property
Signature:
[ACOUSTIC_LOGGER_MODULE]: PromiseLike<LoggerService>;
Home > @acoustic-content-sdk/edit-api > WchInlineEditService > fromEvent
WchInlineEditService.fromEvent() method
Attaches to an event issued by the edit library
Signature:
fromEvent<T>(aName: string): Observable<T>;
Parameters
Parameter | Type | Description |
---|---|---|
aName | string |
name of the event |
Returns:
Observable
a stream of events
Home > @acoustic-content-sdk/edit-api > WchInlineEditService > registerComponent
WchInlineEditService.registerComponent() method
Registers a particular DOM element as editable
Signature:
registerComponent(nativeElement: any, accessor: AccessorType, onRenderingContext: Observable<RenderingContext>): Observable<EventTargetLike>;
Parameters
Parameter | Type | Description |
---|---|---|
nativeElement | any |
the DOM element to be edited |
accessor | AccessorType |
string identifying the member in the content item record to be edited. The value of 'null' means the the content item itself will be edited. |
onRenderingContext | Observable<RenderingContext> |
the rendering context associated with the edit operation. The same DOM element might represent multiple contexts over time |
Returns:
Observable
the observable representing the registration result. The observable exposes an event producer that a client can attach to to receive edit events. The registration will only take place when subscribing to the observable and it will end when unsubscribing.