@acoustic-content-sdk/react-edit-api

Collection of APIs and constants for the React SDK in edit mode.

Table of Contents

• API Documentation

Home > @acoustic-content-sdk/react-edit-api

react-edit-api package

Collection of APIs and constants for the React SDK in edit mode.

Functions

Function	Description
selectDebugPlaceholder(aConfig)
selectDefaultPlaceholder(aConfig)
selectInlineEditURL(aConfig)
selectPlaceholderTag(aConfig)
selectThrottleLoading(aConfig)

Interfaces

Interface	Description
EditHubInfoService
WchPlaceholder
WchPlaceholderProvider

Variables

Variable	Description
ACOUSTIC_CONTEXT_ACOUSTIC_CONFIG	Injection token for the wch config
ACOUSTIC_CONTEXT_DEBUG_PLACEHOLDERS	Injection token for placeholder debugging
ACOUSTIC_CONTEXT_DEFAULT_PLACEHOLDER_TEXT	Injection token for default placeholder text
ACOUSTIC_CONTEXT_EDIT_HOST_WINDOW	Injects the window that acts as the edit host for an application. This is typically the parent window or the opener window.
ACOUSTIC_CONTEXT_INLINE_EDIT_PROVIDER	Injection token for the inline edit provider
ACOUSTIC_CONTEXT_INLINE_EDIT_SELECTION_PROVIDER	Provides information about the inline edit selection
ACOUSTIC_CONTEXT_INLINE_EDIT_SERVICE
ACOUSTIC_CONTEXT_INLINE_EDIT_URL
ACOUSTIC_CONTEXT_PLACEHOLDER_PROVIDER
DEFAULT_DEBUG_PLACEHOLDERS	per default do not debug
DEFAULT_INLINE_EDIT_URL	default value for the inline edit URL
EVENT_EDIT_END
EVENT_EDIT_START
EVENT_INLINE_EDIT_END
EVENT_INLINE_EDIT_START
VERSION	Version and build number of the package

Type Aliases

Type Alias	Description
WchDefaultPlaceholder	type for placeholder

Home > @acoustic-content-sdk/react-edit-api > selectDebugPlaceholder

selectDebugPlaceholder() function

Signature:

export declare function selectDebugPlaceholder(aConfig?: EditHubInfoService): boolean;

Parameters

Parameter	Type	Description
aConfig	EditHubInfoService

Returns:

boolean

Home > @acoustic-content-sdk/react-edit-api > selectDefaultPlaceholder

selectDefaultPlaceholder() function

Signature:

export declare function selectDefaultPlaceholder(aConfig?: EditHubInfoService): WchDefaultPlaceholder;

Parameters

Parameter	Type	Description
aConfig	EditHubInfoService

Returns:

WchDefaultPlaceholder

Home > @acoustic-content-sdk/react-edit-api > selectInlineEditURL

selectInlineEditURL() function

Signature:

export declare function selectInlineEditURL(aConfig?: EditHubInfoService): HubInfoUrlProvider;

Parameters

Parameter	Type	Description
aConfig	EditHubInfoService

Returns:

HubInfoUrlProvider

Home > @acoustic-content-sdk/react-edit-api > selectPlaceholderTag

selectPlaceholderTag() function

Signature:

export declare function selectPlaceholderTag(aConfig?: EditHubInfoService): string;

Parameters

Parameter	Type	Description
aConfig	EditHubInfoService

Returns:

string

Home > @acoustic-content-sdk/react-edit-api > selectThrottleLoading

selectThrottleLoading() function

Signature:

export declare function selectThrottleLoading(aConfig?: EditHubInfoService): number;

Parameters

Parameter	Type	Description
aConfig	EditHubInfoService

Returns:

number

Home > @acoustic-content-sdk/react-edit-api > EditHubInfoService

EditHubInfoService interface

Signature:

export interface EditHubInfoService 

Properties

Property	Type	Description
debugPlaceholders	boolean	Enable or disable placeholders even if inline edit mode has not been enabled
defaultPlaceholderText	WchDefaultPlaceholder	Provide a default placeholder text
inlineEditUrl	HubInfoUrlProvider
placeholderTag	string	Tag used to find placeholder content items. If left undefined, placeholders will not be inserted, automatically
throttleLoading	number	Throttle loading of lib

Home > @acoustic-content-sdk/react-edit-api > WchPlaceholder

WchPlaceholder interface

Signature:

export interface WchPlaceholder 

Properties

Property	Type	Description
accessor$	Observable<string>	The accessor expression
data$	Observable<any>	Generates the accessed data, decoded from the accessor expression
formattedText$	Observable<LocalizedText>	Generates the formatted text of an element, potentially replaced by the placeholder
placeholder$	Observable<AuthoringPlaceholder>	Event exposing the current placeholder. If no placeholder exists or placeholders are disabled, this will return 'undefined'.
placeholderText$	Observable<LocalizedText>	Event exposing the current placeholder text. If placeholders are disabled, this will return 'undefined'. If no placeholder has been defined this returns the default placeholder as specified by the application, else 'undefined'.
plainText$	Observable<LocalizedText>	Generates the text of an element, potentially replaced by the placeholder
showPlaceholder$	Observable<boolean>	Checks if we should show or hide placeholders
typeId$	Observable<string>	Decodes the type of the currently accessed element

Home > @acoustic-content-sdk/react-edit-api > WchPlaceholderProvider

WchPlaceholderProvider interface

Signature:

export interface WchPlaceholderProvider 

Properties

Property	Type	Description
getPlaceholder	(aAccessor: AccessorType, aProvider: RenderingContextProviderV2) => WchPlaceholder

Home > @acoustic-content-sdk/react-edit-api > ACOUSTIC_CONTEXT_ACOUSTIC_CONFIG

ACOUSTIC_CONTEXT_ACOUSTIC_CONFIG variable

Injection token for the wch config

Signature:

ACOUSTIC_CONTEXT_ACOUSTIC_CONFIG: Required<import("react").Context<Observable<WchConfig>>>

Home > @acoustic-content-sdk/react-edit-api > ACOUSTIC_CONTEXT_DEBUG_PLACEHOLDERS

ACOUSTIC_CONTEXT_DEBUG_PLACEHOLDERS variable

Injection token for placeholder debugging

Signature:

ACOUSTIC_CONTEXT_DEBUG_PLACEHOLDERS: Required<import("react").Context<boolean>>

Home > @acoustic-content-sdk/react-edit-api > ACOUSTIC_CONTEXT_DEFAULT_PLACEHOLDER_TEXT

ACOUSTIC_CONTEXT_DEFAULT_PLACEHOLDER_TEXT variable

Injection token for default placeholder text

Signature:

ACOUSTIC_CONTEXT_DEFAULT_PLACEHOLDER_TEXT: Required<import("react").Context<import("@acoustic-content-sdk/utils").ObservableOrT<string | import("@acoustic-content-sdk/api").LocalizedText>>>

Home > @acoustic-content-sdk/react-edit-api > ACOUSTIC_CONTEXT_EDIT_HOST_WINDOW

ACOUSTIC_CONTEXT_EDIT_HOST_WINDOW variable

Injects the window that acts as the edit host for an application. This is typically the parent window or the opener window.

Signature:

ACOUSTIC_CONTEXT_EDIT_HOST_WINDOW: Required<import("react").Context<WindowType>>

Home > @acoustic-content-sdk/react-edit-api > ACOUSTIC_CONTEXT_INLINE_EDIT_PROVIDER

ACOUSTIC_CONTEXT_INLINE_EDIT_PROVIDER variable

Injection token for the inline edit provider

Signature:

ACOUSTIC_CONTEXT_INLINE_EDIT_PROVIDER: Required<import("react").Context<Observable<WchInlineEditProviderV2>>>

Home > @acoustic-content-sdk/react-edit-api > ACOUSTIC_CONTEXT_INLINE_EDIT_SELECTION_PROVIDER

ACOUSTIC_CONTEXT_INLINE_EDIT_SELECTION_PROVIDER variable

Provides information about the inline edit selection

Signature:

ACOUSTIC_CONTEXT_INLINE_EDIT_SELECTION_PROVIDER: Required<import("react").Context<InlineEditSelectionProvider>>

Home > @acoustic-content-sdk/react-edit-api > ACOUSTIC_CONTEXT_INLINE_EDIT_SERVICE

ACOUSTIC_CONTEXT_INLINE_EDIT_SERVICE variable

Signature:

ACOUSTIC_CONTEXT_INLINE_EDIT_SERVICE: Required<import("react").Context<WchInlineEditServiceV2>>

Home > @acoustic-content-sdk/react-edit-api > ACOUSTIC_CONTEXT_INLINE_EDIT_URL

ACOUSTIC_CONTEXT_INLINE_EDIT_URL variable

Signature:

ACOUSTIC_CONTEXT_INLINE_EDIT_URL: Required<import("react").Context<StaticHubInfoUrlProvider>>

Home > @acoustic-content-sdk/react-edit-api > ACOUSTIC_CONTEXT_PLACEHOLDER_PROVIDER

ACOUSTIC_CONTEXT_PLACEHOLDER_PROVIDER variable

Signature:

ACOUSTIC_CONTEXT_PLACEHOLDER_PROVIDER: Required<import("react").Context<WchPlaceholderProvider>>

Home > @acoustic-content-sdk/react-edit-api > DEFAULT_DEBUG_PLACEHOLDERS

DEFAULT_DEBUG_PLACEHOLDERS variable

per default do not debug

Signature:

DEFAULT_DEBUG_PLACEHOLDERS = false

Home > @acoustic-content-sdk/react-edit-api > DEFAULT_INLINE_EDIT_URL

DEFAULT_INLINE_EDIT_URL variable

default value for the inline edit URL

Signature:

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

Home > @acoustic-content-sdk/react-edit-api > EVENT_EDIT_END

EVENT_EDIT_END variable

Signature:

EVENT_EDIT_END = "wchEditEnd"

Home > @acoustic-content-sdk/react-edit-api > EVENT_EDIT_START

EVENT_EDIT_START variable

Signature:

EVENT_EDIT_START = "wchEditStart"

Home > @acoustic-content-sdk/react-edit-api > EVENT_INLINE_EDIT_END

EVENT_INLINE_EDIT_END variable

Signature:

EVENT_INLINE_EDIT_END = "wchInlineEditEnd"

Home > @acoustic-content-sdk/react-edit-api > EVENT_INLINE_EDIT_START

EVENT_INLINE_EDIT_START variable

Signature:

EVENT_INLINE_EDIT_START = "wchInlineEditStart"

Home > @acoustic-content-sdk/react-edit-api > VERSION

VERSION variable

Version and build number of the package

Signature:

VERSION: {
    version: {
        major: string;
        minor: string;
        patch: string;
        branch: string;
    };
    build: Date;
}

Home > @acoustic-content-sdk/react-edit-api > WchDefaultPlaceholder

WchDefaultPlaceholder type

type for placeholder

Signature:

export declare type WchDefaultPlaceholder = ObservableOrT<string | LocalizedText>;

Home > @acoustic-content-sdk/react-edit-api > WchPlaceholder > accessor$

WchPlaceholder.accessor$ property

The accessor expression

Signature:

accessor$: Observable<string>;

Home > @acoustic-content-sdk/react-edit-api > WchPlaceholder > data$

WchPlaceholder.data$ property

Generates the accessed data, decoded from the accessor expression

Signature:

data$: Observable<any>;

Home > @acoustic-content-sdk/react-edit-api > WchPlaceholder > formattedText$

WchPlaceholder.formattedText$ property

Generates the formatted text of an element, potentially replaced by the placeholder

Signature:

formattedText$: Observable<LocalizedText>;

Home > @acoustic-content-sdk/react-edit-api > WchPlaceholder > placeholder$

WchPlaceholder.placeholder$ property

Event exposing the current placeholder. If no placeholder exists or placeholders are disabled, this will return 'undefined'.

Signature:

placeholder$: Observable<AuthoringPlaceholder>;

Home > @acoustic-content-sdk/react-edit-api > WchPlaceholder > placeholderText$

WchPlaceholder.placeholderText$ property

Event exposing the current placeholder text. If placeholders are disabled, this will return 'undefined'. If no placeholder has been defined this returns the default placeholder as specified by the application, else 'undefined'.

Signature:

placeholderText$: Observable<LocalizedText>;

Home > @acoustic-content-sdk/react-edit-api > WchPlaceholder > plainText$

WchPlaceholder.plainText$ property

Generates the text of an element, potentially replaced by the placeholder

Signature:

plainText$: Observable<LocalizedText>;

Home > @acoustic-content-sdk/react-edit-api > WchPlaceholder > showPlaceholder$

WchPlaceholder.showPlaceholder$ property

Checks if we should show or hide placeholders

Signature:

showPlaceholder$: Observable<boolean>;

Home > @acoustic-content-sdk/react-edit-api > WchPlaceholder > typeId$

WchPlaceholder.typeId$ property

Decodes the type of the currently accessed element

Signature:

typeId$: Observable<string>;

Home > @acoustic-content-sdk/react-edit-api > WchPlaceholderProvider > getPlaceholder

WchPlaceholderProvider.getPlaceholder property

Signature:

getPlaceholder: (aAccessor: AccessorType, aProvider: RenderingContextProviderV2) => WchPlaceholder;

Home > @acoustic-content-sdk/react-edit-api > EditHubInfoService > debugPlaceholders

EditHubInfoService.debugPlaceholders property

Enable or disable placeholders even if inline edit mode has not been enabled

Signature:

readonly debugPlaceholders?: boolean;

Home > @acoustic-content-sdk/react-edit-api > EditHubInfoService > defaultPlaceholderText

EditHubInfoService.defaultPlaceholderText property

Provide a default placeholder text

Signature:

readonly defaultPlaceholderText?: WchDefaultPlaceholder;

Home > @acoustic-content-sdk/react-edit-api > EditHubInfoService > inlineEditUrl

EditHubInfoService.inlineEditUrl property

Signature:

readonly inlineEditUrl?: HubInfoUrlProvider;

Home > @acoustic-content-sdk/react-edit-api > EditHubInfoService > placeholderTag

EditHubInfoService.placeholderTag property

Tag used to find placeholder content items. If left undefined, placeholders will not be inserted, automatically

Signature:

readonly placeholderTag?: string;

Home > @acoustic-content-sdk/react-edit-api > EditHubInfoService > throttleLoading

EditHubInfoService.throttleLoading property

Throttle loading of lib

Signature:

readonly throttleLoading?: number;