# @acoustic-content-sdk/edit-api

> The edit API defines interfaces for consumers and providers of inline edit functionality.

Latest version **9.0.10076** (published 2020-03-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install @acoustic-content-sdk/edit-api
pnpm add @acoustic-content-sdk/edit-api
yarn add @acoustic-content-sdk/edit-api
bun add @acoustic-content-sdk/edit-api
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 9.0.10076 |
| Published | 2020-03-26 |
| First published | 2019-11-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 203.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Carsten Leue |
| Maintainers | carstenleue, daherbst, jim.patrick, joe.john, kevintap, mburati, neelkanthpatel, orenaksakal |
| Keywords | acoustic, acoustic-content, sdk |

## Links

- npm: https://www.npmjs.com/package/@acoustic-content-sdk/edit-api
- npm.io page: https://npm.io/package/@acoustic-content-sdk/edit-api

## Dependencies (1)

- [@acoustic-content-sdk/api](https://npm.io/package/@acoustic-content-sdk/api.md) 9.0.10076

## Recent versions

- 9.0.10076 (latest) — 2020-03-26
- 8.0.498 (beta) — 2019-11-30
- 9.0.10067 — 2020-03-25
- 9.0.10040 — 2020-03-20
- 9.0.10034 — 2020-03-20
- 9.0.495 — 2020-03-09
- 9.0.493 — 2020-03-08
- 9.0.462 — 2020-03-05
- 9.0.407 — 2020-02-28
- 9.0.384 — 2020-02-25
- 9.0.361 — 2020-02-21
- 9.0.360 — 2020-02-21
- 9.0.271 — 2020-02-11
- 9.0.270 — 2020-02-11
- 9.0.251 — 2020-02-07
- … 6 more at https://npm.io/package/@acoustic-content-sdk/edit-api/versions

## README

<a name="_df10a589ba1d83cde5a0738afd3f3d87fb783a2da144a2648870c21dba232f94"></a>
[![npm](https://img.shields.io/npm/v/@acoustic-content-sdk/edit-api.svg?style=flat-square)](https://www.npmjs.com/package/@acoustic-content-sdk/edit-api)

# Table of Contents

- [Inline Edit Provider](#_5db28c43c0e6bc54f89b5a2cdc75693f61fa1478172c8f8eaedaf6138677e168)
- [Inline Edit Service](#_5eb5aae85e86468909db7745ff1c9df3f0ec6c30798f5f81d948a9fca47cd186)
- [API Documentation](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679)

## General Concepts

The inline edit APIs define how an application can register DOM elements to be inline editable and also an API how an implementor of inline edit functionality can hook into the system. The purpose of the consumer facing interface `WchInlineEditServiceV2` is to make it convenient to use the service, the purpose of the provider facing interface `WchInlineEditProviderV2` to implement the service. The glue layer between both is a generic implementation by the SDK.

Refer to the framework specific modules to learn how to access the services.

<a name="_5db28c43c0e6bc54f89b5a2cdc75693f61fa1478172c8f8eaedaf6138677e168"></a>
## Provider

The edit provider is a piece of javascript code that implements inline edit functionality. It is dynamically loaded by the SPA (typically via the SDK). The provider needs to conform to the following pattern:

### Initialization

The edit module implements the `WchInlineEditProviderV2` interface, i.e. it exposes a `register` function. This function will be invoked for each editable HTML element and allows the edit provider to attach the desired edit hooks to the elements. The method is provided with:

- 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

The result of a registration is an event provider. The purpose of this provider is to communicate inline edit operations on the HTML element to the host, i.e. the host registers for events on that event provider and the edit provider is responsible to firing these events (if the event is supported).

The event provider can optionally implement the `Disposable` interface. If implemented the host will call its `dispose` method after registration, before the HTML element gets removed from the DOM (so it's the inverse operation to the registration call).

### Notifications

The implementor of the `WchInlineEditProviderV2` MAY optionally also implement the `EventTargetLike` interface, i.e. be an event emitter. This allows the provider to communicate information to the SDK, e.g. about enabled or disabled inline edit mode.

Currently supported notifications are:

- `wchInlineEditStart` to notify about entering inline edit mode
- `wchInlineEditEnd` to notify about leaving inline edit mode

<a name="_5eb5aae85e86468909db7745ff1c9df3f0ec6c30798f5f81d948a9fca47cd186"></a>
## WchInlineEditService

The `WchInlineEditServiceV2` interface allows a client to interact with the inline edit implementation. The implementation of this interface makes sure to load the inline edit provider and to fulfill the interface contract with the provider.

A consumer of this interface calls the `registerComponent` message for each HTML element that is supposed to be edited. The result of this call is an [Observable](http://reactivex.io/rxjs/class/es6/Observable.js~Observable.html). The inline edit registration begins as soon as someone subscribes to this observable and ends as soon as this subscription ends. It is in the responsibility of the consumer to make sure that the HTML element exists for the duration of the subscription.

<a name="_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679)

## edit-api package

The edit API defines interfaces for consumers and providers of inline edit functionality.

## Interfaces

|  Interface | Description |
|  --- | --- |
|  [DataTransferContentItem](#_2271fcabd6020cc5261fbc222b2840a90653b0f22fa152c8411db29500d17cf2) | Data transfer format for content items |
|  [Disposable](#_e344a57a18362df3102de16887a6f6a04fcb9afe317c9dd02586bff670038116) | Implemented by objects that expose a life cycle. Calling the dispose method signals the end of this life cycle. |
|  [InlineEditSelectionProvider](#_7a1b85c7b793415e9a658421cdaee2f857399706116c595788c7e3635a1740f6) | Service that exposes inline edit info |
|  [WchConfig](#_f8a85abb788d0a1b5d8df32f14813134dcb16617f2cc8cc86bb6740915d74cd2) | Exposes server side configuration for the current tenant |
|  [WchEditableEvent](#_39e676815714733b4ce714c4c75116eb51cd0a38fbb475d0a40bee84d3beb9fa) | Event issued by the edit provider. |
|  [WchInlineEditEvent](#_efc46484e8ba4031ed3c30e2cdc298000610e9dcaf010d767618cdc1d001d258) | Event issued by the edit library |
|  [WchInlineEditProvider](#_4badacd24f9615a3016041b6463fc4d4863cda57226f133e6d680619419de608) |  |
|  [WchInlineEditProviderV2](#_744468f2dc8a874baf95890c033193b5164edb5de0fd7cbc48894f6675e23728) | Interface exposed by an inline edit provider implementation<!-- -->Implementors may also implement <code>EventTargetLike</code> to send item independent events |
|  [WchInlineEditRequireMap](#_65dd160d679d4abf4c25d2d242f0c98469954e875f753278d7dc57defa1ab35f) | Helper interface that defines the mappings from module name to actual type |
|  [WchInlineEditRequireMapV2](#_0caf5b2f9d9f861344042759c0c761fe0fa9f62538e94b8a919c3ee84d9f5157) | 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](#_6e7dcda9aa64d068af55b868a17714db4001b2b95605392b25686b38b75e3bb7) | Implementation of the edit service used by the wchEditable directive. |
|  [WchInlineEditServiceV2](#_c2a52ed4aa87fad1a4bcbeb766306b9a39a719ae1aaeec6b897b1d91c73b6dc5) | Implementation of the edit service used by the wchEditable directive. |

## Variables

|  Variable | Description |
|  --- | --- |
|  [ACOUSTIC\_ACTIVE\_PAGE\_MODULE](#_fb3e831ac691806421cf7ce232bd2142b9057db3d0f23ace88e32964d4ef9179) | Token used to require the active page service PromiseLike<ActivePage> |
|  [ACOUSTIC\_CONFIG\_MODULE](#_58d7125a7a917e88c2c0ab3164b700ff82be8a2b61dd25e9f7b26429912a0c79) | Token used to require the \[\[WchConfig\]\] service PromiseLike<WchConfig> |
|  [ACOUSTIC\_HTTP\_MODULE](#_c00f0086017e48b75f2f506dbbc7b29311af6fab5c2731517a27015b226bf9d0) | Token used to access the http service PromiseLike<HttpService> |
|  [ACOUSTIC\_INFO\_MODULE](#_f18fd28b9e532a859d5ef70a85039480efe4231dcb0f8210dd3597c5017459e1) | Token used to require the \[\[WchInfo\]\] service PromiseLike<UrlConfig> |
|  [ACOUSTIC\_LOGGER\_MODULE](#_0b1b8907337d572228800c691b70550f9ac717957c43ea00839edbff80cc83ef) | Token used to require the \[\[LoggerService\]\] PromiseLike<LoggerService> |
|  [ATTR\_DATA\_SELECTABLE](#_ab7fb108049bc78ad71f0fba23f845d6f06bb40b930b12523fb38e28f8e598f1) |  |
|  [EVENT\_EDIT\_END](#_ad66aafffc711929efbd68e5925c3f9263da08830df5eb4476fc17a8791c9b17) |  |
|  [EVENT\_EDIT\_START](#_b6a7db5519e44125acf93d443c4c6e6cd2ff11bdbf4b7d02deec768462edf5f9) |  |
|  [EVENT\_INLINE\_EDIT\_END](#_f2b6403f163949ba97a2f95b599e5632ee78f3b06281b421cafa1bb5cca273d9) |  |
|  [EVENT\_INLINE\_EDIT\_SET\_SELECTED\_CELL](#_08d5b942e76d16286b9c6c049fbf2874bd6dcac2dea5360036a74ab3029cd624) |  |
|  [EVENT\_INLINE\_EDIT\_START](#_84bfa55a2d67b6fc5399cdd6d144bd26011748d10682ce772d6acef768e00b2c) |  |
|  [INLINE\_EDIT\_PROVIDER\_ID](#_cac44187e421a5f8e077ace84ca496a72eb2ecea03d1ca5a74cec733f563cc6c) | Identifier used to identify an [WchInlineEditProviderV2](#_744468f2dc8a874baf95890c033193b5164edb5de0fd7cbc48894f6675e23728) instance on a context, e.g. the window |
|  [TRANSFER\_FORMAT](#_71a5a7339ebf0f6120f613c5079aafb6432c47ccaf5669466cae6df6b9653eec) | Transfer format for our custom dnd components |
|  [VERSION](#_879f20f28b6355ab9d39566a1f7c96d30823c6e96def9d5d461e5ac7685284df) | Version and build number of the package |
|  [WCH\_ACTIVE\_PAGE\_MODULE](#_34dace6fb4520d7aa9dbfc590e66fc9ff1fd4afb1774823abfc38c2382be7780) |  |
|  [WCH\_CONFIG\_MODULE](#_ffce60cb576e59d8a7497dc380b812032f3f9becfa3d568f76eecd13ddb98e79) |  |
|  [WCH\_HTTP\_MODULE](#_4efe4f6f397f9234c284b7efb4c00414503363296092e91aa42bd46903d1697c) |  |
|  [WCH\_INFO\_MODULE](#_7e4e1776d67f527e47a180d6539acece0e08e76c661afa77007fe4a1883b5d12) |  |
|  [WCH\_LOGGER\_MODULE](#_79e93d7cf866a28f90a152bec207f1108339f1333c402b27b24b7f9505b02ec6) |  |

## Type Aliases

|  Type Alias | Description |
|  --- | --- |
|  [AccessorType](#_4311e33443901c42ca941fc567417395dd045d6006c6a403e39a7265d7897929) | 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 <code>null</code> denotes the root level element. |
|  [EventTargetLike](#_fbac4783f7a901c5566718ac4c9221690fca0626b506e691d5eacf826b0679df) |  |
|  [WchInlineEditRegistration](#_535f3a2714a54023de2e2a70a24bdf2f1ba5a13b7a2d4f19a2734c0c96aef0f6) |  |
|  [WchInlineEditRegistrationResult](#_2fe55ecc0b27050ef7aedb69acbc21aa0f87aa7cb99d4e8a33535719a2aaaf5a) | Result of an inline edit registration. This is at least an event emitter but may optionally also expose the <code>Disposable</code> interface to allow deregistration |
|  [WchInlineEditRegistrationV2](#_faf21ba64aab77cdafdc1ed3710a1517fec85987ee117b20d15c971ba0ccd936) | Type definition of the register method that allows to register DOM elements with an inline edit provider. |
|  [WchInlineEditRequire](#_0546a33716078b4fe14e89627a01e3009499951d6e285f319f5cf2964699e399) | Interface of the require function, strongly typed |
|  [WchInlineEditRequireV2](#_001d0eea4eed08eddcc9df4a70c8d6114eecb93aa26937f54f729fa764a8fd1b) | Interface of the require function, strongly typed |


<a name="_df10a589ba1d83cde5a0738afd3f3d87fb783a2da144a2648870c21dba232f94"></a>

<a name="_2271fcabd6020cc5261fbc222b2840a90653b0f22fa152c8411db29500d17cf2"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [DataTransferContentItem](#_2271fcabd6020cc5261fbc222b2840a90653b0f22fa152c8411db29500d17cf2)

## DataTransferContentItem interface

Data transfer format for content items

<b>Signature:</b>

```typescript
export interface DataTransferContentItem 
```

## Properties

|  Property | Type | Description |
|  --- | --- | --- |
|  [accessor](#_ab7264b458186e0a50893695f60462338c2922ed8596e51767dcf312ba144a34) | <code>AccessorType</code> | The accessor string |
|  [id](#_746779b82010476806eae550902b99a849f14a36b1688273e224f88238aad56f) | <code>string</code> | ID of the content item |


<a name="_e344a57a18362df3102de16887a6f6a04fcb9afe317c9dd02586bff670038116"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [Disposable](#_e344a57a18362df3102de16887a6f6a04fcb9afe317c9dd02586bff670038116)

## Disposable interface

Implemented by objects that expose a life cycle. Calling the dispose method signals the end of this life cycle.

<b>Signature:</b>

```typescript
export interface Disposable 
```

## Properties

|  Property | Type | Description |
|  --- | --- | --- |
|  [dispose](#_fe79dcf65a9ad4217702815f15e4020bbe56d1e97f9889854a78330de36932ae) | <code>() =&gt; void</code> |  |


<a name="_7a1b85c7b793415e9a658421cdaee2f857399706116c595788c7e3635a1740f6"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [InlineEditSelectionProvider](#_7a1b85c7b793415e9a658421cdaee2f857399706116c595788c7e3635a1740f6)

## InlineEditSelectionProvider interface

Service that exposes inline edit info

<b>Signature:</b>

```typescript
export interface InlineEditSelectionProvider 
```

## Properties

|  Property | Type | Description |
|  --- | --- | --- |
|  [selectedCell$](#_7ef173e83052045de50c3ce73bf390ec41e8d96b9e07933afc2271eae499a5b3) | <code>Observable&lt;string &#124; undefined&gt;</code> | Captures the currently selected cell. The return value is either just an ID or <code>ID#accessor</code>. If a cell is deselected, the service returns i |


<a name="_f8a85abb788d0a1b5d8df32f14813134dcb16617f2cc8cc86bb6740915d74cd2"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [WchConfig](#_f8a85abb788d0a1b5d8df32f14813134dcb16617f2cc8cc86bb6740915d74cd2)

## WchConfig interface

Exposes server side configuration for the current tenant

<b>Signature:</b>

```typescript
export interface WchConfig 
```

## Properties

|  Property | Type | Description |
|  --- | --- | --- |
|  [apiUrl](#_101ba3cd250c1eb783133cf9bb8cf1453b4e57c327d89e8907a15293140d0fed) | <code>URL</code> | API URL for the non-preview host |
|  [authoringUIBaseUrl](#_fd13cc45f3495e8f70d4245a206a08ba8240af54e7d4ecdb376955beb0785b5f) | <code>URL</code> | URL of the authoring host |
|  [deliveryUrl](#_89c9a4230fe2aa21a2eb2d41634fbd0804ddfcc8a895ee83bb9153cbb9231157) | <code>URL</code> | delivery URL for the non-preview host |
|  [previewApiUrl](#_573e2904c3da2082951fba97da56e9e2e33e80164317480ee8773ba8930a3425) | <code>URL</code> | API URL for the preview host |
|  [previewDeliveryUrl](#_c486b535be3fa678b6494c0e634e84190495516baf2e0684b4c3849b10ed5d50) | <code>URL</code> | delivery URL for the preview host |


<a name="_39e676815714733b4ce714c4c75116eb51cd0a38fbb475d0a40bee84d3beb9fa"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [WchEditableEvent](#_39e676815714733b4ce714c4c75116eb51cd0a38fbb475d0a40bee84d3beb9fa)

## WchEditableEvent interface

Event issued by the edit provider.

<b>Signature:</b>

```typescript
export interface WchEditableEvent 
```

## Properties

|  Property | Type | Description |
|  --- | --- | --- |
|  [data](#_a3728c2c4f81dac6485ec5525b10f984636762f555eb0c56544d1292d1bac87e) | <code>any</code> |  |
|  [target](#_e76755f6ee9fccd92dadeb5474287ed4b9757be28b6a8c73bda3b48bcbf50d0a) | <code>HTMLElement</code> |  |
|  [type](#_8818f684f71abed90fcedf57ef65536ec8417cb2a97fa859ece3bfd7eac5b047) | <code>string</code> |  |


<a name="_efc46484e8ba4031ed3c30e2cdc298000610e9dcaf010d767618cdc1d001d258"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [WchInlineEditEvent](#_efc46484e8ba4031ed3c30e2cdc298000610e9dcaf010d767618cdc1d001d258)

## WchInlineEditEvent interface

Event issued by the edit library

<b>Signature:</b>

```typescript
export interface WchInlineEditEvent 
```

## Properties

|  Property | Type | Description |
|  --- | --- | --- |
|  [data](#_6010d1290fa34930e67f18d5ecf48c5471214c6bae7427f9f8a6c372a8cfb6d2) | <code>any</code> |  |
|  [type](#_e29f7ae0413779748bac80d5c1476d079794c34a444446dc0e8e160b09599de9) | <code>string</code> |  |


<a name="_4badacd24f9615a3016041b6463fc4d4863cda57226f133e6d680619419de608"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [WchInlineEditProvider](#_4badacd24f9615a3016041b6463fc4d4863cda57226f133e6d680619419de608)

## WchInlineEditProvider interface

> Warning: This API is now obsolete.
> 
> use [WchInlineEditProviderV2](#_744468f2dc8a874baf95890c033193b5164edb5de0fd7cbc48894f6675e23728) instead
> 

<b>Signature:</b>

```typescript
export interface WchInlineEditProvider 
```

## Properties

|  Property | Type | Description |
|  --- | --- | --- |
|  [register](#_edca828cd5a089cee91bc1c5f1c56f5bef089e55b99d5c34d2d7a3eba3e6bbce) | <code>WchInlineEditRegistration</code> |  |


<a name="_744468f2dc8a874baf95890c033193b5164edb5de0fd7cbc48894f6675e23728"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [WchInlineEditProviderV2](#_744468f2dc8a874baf95890c033193b5164edb5de0fd7cbc48894f6675e23728)

## WchInlineEditProviderV2 interface

Interface exposed by an inline edit provider implementation

Implementors may also implement `EventTargetLike` to send item independent events

<b>Signature:</b>

```typescript
export interface WchInlineEditProviderV2 
```

## Properties

|  Property | Type | Description |
|  --- | --- | --- |
|  [register](#_1fa24d9d68ce9b0629fbdd08bac577a216c68549f5f6845fe49177b8fa7f3235) | <code>WchInlineEditRegistrationV2</code> | The register method that allows to register DOM elements with the provider |


<a name="_65dd160d679d4abf4c25d2d242f0c98469954e875f753278d7dc57defa1ab35f"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [WchInlineEditRequireMap](#_65dd160d679d4abf4c25d2d242f0c98469954e875f753278d7dc57defa1ab35f)

## WchInlineEditRequireMap interface

Helper interface that defines the mappings from module name to actual type

<b>Signature:</b>

```typescript
export interface WchInlineEditRequireMap 
```

## Properties

|  Property | Type | Description |
|  --- | --- | --- |
|  ["wch-active-page"](#_10b7d6aba13d565ec3ff3304015d0f4476dfb6bc62276c7de1ba5b7d876c482c) | <code>PromiseLike&lt;ActivePage&gt;</code> |  |
|  ["wch-config"](#_b0ea2fd3b367f69d03f85fa40dbe0423283480608190c8a134359448154d4dd2) | <code>PromiseLike&lt;WchConfig&gt;</code> |  |
|  ["wch-http"](#_bb99250c52780cae076c78bc662106eb5016aeeb543e5f1ffe096973e613f72f) | <code>PromiseLike&lt;WchHttp&gt;</code> |  |
|  ["wch-info"](#_554c2568a43b3a30ef3c299bd37f4f75518056838aceb7de6513454bdd934c5f) | <code>PromiseLike&lt;UrlConfig&gt;</code> |  |
|  ["wch-logger"](#_b337bbee19a84f25f65cced6c3f7be3e41bc2d358ec5a794a7f37eb3cb92086f) | <code>PromiseLike&lt;LoggerService&gt;</code> |  |


<a name="_0caf5b2f9d9f861344042759c0c761fe0fa9f62538e94b8a919c3ee84d9f5157"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [WchInlineEditRequireMapV2](#_0caf5b2f9d9f861344042759c0c761fe0fa9f62538e94b8a919c3ee84d9f5157)

## WchInlineEditRequireMapV2 interface

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.

<b>Signature:</b>

```typescript
export interface WchInlineEditRequireMapV2 
```

## Properties

|  Property | Type | Description |
|  --- | --- | --- |
|  ["wch-active-page"](#_8713465010512d15ca42083ec6d16c02b95517db1ef48fcf20f6b72b4332753d) | <code>PromiseLike&lt;ActivePageV2&gt;</code> |  |
|  ["wch-config"](#_be83d3e19a42de782ac649704a35cbf4120ebc359713c5e1977e37bc27340141) | <code>PromiseLike&lt;WchConfig&gt;</code> |  |
|  ["wch-info"](#_053241b6125b64bedec1d535cf780ecde2098d184dd41cf2354dd3420cc48200) | <code>PromiseLike&lt;UrlConfig&gt;</code> |  |
|  ["wch-logger"](#_2111ae610d2d88ee4062c2993ed65d6804762c372c20d7b89fe06d9ad76a6bc6) | <code>PromiseLike&lt;LoggerService&gt;</code> |  |


<a name="_6e7dcda9aa64d068af55b868a17714db4001b2b95605392b25686b38b75e3bb7"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [WchInlineEditService](#_6e7dcda9aa64d068af55b868a17714db4001b2b95605392b25686b38b75e3bb7)

## WchInlineEditService interface

Implementation of the edit service used by the wchEditable directive.

<b>Signature:</b>

```typescript
export interface WchInlineEditService 
```

## Methods

|  Method | Description |
|  --- | --- |
|  [fromEvent(aName)](#_9b26acc2d878a248c2f18e14cfa5bea7f995b75b1c765b026a65b568b6fd358e) | Attaches to an event issued by the edit library |
|  [registerComponent(nativeElement, accessor, onRenderingContext)](#_9d9e1e842414952eb9d11c1b9c7831d2c32a4929cb95c9545a5417645100c69c) | Registers a particular DOM element as editable |


<a name="_c2a52ed4aa87fad1a4bcbeb766306b9a39a719ae1aaeec6b897b1d91c73b6dc5"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [WchInlineEditServiceV2](#_c2a52ed4aa87fad1a4bcbeb766306b9a39a719ae1aaeec6b897b1d91c73b6dc5)

## WchInlineEditServiceV2 interface

Implementation of the edit service used by the wchEditable directive.

<b>Signature:</b>

```typescript
export interface WchInlineEditServiceV2 
```

## Methods

|  Method | Description |
|  --- | --- |
|  [fromEvent(aName)](#_baabaf001fa22b89fbe471fa1a45e598e85b1028b5ffca2fb368cca43121c022) | Attaches to an event issued by the edit library |
|  [registerComponent(nativeElement, accessor, renderingContext$)](#_1fdbee445d6c8798494cac7b504c2ccd6ff3cc492ea6fa8a8f603f8bd5107da9) | Registers a particular DOM element as editable |


<a name="_fb3e831ac691806421cf7ce232bd2142b9057db3d0f23ace88e32964d4ef9179"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [ACOUSTIC\_ACTIVE\_PAGE\_MODULE](#_fb3e831ac691806421cf7ce232bd2142b9057db3d0f23ace88e32964d4ef9179)

## ACOUSTIC\_ACTIVE\_PAGE\_MODULE variable

Token used to require the active page service

 PromiseLike<ActivePage>

<b>Signature:</b>

```typescript
ACOUSTIC_ACTIVE_PAGE_MODULE = "wch-active-page"
```

<a name="_58d7125a7a917e88c2c0ab3164b700ff82be8a2b61dd25e9f7b26429912a0c79"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [ACOUSTIC\_CONFIG\_MODULE](#_58d7125a7a917e88c2c0ab3164b700ff82be8a2b61dd25e9f7b26429912a0c79)

## ACOUSTIC\_CONFIG\_MODULE variable

Token used to require the \[\[WchConfig\]\] service

 PromiseLike<WchConfig>

<b>Signature:</b>

```typescript
ACOUSTIC_CONFIG_MODULE = "wch-config"
```

<a name="_c00f0086017e48b75f2f506dbbc7b29311af6fab5c2731517a27015b226bf9d0"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [ACOUSTIC\_HTTP\_MODULE](#_c00f0086017e48b75f2f506dbbc7b29311af6fab5c2731517a27015b226bf9d0)

## ACOUSTIC\_HTTP\_MODULE variable

Token used to access the http service

 PromiseLike<HttpService>

<b>Signature:</b>

```typescript
ACOUSTIC_HTTP_MODULE = "wch-http"
```

<a name="_f18fd28b9e532a859d5ef70a85039480efe4231dcb0f8210dd3597c5017459e1"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [ACOUSTIC\_INFO\_MODULE](#_f18fd28b9e532a859d5ef70a85039480efe4231dcb0f8210dd3597c5017459e1)

## ACOUSTIC\_INFO\_MODULE variable

Token used to require the \[\[WchInfo\]\] service

 PromiseLike<UrlConfig>

<b>Signature:</b>

```typescript
ACOUSTIC_INFO_MODULE = "wch-info"
```

<a name="_0b1b8907337d572228800c691b70550f9ac717957c43ea00839edbff80cc83ef"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [ACOUSTIC\_LOGGER\_MODULE](#_0b1b8907337d572228800c691b70550f9ac717957c43ea00839edbff80cc83ef)

## ACOUSTIC\_LOGGER\_MODULE variable

Token used to require the \[\[LoggerService\]\]

 PromiseLike<LoggerService>

<b>Signature:</b>

```typescript
ACOUSTIC_LOGGER_MODULE = "wch-logger"
```

<a name="_ab7fb108049bc78ad71f0fba23f845d6f06bb40b930b12523fb38e28f8e598f1"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [ATTR\_DATA\_SELECTABLE](#_ab7fb108049bc78ad71f0fba23f845d6f06bb40b930b12523fb38e28f8e598f1)

## ATTR\_DATA\_SELECTABLE variable

<b>Signature:</b>

```typescript
ATTR_DATA_SELECTABLE = "data-wch-selectable"
```

<a name="_ad66aafffc711929efbd68e5925c3f9263da08830df5eb4476fc17a8791c9b17"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [EVENT\_EDIT\_END](#_ad66aafffc711929efbd68e5925c3f9263da08830df5eb4476fc17a8791c9b17)

## EVENT\_EDIT\_END variable

<b>Signature:</b>

```typescript
EVENT_EDIT_END = "EVENT_EDIT_END"
```

<a name="_b6a7db5519e44125acf93d443c4c6e6cd2ff11bdbf4b7d02deec768462edf5f9"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [EVENT\_EDIT\_START](#_b6a7db5519e44125acf93d443c4c6e6cd2ff11bdbf4b7d02deec768462edf5f9)

## EVENT\_EDIT\_START variable

<b>Signature:</b>

```typescript
EVENT_EDIT_START = "EVENT_EDIT_START"
```

<a name="_f2b6403f163949ba97a2f95b599e5632ee78f3b06281b421cafa1bb5cca273d9"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [EVENT\_INLINE\_EDIT\_END](#_f2b6403f163949ba97a2f95b599e5632ee78f3b06281b421cafa1bb5cca273d9)

## EVENT\_INLINE\_EDIT\_END variable

<b>Signature:</b>

```typescript
EVENT_INLINE_EDIT_END = "EVENT_INLINE_EDIT_END"
```

<a name="_08d5b942e76d16286b9c6c049fbf2874bd6dcac2dea5360036a74ab3029cd624"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [EVENT\_INLINE\_EDIT\_SET\_SELECTED\_CELL](#_08d5b942e76d16286b9c6c049fbf2874bd6dcac2dea5360036a74ab3029cd624)

## EVENT\_INLINE\_EDIT\_SET\_SELECTED\_CELL variable

<b>Signature:</b>

```typescript
EVENT_INLINE_EDIT_SET_SELECTED_CELL = "EVENT_INLINE_EDIT_SET_SELECTED_CELL"
```

<a name="_84bfa55a2d67b6fc5399cdd6d144bd26011748d10682ce772d6acef768e00b2c"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [EVENT\_INLINE\_EDIT\_START](#_84bfa55a2d67b6fc5399cdd6d144bd26011748d10682ce772d6acef768e00b2c)

## EVENT\_INLINE\_EDIT\_START variable

<b>Signature:</b>

```typescript
EVENT_INLINE_EDIT_START = "EVENT_INLINE_EDIT_START"
```

<a name="_cac44187e421a5f8e077ace84ca496a72eb2ecea03d1ca5a74cec733f563cc6c"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [INLINE\_EDIT\_PROVIDER\_ID](#_cac44187e421a5f8e077ace84ca496a72eb2ecea03d1ca5a74cec733f563cc6c)

## INLINE\_EDIT\_PROVIDER\_ID variable

Identifier used to identify an [WchInlineEditProviderV2](#_744468f2dc8a874baf95890c033193b5164edb5de0fd7cbc48894f6675e23728) instance on a context, e.g. the window

<b>Signature:</b>

```typescript
INLINE_EDIT_PROVIDER_ID = "@acoustic-content-sdk/inline-edit-provider"
```

<a name="_71a5a7339ebf0f6120f613c5079aafb6432c47ccaf5669466cae6df6b9653eec"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [TRANSFER\_FORMAT](#_71a5a7339ebf0f6120f613c5079aafb6432c47ccaf5669466cae6df6b9653eec)

## TRANSFER\_FORMAT variable

Transfer format for our custom dnd components

<b>Signature:</b>

```typescript
TRANSFER_FORMAT = "application/x-dnd-fragment"
```

<a name="_879f20f28b6355ab9d39566a1f7c96d30823c6e96def9d5d461e5ac7685284df"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [VERSION](#_879f20f28b6355ab9d39566a1f7c96d30823c6e96def9d5d461e5ac7685284df)

## VERSION variable

Version and build number of the package

<b>Signature:</b>

```typescript
VERSION: {
    version: {
        major: string;
        minor: string;
        patch: string;
        branch: string;
    };
    build: Date;
}
```

<a name="_34dace6fb4520d7aa9dbfc590e66fc9ff1fd4afb1774823abfc38c2382be7780"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [WCH\_ACTIVE\_PAGE\_MODULE](#_34dace6fb4520d7aa9dbfc590e66fc9ff1fd4afb1774823abfc38c2382be7780)

## WCH\_ACTIVE\_PAGE\_MODULE variable

> Warning: This API is now obsolete.
> 
> use [ACOUSTIC\_ACTIVE\_PAGE\_MODULE](#_fb3e831ac691806421cf7ce232bd2142b9057db3d0f23ace88e32964d4ef9179) instead
> 

<b>Signature:</b>

```typescript
WCH_ACTIVE_PAGE_MODULE = "wch-active-page"
```

<a name="_ffce60cb576e59d8a7497dc380b812032f3f9becfa3d568f76eecd13ddb98e79"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [WCH\_CONFIG\_MODULE](#_ffce60cb576e59d8a7497dc380b812032f3f9becfa3d568f76eecd13ddb98e79)

## WCH\_CONFIG\_MODULE variable

> Warning: This API is now obsolete.
> 
> use [ACOUSTIC\_CONFIG\_MODULE](#_58d7125a7a917e88c2c0ab3164b700ff82be8a2b61dd25e9f7b26429912a0c79) instead
> 

<b>Signature:</b>

```typescript
WCH_CONFIG_MODULE = "wch-config"
```

<a name="_4efe4f6f397f9234c284b7efb4c00414503363296092e91aa42bd46903d1697c"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [WCH\_HTTP\_MODULE](#_4efe4f6f397f9234c284b7efb4c00414503363296092e91aa42bd46903d1697c)

## WCH\_HTTP\_MODULE variable

> Warning: This API is now obsolete.
> 
> use [ACOUSTIC\_HTTP\_MODULE](#_c00f0086017e48b75f2f506dbbc7b29311af6fab5c2731517a27015b226bf9d0) instead
> 

<b>Signature:</b>

```typescript
WCH_HTTP_MODULE = "wch-http"
```

<a name="_7e4e1776d67f527e47a180d6539acece0e08e76c661afa77007fe4a1883b5d12"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [WCH\_INFO\_MODULE](#_7e4e1776d67f527e47a180d6539acece0e08e76c661afa77007fe4a1883b5d12)

## WCH\_INFO\_MODULE variable

> Warning: This API is now obsolete.
> 
> use [ACOUSTIC\_INFO\_MODULE](#_f18fd28b9e532a859d5ef70a85039480efe4231dcb0f8210dd3597c5017459e1) instead
> 

<b>Signature:</b>

```typescript
WCH_INFO_MODULE = "wch-info"
```

<a name="_79e93d7cf866a28f90a152bec207f1108339f1333c402b27b24b7f9505b02ec6"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [WCH\_LOGGER\_MODULE](#_79e93d7cf866a28f90a152bec207f1108339f1333c402b27b24b7f9505b02ec6)

## WCH\_LOGGER\_MODULE variable

> Warning: This API is now obsolete.
> 
> use [ACOUSTIC\_LOGGER\_MODULE](#_0b1b8907337d572228800c691b70550f9ac717957c43ea00839edbff80cc83ef) instead
> 

<b>Signature:</b>

```typescript
WCH_LOGGER_MODULE = "wch-logger"
```

<a name="_4311e33443901c42ca941fc567417395dd045d6006c6a403e39a7265d7897929"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [AccessorType](#_4311e33443901c42ca941fc567417395dd045d6006c6a403e39a7265d7897929)

## AccessorType type

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.

<b>Signature:</b>

```typescript
export declare type AccessorType = string | null;
```

<a name="_fbac4783f7a901c5566718ac4c9221690fca0626b506e691d5eacf826b0679df"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [EventTargetLike](#_fbac4783f7a901c5566718ac4c9221690fca0626b506e691d5eacf826b0679df)

## EventTargetLike type

<b>Signature:</b>

```typescript
export declare type EventTargetLike = Parameters<typeof fromEvent>[0];
```

<a name="_535f3a2714a54023de2e2a70a24bdf2f1ba5a13b7a2d4f19a2734c0c96aef0f6"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [WchInlineEditRegistration](#_535f3a2714a54023de2e2a70a24bdf2f1ba5a13b7a2d4f19a2734c0c96aef0f6)

## WchInlineEditRegistration type

> Warning: This API is now obsolete.
> 
> use [WchInlineEditRegistrationV2](#_faf21ba64aab77cdafdc1ed3710a1517fec85987ee117b20d15c971ba0ccd936) instead
> 

<b>Signature:</b>

```typescript
export declare type WchInlineEditRegistration = (nativeElement: any, accessor: AccessorType, onRenderingContext: Observable<RenderingContext>) => WchInlineEditRegistrationResult;
```

<a name="_2fe55ecc0b27050ef7aedb69acbc21aa0f87aa7cb99d4e8a33535719a2aaaf5a"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [WchInlineEditRegistrationResult](#_2fe55ecc0b27050ef7aedb69acbc21aa0f87aa7cb99d4e8a33535719a2aaaf5a)

## WchInlineEditRegistrationResult type

Result of an inline edit registration. This is at least an event emitter but may optionally also expose the `Disposable` interface to allow deregistration

<b>Signature:</b>

```typescript
export declare type WchInlineEditRegistrationResult = EventTargetLike | (EventTargetLike & Disposable);
```

<a name="_faf21ba64aab77cdafdc1ed3710a1517fec85987ee117b20d15c971ba0ccd936"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [WchInlineEditRegistrationV2](#_faf21ba64aab77cdafdc1ed3710a1517fec85987ee117b20d15c971ba0ccd936)

## WchInlineEditRegistrationV2 type

Type definition of the register method that allows to register DOM elements with an inline edit provider.

<b>Signature:</b>

```typescript
export declare type WchInlineEditRegistrationV2 = (nativeElement: any, accessor: AccessorType, renderingContext$: Observable<RenderingContextV2>) => WchInlineEditRegistrationResult;
```

<a name="_0546a33716078b4fe14e89627a01e3009499951d6e285f319f5cf2964699e399"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [WchInlineEditRequire](#_0546a33716078b4fe14e89627a01e3009499951d6e285f319f5cf2964699e399)

## WchInlineEditRequire type

Interface of the require function, strongly typed

<b>Signature:</b>

```typescript
export declare type WchInlineEditRequire = (<T extends keyof WchInlineEditRequireMap>(aModule: T) => WchInlineEditRequireMap[T]) & ((aModule: string) => PromiseLike<string>);
```

<a name="_001d0eea4eed08eddcc9df4a70c8d6114eecb93aa26937f54f729fa764a8fd1b"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [WchInlineEditRequireV2](#_001d0eea4eed08eddcc9df4a70c8d6114eecb93aa26937f54f729fa764a8fd1b)

## WchInlineEditRequireV2 type

Interface of the require function, strongly typed

<b>Signature:</b>

```typescript
export declare type WchInlineEditRequireV2 = (<T extends keyof WchInlineEditRequireMapV2>(aModule: T) => WchInlineEditRequireMapV2[T]) & ((aModule: string) => PromiseLike<string>);
```

<a name="_ab7264b458186e0a50893695f60462338c2922ed8596e51767dcf312ba144a34"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [DataTransferContentItem](#_2271fcabd6020cc5261fbc222b2840a90653b0f22fa152c8411db29500d17cf2) &gt; [accessor](#_ab7264b458186e0a50893695f60462338c2922ed8596e51767dcf312ba144a34)

## DataTransferContentItem.accessor property

The accessor string

<b>Signature:</b>

```typescript
[KEY_ACCESSOR]: AccessorType;
```

<a name="_746779b82010476806eae550902b99a849f14a36b1688273e224f88238aad56f"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [DataTransferContentItem](#_2271fcabd6020cc5261fbc222b2840a90653b0f22fa152c8411db29500d17cf2) &gt; [id](#_746779b82010476806eae550902b99a849f14a36b1688273e224f88238aad56f)

## DataTransferContentItem.id property

ID of the content item

<b>Signature:</b>

```typescript
[KEY_ID]: string;
```

<a name="_fe79dcf65a9ad4217702815f15e4020bbe56d1e97f9889854a78330de36932ae"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [Disposable](#_e344a57a18362df3102de16887a6f6a04fcb9afe317c9dd02586bff670038116) &gt; [dispose](#_fe79dcf65a9ad4217702815f15e4020bbe56d1e97f9889854a78330de36932ae)

## Disposable.dispose property

<b>Signature:</b>

```typescript
dispose: () => void;
```

<a name="_7ef173e83052045de50c3ce73bf390ec41e8d96b9e07933afc2271eae499a5b3"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [InlineEditSelectionProvider](#_7a1b85c7b793415e9a658421cdaee2f857399706116c595788c7e3635a1740f6) &gt; [selectedCell$](#_7ef173e83052045de50c3ce73bf390ec41e8d96b9e07933afc2271eae499a5b3)

## InlineEditSelectionProvider.selectedCell$ property

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

<b>Signature:</b>

```typescript
selectedCell$: Observable<string | undefined>;
```

<a name="_a3728c2c4f81dac6485ec5525b10f984636762f555eb0c56544d1292d1bac87e"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [WchEditableEvent](#_39e676815714733b4ce714c4c75116eb51cd0a38fbb475d0a40bee84d3beb9fa) &gt; [data](#_a3728c2c4f81dac6485ec5525b10f984636762f555eb0c56544d1292d1bac87e)

## WchEditableEvent.data property

<b>Signature:</b>

```typescript
data: any;
```

<a name="_e76755f6ee9fccd92dadeb5474287ed4b9757be28b6a8c73bda3b48bcbf50d0a"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [WchEditableEvent](#_39e676815714733b4ce714c4c75116eb51cd0a38fbb475d0a40bee84d3beb9fa) &gt; [target](#_e76755f6ee9fccd92dadeb5474287ed4b9757be28b6a8c73bda3b48bcbf50d0a)

## WchEditableEvent.target property

<b>Signature:</b>

```typescript
target: HTMLElement;
```

<a name="_8818f684f71abed90fcedf57ef65536ec8417cb2a97fa859ece3bfd7eac5b047"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [WchEditableEvent](#_39e676815714733b4ce714c4c75116eb51cd0a38fbb475d0a40bee84d3beb9fa) &gt; [type](#_8818f684f71abed90fcedf57ef65536ec8417cb2a97fa859ece3bfd7eac5b047)

## WchEditableEvent.type property

<b>Signature:</b>

```typescript
type: string;
```

<a name="_101ba3cd250c1eb783133cf9bb8cf1453b4e57c327d89e8907a15293140d0fed"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [WchConfig](#_f8a85abb788d0a1b5d8df32f14813134dcb16617f2cc8cc86bb6740915d74cd2) &gt; [apiUrl](#_101ba3cd250c1eb783133cf9bb8cf1453b4e57c327d89e8907a15293140d0fed)

## WchConfig.apiUrl property

API URL for the non-preview host

<b>Signature:</b>

```typescript
readonly apiUrl: URL;
```

<a name="_fd13cc45f3495e8f70d4245a206a08ba8240af54e7d4ecdb376955beb0785b5f"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [WchConfig](#_f8a85abb788d0a1b5d8df32f14813134dcb16617f2cc8cc86bb6740915d74cd2) &gt; [authoringUIBaseUrl](#_fd13cc45f3495e8f70d4245a206a08ba8240af54e7d4ecdb376955beb0785b5f)

## WchConfig.authoringUIBaseUrl property

URL of the authoring host

<b>Signature:</b>

```typescript
readonly authoringUIBaseUrl: URL;
```

<a name="_89c9a4230fe2aa21a2eb2d41634fbd0804ddfcc8a895ee83bb9153cbb9231157"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [WchConfig](#_f8a85abb788d0a1b5d8df32f14813134dcb16617f2cc8cc86bb6740915d74cd2) &gt; [deliveryUrl](#_89c9a4230fe2aa21a2eb2d41634fbd0804ddfcc8a895ee83bb9153cbb9231157)

## WchConfig.deliveryUrl property

delivery URL for the non-preview host

<b>Signature:</b>

```typescript
readonly deliveryUrl: URL;
```

<a name="_573e2904c3da2082951fba97da56e9e2e33e80164317480ee8773ba8930a3425"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [WchConfig](#_f8a85abb788d0a1b5d8df32f14813134dcb16617f2cc8cc86bb6740915d74cd2) &gt; [previewApiUrl](#_573e2904c3da2082951fba97da56e9e2e33e80164317480ee8773ba8930a3425)

## WchConfig.previewApiUrl property

API URL for the preview host

<b>Signature:</b>

```typescript
readonly previewApiUrl: URL;
```

<a name="_c486b535be3fa678b6494c0e634e84190495516baf2e0684b4c3849b10ed5d50"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [WchConfig](#_f8a85abb788d0a1b5d8df32f14813134dcb16617f2cc8cc86bb6740915d74cd2) &gt; [previewDeliveryUrl](#_c486b535be3fa678b6494c0e634e84190495516baf2e0684b4c3849b10ed5d50)

## WchConfig.previewDeliveryUrl property

delivery URL for the preview host

<b>Signature:</b>

```typescript
readonly previewDeliveryUrl: URL;
```

<a name="_6010d1290fa34930e67f18d5ecf48c5471214c6bae7427f9f8a6c372a8cfb6d2"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [WchInlineEditEvent](#_efc46484e8ba4031ed3c30e2cdc298000610e9dcaf010d767618cdc1d001d258) &gt; [data](#_6010d1290fa34930e67f18d5ecf48c5471214c6bae7427f9f8a6c372a8cfb6d2)

## WchInlineEditEvent.data property

<b>Signature:</b>

```typescript
data: any;
```

<a name="_e29f7ae0413779748bac80d5c1476d079794c34a444446dc0e8e160b09599de9"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [WchInlineEditEvent](#_efc46484e8ba4031ed3c30e2cdc298000610e9dcaf010d767618cdc1d001d258) &gt; [type](#_e29f7ae0413779748bac80d5c1476d079794c34a444446dc0e8e160b09599de9)

## WchInlineEditEvent.type property

<b>Signature:</b>

```typescript
type: string;
```

<a name="_edca828cd5a089cee91bc1c5f1c56f5bef089e55b99d5c34d2d7a3eba3e6bbce"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [WchInlineEditProvider](#_4badacd24f9615a3016041b6463fc4d4863cda57226f133e6d680619419de608) &gt; [register](#_edca828cd5a089cee91bc1c5f1c56f5bef089e55b99d5c34d2d7a3eba3e6bbce)

## WchInlineEditProvider.register property

<b>Signature:</b>

```typescript
register: WchInlineEditRegistration;
```

<a name="_1fa24d9d68ce9b0629fbdd08bac577a216c68549f5f6845fe49177b8fa7f3235"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [WchInlineEditProviderV2](#_744468f2dc8a874baf95890c033193b5164edb5de0fd7cbc48894f6675e23728) &gt; [register](#_1fa24d9d68ce9b0629fbdd08bac577a216c68549f5f6845fe49177b8fa7f3235)

## WchInlineEditProviderV2.register property

The register method that allows to register DOM elements with the provider

<b>Signature:</b>

```typescript
register: WchInlineEditRegistrationV2;
```

<a name="_8713465010512d15ca42083ec6d16c02b95517db1ef48fcf20f6b72b4332753d"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [WchInlineEditRequireMapV2](#_0caf5b2f9d9f861344042759c0c761fe0fa9f62538e94b8a919c3ee84d9f5157) &gt; ["wch-active-page"](#_8713465010512d15ca42083ec6d16c02b95517db1ef48fcf20f6b72b4332753d)

## WchInlineEditRequireMapV2."wch-active-page" property

<b>Signature:</b>

```typescript
[ACOUSTIC_ACTIVE_PAGE_MODULE]: PromiseLike<ActivePageV2>;
```

<a name="_be83d3e19a42de782ac649704a35cbf4120ebc359713c5e1977e37bc27340141"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [WchInlineEditRequireMapV2](#_0caf5b2f9d9f861344042759c0c761fe0fa9f62538e94b8a919c3ee84d9f5157) &gt; ["wch-config"](#_be83d3e19a42de782ac649704a35cbf4120ebc359713c5e1977e37bc27340141)

## WchInlineEditRequireMapV2."wch-config" property

<b>Signature:</b>

```typescript
[ACOUSTIC_CONFIG_MODULE]: PromiseLike<WchConfig>;
```

<a name="_053241b6125b64bedec1d535cf780ecde2098d184dd41cf2354dd3420cc48200"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [WchInlineEditRequireMapV2](#_0caf5b2f9d9f861344042759c0c761fe0fa9f62538e94b8a919c3ee84d9f5157) &gt; ["wch-info"](#_053241b6125b64bedec1d535cf780ecde2098d184dd41cf2354dd3420cc48200)

## WchInlineEditRequireMapV2."wch-info" property

<b>Signature:</b>

```typescript
[ACOUSTIC_INFO_MODULE]: PromiseLike<UrlConfig>;
```

<a name="_2111ae610d2d88ee4062c2993ed65d6804762c372c20d7b89fe06d9ad76a6bc6"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [WchInlineEditRequireMapV2](#_0caf5b2f9d9f861344042759c0c761fe0fa9f62538e94b8a919c3ee84d9f5157) &gt; ["wch-logger"](#_2111ae610d2d88ee4062c2993ed65d6804762c372c20d7b89fe06d9ad76a6bc6)

## WchInlineEditRequireMapV2."wch-logger" property

<b>Signature:</b>

```typescript
[ACOUSTIC_LOGGER_MODULE]: PromiseLike<LoggerService>;
```

<a name="_baabaf001fa22b89fbe471fa1a45e598e85b1028b5ffca2fb368cca43121c022"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [WchInlineEditServiceV2](#_c2a52ed4aa87fad1a4bcbeb766306b9a39a719ae1aaeec6b897b1d91c73b6dc5) &gt; [fromEvent](#_baabaf001fa22b89fbe471fa1a45e598e85b1028b5ffca2fb368cca43121c022)

## WchInlineEditServiceV2.fromEvent() method

Attaches to an event issued by the edit library

<b>Signature:</b>

```typescript
fromEvent<T>(aName: string): Observable<T>;
```

## Parameters

|  Parameter | Type | Description |
|  --- | --- | --- |
|  aName | <code>string</code> | name of the event |

<b>Returns:</b>

`Observable<T>`

a stream of events


<a name="_1fdbee445d6c8798494cac7b504c2ccd6ff3cc492ea6fa8a8f603f8bd5107da9"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [WchInlineEditServiceV2](#_c2a52ed4aa87fad1a4bcbeb766306b9a39a719ae1aaeec6b897b1d91c73b6dc5) &gt; [registerComponent](#_1fdbee445d6c8798494cac7b504c2ccd6ff3cc492ea6fa8a8f603f8bd5107da9)

## WchInlineEditServiceV2.registerComponent() method

Registers a particular DOM element as editable

<b>Signature:</b>

```typescript
registerComponent(nativeElement: any, accessor: AccessorType, renderingContext$: Observable<RenderingContextV2>): Observable<EventTargetLike>;
```

## Parameters

|  Parameter | Type | Description |
|  --- | --- | --- |
|  nativeElement | <code>any</code> | the DOM element to be edited |
|  accessor | <code>AccessorType</code> | 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$ | <code>Observable&lt;RenderingContextV2&gt;</code> | the rendering context associated with the edit operation. The same DOM element might represent multiple contexts over time |

<b>Returns:</b>

`Observable<EventTargetLike>`

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.


<a name="_10b7d6aba13d565ec3ff3304015d0f4476dfb6bc62276c7de1ba5b7d876c482c"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [WchInlineEditRequireMap](#_65dd160d679d4abf4c25d2d242f0c98469954e875f753278d7dc57defa1ab35f) &gt; ["wch-active-page"](#_10b7d6aba13d565ec3ff3304015d0f4476dfb6bc62276c7de1ba5b7d876c482c)

## WchInlineEditRequireMap."wch-active-page" property

<b>Signature:</b>

```typescript
[ACOUSTIC_ACTIVE_PAGE_MODULE]: PromiseLike<ActivePage>;
```

<a name="_b0ea2fd3b367f69d03f85fa40dbe0423283480608190c8a134359448154d4dd2"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [WchInlineEditRequireMap](#_65dd160d679d4abf4c25d2d242f0c98469954e875f753278d7dc57defa1ab35f) &gt; ["wch-config"](#_b0ea2fd3b367f69d03f85fa40dbe0423283480608190c8a134359448154d4dd2)

## WchInlineEditRequireMap."wch-config" property

<b>Signature:</b>

```typescript
[ACOUSTIC_CONFIG_MODULE]: PromiseLike<WchConfig>;
```

<a name="_bb99250c52780cae076c78bc662106eb5016aeeb543e5f1ffe096973e613f72f"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [WchInlineEditRequireMap](#_65dd160d679d4abf4c25d2d242f0c98469954e875f753278d7dc57defa1ab35f) &gt; ["wch-http"](#_bb99250c52780cae076c78bc662106eb5016aeeb543e5f1ffe096973e613f72f)

## WchInlineEditRequireMap."wch-http" property

<b>Signature:</b>

```typescript
[ACOUSTIC_HTTP_MODULE]: PromiseLike<WchHttp>;
```

<a name="_554c2568a43b3a30ef3c299bd37f4f75518056838aceb7de6513454bdd934c5f"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [WchInlineEditRequireMap](#_65dd160d679d4abf4c25d2d242f0c98469954e875f753278d7dc57defa1ab35f) &gt; ["wch-info"](#_554c2568a43b3a30ef3c299bd37f4f75518056838aceb7de6513454bdd934c5f)

## WchInlineEditRequireMap."wch-info" property

<b>Signature:</b>

```typescript
[ACOUSTIC_INFO_MODULE]: PromiseLike<UrlConfig>;
```

<a name="_b337bbee19a84f25f65cced6c3f7be3e41bc2d358ec5a794a7f37eb3cb92086f"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [WchInlineEditRequireMap](#_65dd160d679d4abf4c25d2d242f0c98469954e875f753278d7dc57defa1ab35f) &gt; ["wch-logger"](#_b337bbee19a84f25f65cced6c3f7be3e41bc2d358ec5a794a7f37eb3cb92086f)

## WchInlineEditRequireMap."wch-logger" property

<b>Signature:</b>

```typescript
[ACOUSTIC_LOGGER_MODULE]: PromiseLike<LoggerService>;
```

<a name="_9b26acc2d878a248c2f18e14cfa5bea7f995b75b1c765b026a65b568b6fd358e"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [WchInlineEditService](#_6e7dcda9aa64d068af55b868a17714db4001b2b95605392b25686b38b75e3bb7) &gt; [fromEvent](#_9b26acc2d878a248c2f18e14cfa5bea7f995b75b1c765b026a65b568b6fd358e)

## WchInlineEditService.fromEvent() method

Attaches to an event issued by the edit library

<b>Signature:</b>

```typescript
fromEvent<T>(aName: string): Observable<T>;
```

## Parameters

|  Parameter | Type | Description |
|  --- | --- | --- |
|  aName | <code>string</code> | name of the event |

<b>Returns:</b>

`Observable<T>`

a stream of events


<a name="_9d9e1e842414952eb9d11c1b9c7831d2c32a4929cb95c9545a5417645100c69c"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_71e1cfaf47e8dbdcb041c339b6280f8969475bab876abad86f22c8a76b231212) &gt; [@acoustic-content-sdk/edit-api](#_3b0005a48982b2d50ed17146065f26a2c55cf95bb620dac4eb25d8db5c64f679) &gt; [WchInlineEditService](#_6e7dcda9aa64d068af55b868a17714db4001b2b95605392b25686b38b75e3bb7) &gt; [registerComponent](#_9d9e1e842414952eb9d11c1b9c7831d2c32a4929cb95c9545a5417645100c69c)

## WchInlineEditService.registerComponent() method

Registers a particular DOM element as editable

<b>Signature:</b>

```typescript
registerComponent(nativeElement: any, accessor: AccessorType, onRenderingContext: Observable<RenderingContext>): Observable<EventTargetLike>;
```

## Parameters

|  Parameter | Type | Description |
|  --- | --- | --- |
|  nativeElement | <code>any</code> | the DOM element to be edited |
|  accessor | <code>AccessorType</code> | 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 | <code>Observable&lt;RenderingContext&gt;</code> | the rendering context associated with the edit operation. The same DOM element might represent multiple contexts over time |

<b>Returns:</b>

`Observable<EventTargetLike>`

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.

---
_Source: https://npm.io/package/@acoustic-content-sdk/edit-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
