# @acoustic-content-sdk/component-edit

> Framework independent collection of utilities to implement inline edit.

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

## Install

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

## 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 | 2020-01-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 283.9 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, redux, sdk |

## Links

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

## Dependencies (3)

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

## Recent versions

- 9.0.10076 (latest) — 2020-03-26
- 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
- 9.0.242 — 2020-02-06
- … 4 more at https://npm.io/package/@acoustic-content-sdk/component-edit/versions

## README

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

Framework independent collection of utilities to implement inline edit.

[API Documentation](#_2bf91c5d568485d477affc0a46c6a7e0c52e1f87aff5c2796c572f33288f3cf9)

<a name="_2bf91c5d568485d477affc0a46c6a7e0c52e1f87aff5c2796c572f33288f3cf9"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_059ee35eac10435d1dae3c965fc43d42941d0fac0b3aa843491954adba50c7f1) &gt; [@acoustic-content-sdk/component-edit](#_2bf91c5d568485d477affc0a46c6a7e0c52e1f87aff5c2796c572f33288f3cf9)

## component-edit package

Framework independent collection of utilities to implement inline edit.

## Classes

|  Class | Description |
|  --- | --- |
|  [AbstractInlineEditSelectionService](#_d4cb072dbe0762886ba58ce3a24e8e1e446b67beabbaf4964ddfff36f0246583) |  |
|  [AbstractWchInlineEditService](#_e899461aa8e28b139af2da7af3d94f2036420ce49c2db4ac74a7d2244d080e75) | Implementation of the \`<!-- -->WchInlineEditServiceV2 that loads the inline edit library and allows to attach to that library. |

## Functions

|  Function | Description |
|  --- | --- |
|  [getInlineEditSelection(aDocument, aLogSvc)](#_4b115f225c20f88f4360273bdfb6c1ae6686ba3d3710011d51bc2cbd028ff833) |  |

## Variables

|  Variable | Description |
|  --- | --- |
|  [EMPTY\_ACOUSTIC\_INLINE\_EDIT\_SERVICE](#_6a9cd9781cfbd0dcb71d88a0d0697589e9090277f0579a2bfefc4865f0d2b013) |  |
|  [VERSION](#_5fc4a4c842c5123c0cba3f23892acf733c983e9758a9520f4553b04c797610cb) | Version and build number of the package |


<a name="_2c1c1205982ee1698cc903cae07d4f9b4bff5f27bc9651c91ed506db10a8fbb4"></a>

<a name="_d4cb072dbe0762886ba58ce3a24e8e1e446b67beabbaf4964ddfff36f0246583"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_059ee35eac10435d1dae3c965fc43d42941d0fac0b3aa843491954adba50c7f1) &gt; [@acoustic-content-sdk/component-edit](#_2bf91c5d568485d477affc0a46c6a7e0c52e1f87aff5c2796c572f33288f3cf9) &gt; [AbstractInlineEditSelectionService](#_d4cb072dbe0762886ba58ce3a24e8e1e446b67beabbaf4964ddfff36f0246583)

## AbstractInlineEditSelectionService class

<b>Signature:</b>

```typescript
export declare class AbstractInlineEditSelectionService implements Unsubscribable 
```

## Constructors

|  Constructor | Modifiers | Description |
|  --- | --- | --- |
|  [(constructor)(aSelectedClass, aSelectionProvider, aDocument, aLogSvc)](#_f029a6457bf9ace49d6d363d6eff7f1bd603cf86632247b6d3ddfc682e32b5fb) |  | Constructs a new instance of the <code>AbstractInlineEditSelectionService</code> class |

## Methods

|  Method | Modifiers | Description |
|  --- | --- | --- |
|  [unsubscribe()](#_2dadb74aa30676533dd5877f40b91be5f0c66ea27c91b3c63e8c57d0a6d36824) |  |  |


<a name="_e899461aa8e28b139af2da7af3d94f2036420ce49c2db4ac74a7d2244d080e75"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_059ee35eac10435d1dae3c965fc43d42941d0fac0b3aa843491954adba50c7f1) &gt; [@acoustic-content-sdk/component-edit](#_2bf91c5d568485d477affc0a46c6a7e0c52e1f87aff5c2796c572f33288f3cf9) &gt; [AbstractWchInlineEditService](#_e899461aa8e28b139af2da7af3d94f2036420ce49c2db4ac74a7d2244d080e75)

## AbstractWchInlineEditService class

Implementation of the \`<!-- -->WchInlineEditServiceV2 that loads the inline edit library and allows to attach to that library.

<b>Signature:</b>

```typescript
export declare class AbstractWchInlineEditService implements WchInlineEditServiceV2, Unsubscribable 
```

## Constructors

|  Constructor | Modifiers | Description |
|  --- | --- | --- |
|  [(constructor)(aEventConsumer, aProvider$, aUrlConfig$, aDocument, aLogSvc)](#_5aa0509c04ce2a6b1b041620793b3c069c3a528fe423881be9cda1ec06903ea4) |  | Constructs a new instance of the <code>AbstractWchInlineEditService</code> class |

## Properties

|  Property | Modifiers | Type | Description |
|  --- | --- | --- | --- |
|  [done$](#_dee11cc0c2d4c96eb00e0ee4b841937b44e1d6b4e1dfd8b439aeaa13c34561b8) |  | <code>Subject&lt;any&gt;</code> |  |
|  [fromEvent](#_eb078c168499c013dd368e809bf82995b80d1128cbd407af2b744595c16bfb04) |  | <code>&lt;T&gt;(aName: string) =&gt; Observable&lt;T&gt;</code> |  |
|  [registerComponent](#_d68a2536f9fa059c619cc717e319916067988c28f90be400a68f66a74f67198c) |  | <code>(nativeElement: any, accessor: AccessorType, renderingContext$: Observable&lt;RenderingContextV2&gt;) =&gt; Observable&lt;EventTargetLike&gt;</code> |  |

## Methods

|  Method | Modifiers | Description |
|  --- | --- | --- |
|  [unsubscribe()](#_6345fbac7dadb5672e5a331cfa4ceb68f71307b8346723193e53c13ad94bb727) |  |  |


<a name="_4b115f225c20f88f4360273bdfb6c1ae6686ba3d3710011d51bc2cbd028ff833"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_059ee35eac10435d1dae3c965fc43d42941d0fac0b3aa843491954adba50c7f1) &gt; [@acoustic-content-sdk/component-edit](#_2bf91c5d568485d477affc0a46c6a7e0c52e1f87aff5c2796c572f33288f3cf9) &gt; [getInlineEditSelection](#_4b115f225c20f88f4360273bdfb6c1ae6686ba3d3710011d51bc2cbd028ff833)

## getInlineEditSelection() function

<b>Signature:</b>

```typescript
export declare function getInlineEditSelection(aDocument: Document, aLogSvc?: LoggerService): Observable<string>;
```

## Parameters

|  Parameter | Type | Description |
|  --- | --- | --- |
|  aDocument | <code>Document</code> |  |
|  aLogSvc | <code>LoggerService</code> |  |

<b>Returns:</b>

`Observable<string>`


<a name="_6a9cd9781cfbd0dcb71d88a0d0697589e9090277f0579a2bfefc4865f0d2b013"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_059ee35eac10435d1dae3c965fc43d42941d0fac0b3aa843491954adba50c7f1) &gt; [@acoustic-content-sdk/component-edit](#_2bf91c5d568485d477affc0a46c6a7e0c52e1f87aff5c2796c572f33288f3cf9) &gt; [EMPTY\_ACOUSTIC\_INLINE\_EDIT\_SERVICE](#_6a9cd9781cfbd0dcb71d88a0d0697589e9090277f0579a2bfefc4865f0d2b013)

## EMPTY\_ACOUSTIC\_INLINE\_EDIT\_SERVICE variable

<b>Signature:</b>

```typescript
EMPTY_ACOUSTIC_INLINE_EDIT_SERVICE: WchInlineEditServiceV2
```

<a name="_5fc4a4c842c5123c0cba3f23892acf733c983e9758a9520f4553b04c797610cb"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_059ee35eac10435d1dae3c965fc43d42941d0fac0b3aa843491954adba50c7f1) &gt; [@acoustic-content-sdk/component-edit](#_2bf91c5d568485d477affc0a46c6a7e0c52e1f87aff5c2796c572f33288f3cf9) &gt; [VERSION](#_5fc4a4c842c5123c0cba3f23892acf733c983e9758a9520f4553b04c797610cb)

## 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="_f029a6457bf9ace49d6d363d6eff7f1bd603cf86632247b6d3ddfc682e32b5fb"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_059ee35eac10435d1dae3c965fc43d42941d0fac0b3aa843491954adba50c7f1) &gt; [@acoustic-content-sdk/component-edit](#_2bf91c5d568485d477affc0a46c6a7e0c52e1f87aff5c2796c572f33288f3cf9) &gt; [AbstractInlineEditSelectionService](#_d4cb072dbe0762886ba58ce3a24e8e1e446b67beabbaf4964ddfff36f0246583) &gt; [(constructor)](#_f029a6457bf9ace49d6d363d6eff7f1bd603cf86632247b6d3ddfc682e32b5fb)

## AbstractInlineEditSelectionService.(constructor)

Constructs a new instance of the `AbstractInlineEditSelectionService` class

<b>Signature:</b>

```typescript
constructor(aSelectedClass: string, aSelectionProvider: InlineEditSelectionProvider, aDocument?: any, aLogSvc?: LoggerService);
```

## Parameters

|  Parameter | Type | Description |
|  --- | --- | --- |
|  aSelectedClass | <code>string</code> |  |
|  aSelectionProvider | <code>InlineEditSelectionProvider</code> |  |
|  aDocument | <code>any</code> |  |
|  aLogSvc | <code>LoggerService</code> |  |


<a name="_2dadb74aa30676533dd5877f40b91be5f0c66ea27c91b3c63e8c57d0a6d36824"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_059ee35eac10435d1dae3c965fc43d42941d0fac0b3aa843491954adba50c7f1) &gt; [@acoustic-content-sdk/component-edit](#_2bf91c5d568485d477affc0a46c6a7e0c52e1f87aff5c2796c572f33288f3cf9) &gt; [AbstractInlineEditSelectionService](#_d4cb072dbe0762886ba58ce3a24e8e1e446b67beabbaf4964ddfff36f0246583) &gt; [unsubscribe](#_2dadb74aa30676533dd5877f40b91be5f0c66ea27c91b3c63e8c57d0a6d36824)

## AbstractInlineEditSelectionService.unsubscribe() method

<b>Signature:</b>

```typescript
unsubscribe(): void;
```
<b>Returns:</b>

`void`


<a name="_5aa0509c04ce2a6b1b041620793b3c069c3a528fe423881be9cda1ec06903ea4"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_059ee35eac10435d1dae3c965fc43d42941d0fac0b3aa843491954adba50c7f1) &gt; [@acoustic-content-sdk/component-edit](#_2bf91c5d568485d477affc0a46c6a7e0c52e1f87aff5c2796c572f33288f3cf9) &gt; [AbstractWchInlineEditService](#_e899461aa8e28b139af2da7af3d94f2036420ce49c2db4ac74a7d2244d080e75) &gt; [(constructor)](#_5aa0509c04ce2a6b1b041620793b3c069c3a528fe423881be9cda1ec06903ea4)

## AbstractWchInlineEditService.(constructor)

Constructs a new instance of the `AbstractWchInlineEditService` class

<b>Signature:</b>

```typescript
protected constructor(aEventConsumer: Consumer<WchInlineEditEvent>, aProvider$: Observable<WchInlineEditProviderV2>, aUrlConfig$: Observable<UrlConfig>, aDocument?: any, aLogSvc?: LoggerService);
```

## Parameters

|  Parameter | Type | Description |
|  --- | --- | --- |
|  aEventConsumer | <code>Consumer&lt;WchInlineEditEvent&gt;</code> |  |
|  aProvider$ | <code>Observable&lt;WchInlineEditProviderV2&gt;</code> |  |
|  aUrlConfig$ | <code>Observable&lt;UrlConfig&gt;</code> |  |
|  aDocument | <code>any</code> |  |
|  aLogSvc | <code>LoggerService</code> |  |


<a name="_dee11cc0c2d4c96eb00e0ee4b841937b44e1d6b4e1dfd8b439aeaa13c34561b8"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_059ee35eac10435d1dae3c965fc43d42941d0fac0b3aa843491954adba50c7f1) &gt; [@acoustic-content-sdk/component-edit](#_2bf91c5d568485d477affc0a46c6a7e0c52e1f87aff5c2796c572f33288f3cf9) &gt; [AbstractWchInlineEditService](#_e899461aa8e28b139af2da7af3d94f2036420ce49c2db4ac74a7d2244d080e75) &gt; [done$](#_dee11cc0c2d4c96eb00e0ee4b841937b44e1d6b4e1dfd8b439aeaa13c34561b8)

## AbstractWchInlineEditService.done$ property

<b>Signature:</b>

```typescript
protected readonly done$: Subject<any>;
```

<a name="_eb078c168499c013dd368e809bf82995b80d1128cbd407af2b744595c16bfb04"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_059ee35eac10435d1dae3c965fc43d42941d0fac0b3aa843491954adba50c7f1) &gt; [@acoustic-content-sdk/component-edit](#_2bf91c5d568485d477affc0a46c6a7e0c52e1f87aff5c2796c572f33288f3cf9) &gt; [AbstractWchInlineEditService](#_e899461aa8e28b139af2da7af3d94f2036420ce49c2db4ac74a7d2244d080e75) &gt; [fromEvent](#_eb078c168499c013dd368e809bf82995b80d1128cbd407af2b744595c16bfb04)

## AbstractWchInlineEditService.fromEvent property

<b>Signature:</b>

```typescript
fromEvent: <T>(aName: string) => Observable<T>;
```

<a name="_d68a2536f9fa059c619cc717e319916067988c28f90be400a68f66a74f67198c"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_059ee35eac10435d1dae3c965fc43d42941d0fac0b3aa843491954adba50c7f1) &gt; [@acoustic-content-sdk/component-edit](#_2bf91c5d568485d477affc0a46c6a7e0c52e1f87aff5c2796c572f33288f3cf9) &gt; [AbstractWchInlineEditService](#_e899461aa8e28b139af2da7af3d94f2036420ce49c2db4ac74a7d2244d080e75) &gt; [registerComponent](#_d68a2536f9fa059c619cc717e319916067988c28f90be400a68f66a74f67198c)

## AbstractWchInlineEditService.registerComponent property

<b>Signature:</b>

```typescript
registerComponent: (nativeElement: any, accessor: AccessorType, renderingContext$: Observable<RenderingContextV2>) => Observable<EventTargetLike>;
```

<a name="_6345fbac7dadb5672e5a331cfa4ceb68f71307b8346723193e53c13ad94bb727"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_059ee35eac10435d1dae3c965fc43d42941d0fac0b3aa843491954adba50c7f1) &gt; [@acoustic-content-sdk/component-edit](#_2bf91c5d568485d477affc0a46c6a7e0c52e1f87aff5c2796c572f33288f3cf9) &gt; [AbstractWchInlineEditService](#_e899461aa8e28b139af2da7af3d94f2036420ce49c2db4ac74a7d2244d080e75) &gt; [unsubscribe](#_6345fbac7dadb5672e5a331cfa4ceb68f71307b8346723193e53c13ad94bb727)

## AbstractWchInlineEditService.unsubscribe() method

<b>Signature:</b>

```typescript
unsubscribe(): void;
```
<b>Returns:</b>

`void`

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