@ibm-wch-sdk/ng-edit

v6.0.524

Published

3 years ago

Module to attach inline-edit functionality to an WCH based Angular application.

Downloads

0High
0Medium
0Low

marcin-pasiewicz

nikodem.graczewski.acoustic

willizard

pawel.galias-ac

ibm-wch-sdk-ng-edit

Module to attach inline-edit functionality to an WCH based Angular application. The library exposes the WchNgEditModule module.

Changes

CHANGELOG

Details

Refer to the documentation.

Class documentation

Refer to the documentation.

Usage

Install the module via

npm install --save @ibm-wch-sdk/ng-edit

Add the module to your root application

@NgModule({
  ...
  imports: [
    ...
    WchNgEditModule.forRoot(environment)
  ],
  ...
})
export class AppModule { }

The module exposes the WchEditService and the wchEditable directive.

Prereqs

@ibm-wch-sdk/ng
Angular 6 or higher

Directive [wchEditable]

The directive attaches inline edit functionality to an element that is managed by WCH. The implementation in this library only dispatches the actual realization of the inline-edit functionality to a pluggable service provider.

The directive assumes that the Component contains a onRenderingContext property that exposes the RenderingContext of the item currently edited. This contract is fulfilled automatically if the component extends AbstractRenderingComponent.

The directive requires as a parameter a string identifying the editable property. This string must reference a property on the Component that has been bound to a field of the content item via a @RenderingContextBinding directive. This directive contains the actual selector of the field. Note that this binding is done automatically if the components are generated via the CLI.

Example

<div wchEditable="myField">{{renderingContext.elements.myField.value}}</div>

assuming the following binding

export class MyComponent extends AbstractRenderingComponent {
  @RenderingContextBinding('elements.myField.value') myField: string;
}

WchNgEditModule

The module exposes the directives and services. Per default it provides a service that loads the inline edit functionality from the site composer, when registering the module using the forRoot method.

forRoot(config?): the method registers the module and provides a service to load inline edit from the site composer. The location to load the edit script from is configurable via the config script, typically used for local debugging of the script via the inlineEditUrl member on the config object. A convenient way to inject this is to add inlineEditUrl to your environment object and then inject the environment object.

Example

import { WchNgEditModule } from '@ibm-wch-sdk/ng-edit';


@NgModule({
  ...
  imports: [
    ...
    WchNgEditModule.forRoot(environment),
    ...
  ]
})
export class AppModule {
}

WchEditInfoService

The service allows to find out if an inline edit operation is taking place. Applications might want to stop any background processing during this period to avoid intercepting with the edit operation.

onEditing: Observable<boolean>: the observable that tracks the state of the current inline edit operation. It is a shared observable that dispatches the current state and all subsequent states.

WchInlineEditService

Service providers implement the WchInlineEditService and provide to the module. This service realizes the actual implementation of the inline edit operation.

registerComponent(el, accessor, onRenderingContext): Observable<EventTargetLike>: this method will be invoked by the [wchEditable] directive for every editable element in the application. The el parameter references the editable DOM element. The accessor is string that represents the Javascript property accessor into the content items for the editable element. onRenderingContext exposes the context of the currently edited item. The method returns an observable of an event emitter. Subscribing to this observable makes the registration active, unsubscribing cancels it. The event emitter is used to listen for edit events.

Edit events

The following inline edit events are recognized:

wchEditStart: fired when an element enters into inline edit mode. This is used to track this status by the WchEditInfoService.
wchEditEnd: fired when an element leaves inline edit mode (no matter whether the edit operation has been canceled or completed). This is used to track this status by the WchEditInfoService.

WchHttpInlineEditService

The default implementation of the WchInlineEditService. If the system is in preview mode, then the service lazily loads an inline edit script from a configurable location. Per default this location points to TODO, it can be overridden by the inlineEditUrl property on the config object for the module.

Script requirements

The inline edit script will be loaded via an HTTP request and executed dynamically. It needs to contain an IIFE that returns a registration object with the following properties:

register(el, accessor, onRenderingContext): Handle: the register method will be called for every editable element, so the implementation of the method can attach the necessary event handlers to the DOM element to make it editable. The method returns a handle that allows to cancel the registration and to attach event handlers to the inline edit process to monitor it. The method receives the DOM element via the el parameter and an accessor that represents a Javascript property expression for the editable element in the content item. The onRenderingContext observable exposes the current context of the rendered item.

Handle

The handle needs to conform to one of the signatures of EventTargetLike from the RXJS spec. In addition it can expose a dispose method.

dispose: the dispose method on the handle will be invoked to cancel a registration. This happens when the editable element falls out of scope, e.g. because of a page switch or because the application decides to hide it or for any other reason. Implementers need to make sure to unregister all previously registered event handlers.

Require

The inline edit script can use a require function that is available in its scope to load extra resources or services exposed by the SDK. The following services are available:

wch-config: a configuration object containing URLs for the current tenant
wch-info: the hub configuration exposed to the SDK by the SPA
wch-logger: access to the SDK logging infrastructure. It is suggested to uses the exposed logger instead of console logs.

In addition the require function will resolve URLs relative to the URL used to load the script and returns the result as text. All return values are exposed as promises.

Example for accessing the config:

const config = require('wch-config');
config.then(c => console.log(c.apiUrl));

Example for loading an extra resource:

const res = require('./myExtraResource.txt');
res.then(console.log);

Example for using the logger:

const logger = require('wch-logger');
logger
  .then(logger => logger.get('MyModule'))
  .then(log => log.info('some log output'));

Accessor Expression

Accessor expressions allow to identify the field of a Content Item that the inline edit operation refers to. It is a string in the format of a Javascript property accessor.

Examples

name: accesses the name attribute of a content item.
elements.myText.value: accesses the value of a single valued element called myText.
elements.myTexts.values[2]: accesses the third value of a multi valued element called myTexts.

Changelog

Current

6.0.69

Changed

Improved readme

Added

Support for Angular 6
Support for group elements
Initial version

WchNgEditModule

Module that allows to attach inline edit functionality to a WCH based Angular application.

Usage

Install the module

npm install --save ibm-wch-sdk-ng-edit

Import the module into your application. Use the environment variable to configure the module, this is the same configuration as for the main WchNgModule module.

import {WchNgEditModule} from 'ibm-wch-sdk-ng-edit';

...

@NgModule({
  ...
  imports: [
    WchNgEditModule.forRoot(environment)
    ...
  ]

Annotate your editable components. Pass the selector to the text field as parameter to the directive.

<div wchEditable='elements.myText'>{{renderingContext.elements.myText.value}}</div>

Dependencies

The modules assumes an implementation of the WchInlineEditService. This service must be injected into the main module.

Developing modules based on the SDK

When developing modules that use the SDK, make sure to import the WchNgEditComponentsModule to have access to the components and directives exposed by the SDK.

Configuration

The module can be configured via the forRoot method or by providing overrides for the individual configuration tokens.

Components

The module exposes the following Components.

@ibm-wch-sdk/ng-edit

Index

External modules

@ibm-wch-sdk/ng-edit > "components/login/abstract.login.component"

External module: "components/login/abstract.login.component"

Index

Classes

AbstractLoginComponent

Variables

LOGGER

Variables

`<Const>` LOGGER

● LOGGER: "AbstractLoginComponent" = "AbstractLoginComponent"

Defined in components/login/abstract.login.component.ts:17

@ibm-wch-sdk/ng-edit > "components/placeholder/placeholder.component"

External module: "components/placeholder/placeholder.component"

Index

Classes

WchPlaceholderComponent

Variables

`<Let>` COUNT

● COUNT: number = 0

Defined in components/placeholder/placeholder.component.ts:49

`<Const>` LOGGER

● LOGGER: "WchPlaceholderComponent" = "WchPlaceholderComponent"

Defined in components/placeholder/placeholder.component.ts:46

@ibm-wch-sdk/ng-edit > "config/config"

External module: "config/config"

Index

Variables

`<Const>` WCH_EDIT_HUB_INFO_SERVICE

● WCH_EDIT_HUB_INFO_SERVICE: InjectionToken<EditHubInfoService> = new InjectionToken( 'EditHubInfoService' )

Defined in config/config.ts:46

`<Const>` WCH_THROTTLE_LOADING

● WCH_THROTTLE_LOADING: "D1576F60-7D2A-4824-9771-A1EB574771DB" = "D1576F60-7D2A-4824-9771-A1EB574771DB"

Defined in config/config.ts:44

Injection token for placeholder debugging

see: EditHubInfoService

`<Const>` WCH_TOKEN_DEBUG_PLACEHOLDERS

● WCH_TOKEN_DEBUG_PLACEHOLDERS: "03066F08-3E5E-41BE-B1E9-B0F31D0C881D" = "03066F08-3E5E-41BE-B1E9-B0F31D0C881D"

Defined in config/config.ts:36

Injection token for placeholder debugging

see: EditHubInfoService

`<Const>` WCH_TOKEN_DEFAULT_PLACEHOLDER_TEXT

● WCH_TOKEN_DEFAULT_PLACEHOLDER_TEXT: "10DDECF4-3818-4B08-BD34-CA073F831E9B" = "10DDECF4-3818-4B08-BD34-CA073F831E9B"

Defined in config/config.ts:14

Injection token for default placeholder text

see: EditHubInfoService import { InjectionToken } from '@angular/core';

import { EditHubInfoService } from './../services/config/wch.edit.config';

`<Const>` WCH_TOKEN_INLINE_EDIT_URL

● WCH_TOKEN_INLINE_EDIT_URL: "0E7D0A87-FBDD-4565-9C8F-DB5909B6D9AF" = "0E7D0A87-FBDD-4565-9C8F-DB5909B6D9AF"

Defined in config/config.ts:22

Injection token for inline edit url

see: EditHubInfoService

`<Const>` WCH_TOKEN_PLACEHOLDER_TAG

● WCH_TOKEN_PLACEHOLDER_TAG: "C80F7BDA-438D-49F9-B63B-3BDA1FC13E99" = "C80F7BDA-438D-49F9-B63B-3BDA1FC13E99"

Defined in config/config.ts:29

Injection token for placeholder tag

see: EditHubInfoService

@ibm-wch-sdk/ng-edit > "config/index"

External module: "config/index"

Index

@ibm-wch-sdk/ng-edit > "directives/editable/abstract.editable.directive"

External module: "directives/editable/abstract.editable.directive"

Index

Classes

AbstractWchEditableDirective

Type aliases

WchEditableType

Variables

Type aliases

WchEditableType

Ƭ WchEditableType: string | null

Defined in directives/editable/abstract.editable.directive.ts:80

Variables

`<Const>` COMPONENT_ACCESSOR

● COMPONENT_ACCESSOR: AccessorType = null

Defined in directives/editable/abstract.editable.directive.ts:83

`<Let>` COUNT

● COUNT: number = 0

Defined in directives/editable/abstract.editable.directive.ts:73

`<Const>` KEY_ON_RENDERING_CONTEXT

● KEY_ON_RENDERING_CONTEXT: "onRenderingContext" = "onRenderingContext"

Defined in directives/editable/abstract.editable.directive.ts:75

`<Const>` LOGGER

● LOGGER: "AbstractWchEditableDirective" = "AbstractWchEditableDirective"

Defined in directives/editable/abstract.editable.directive.ts:77

`<Const>` ON_COMPONENT_ACCESSOR

● ON_COMPONENT_ACCESSOR: Observable<string> = of(COMPONENT_ACCESSOR)

Defined in directives/editable/abstract.editable.directive.ts:86

@ibm-wch-sdk/ng-edit > "directives/editable/editable.directive"

External module: "directives/editable/editable.directive"

Index

Classes

WchEditableDirective

@ibm-wch-sdk/ng-edit > "directives/editable/editable.placeholder.directive"

External module: "directives/editable/editable.placeholder.directive"

Index

Functions

Type aliases

TEXT_PROPERTY

Ƭ TEXT_PROPERTY: "innerHTML" | "innerText"

Defined in directives/editable/editable.placeholder.directive.ts:72

Variables

`<Const>` LOGGER

● LOGGER: "WchEditablePlaceholderDirective" = "WchEditablePlaceholderDirective"

Defined in directives/editable/editable.placeholder.directive.ts:70

Functions

_setText

▸ _setText(aProp: TEXT_PROPERTY, aLocalizedText: LocalizedText, aElement: ElementRef, aRenderer: Renderer2): void

Defined in directives/editable/editable.placeholder.directive.ts:82

Assigns the text to a value

Parameters:

| Name | Type | Description | | ------ | ------ | ------ | | aProp | TEXT_PROPERTY | the property to assign | | aLocalizedText | LocalizedText | the actual text | | aElement | ElementRef | the native element | | aRenderer | Renderer2 | render used to assign the text |

Returns: void

`<Const>` _textSetter

▸ _textSetter(aElement: any, aRenderer: Renderer2): (Anonymous function)

Defined in directives/editable/editable.placeholder.directive.ts:113

Binds the element ref and the renderer

Parameters:

| Name | Type | Description | | ------ | ------ | ------ | | aElement | any | the eleemnt reference | | aRenderer | Renderer2 | the renderer |

Returns: (Anonymous function) function that only takes the property name and the

@ibm-wch-sdk/ng-edit > "index"

External module: "index"

Index

@ibm-wch-sdk/ng-edit > "interfaces/inline.edit.service"

External module: "interfaces/inline.edit.service"

Index

Variables

`<Const>` EVENT_EDIT_END

● EVENT_EDIT_END: "wchEditEnd" = "wchEditEnd"

Defined in interfaces/inline.edit.service.ts:7

`<Const>` EVENT_EDIT_START

● EVENT_EDIT_START: "wchEditStart" = "wchEditStart"

Defined in interfaces/inline.edit.service.ts:6

`<Const>` EVENT_INLINE_EDIT_END

● EVENT_INLINE_EDIT_END: "wchInlineEditEnd" = "wchInlineEditEnd"

Defined in interfaces/inline.edit.service.ts:10

`<Const>` EVENT_INLINE_EDIT_START

● EVENT_INLINE_EDIT_START: "wchInlineEditStart" = "wchInlineEditStart"

Defined in interfaces/inline.edit.service.ts:9

`<Const>` WchInlineEditServiceToken

● WchInlineEditServiceToken: InjectionToken<WchInlineEditService> = new InjectionToken< WchInlineEditService

('WchInlineEditServiceToken')

Defined in interfaces/inline.edit.service.ts:15

@ibm-wch-sdk/ng-edit > "module"

External module: "module"

Index

Classes

WchNgEditModule

Variables

WCH_RC_INTERCEPTOR_TOKEN

Variables

`<Const>` WCH_RC_INTERCEPTOR_TOKEN

● WCH_RC_INTERCEPTOR_TOKEN: "8453750A-4519-4184-840B-D490E909D23E" = "8453750A-4519-4184-840B-D490E909D23E"

Defined in module.ts:32

@ibm-wch-sdk/ng-edit > "modules/components.module"

External module: "modules/components.module"

Index

Classes

WchNgEditComponentsModule

@ibm-wch-sdk/ng-edit > "modules/services.module"

External module: "modules/services.module"

Index

Classes

WchNgEditServicesModule

@ibm-wch-sdk/ng-edit > "placeholder/placeholder"

External module: "placeholder/placeholder"

Index

Variables

REL_PATH_TYPE_BY_ID

Functions

loadAuthoringType

Variables

`<Const>` REL_PATH_TYPE_BY_ID

● REL_PATH_TYPE_BY_ID: "delivery/v1/rendering/type/" = "delivery/v1/rendering/type/"

Defined in placeholder/placeholder.ts:8

Functions

loadAuthoringType

▸ loadAuthoringType(aService: WchHttpService, aTypeId: string): Observable<AuthoringType>

Defined in placeholder/placeholder.ts:10

Parameters:

| Name | Type | | ------ | ------ | | aService | WchHttpService | | aTypeId | string |

Returns: Observable<AuthoringType>

@ibm-wch-sdk/ng-edit > "services/config/default.wch.edit.config"

External module: "services/config/default.wch.edit.config"

Index

Variables

`<Const>` DEFAULT_DEBUG_PLACEHOLDERS

● DEFAULT_DEBUG_PLACEHOLDERS: false = false

Defined in services/config/default.wch.edit.config.ts:8

`<Const>` DEFAULT_INLINE_EDIT_URL

● DEFAULT_INLINE_EDIT_URL: "${authoringUIBaseUrl.protocol}//${authoringUIBaseUrl.host}/authoring-sites-ui/inline-edit/inline-edit.js" = "${authoringUIBaseUrl.protocol}//${authoringUIBaseUrl.host}/authoring-sites-ui/inline-edit/inline-edit.js"

Defined in services/config/default.wch.edit.config.ts:4

@ibm-wch-sdk/ng-edit > "services/config/index"

External module: "services/config/index"

Index

@ibm-wch-sdk/ng-edit > "services/config/wch.edit.config"

External module: "services/config/wch.edit.config"

Index

Interfaces

EditHubInfoService

Functions