Class UmbBlockRteManagerContext<BlockLayoutType>

A implementation of the Block Manager specifically for the Rich Text Editor.

Type Parameters

BlockLayoutType extends UmbBlockRteLayoutModel = UmbBlockRteLayoutModel

Hierarchy (View Summary)

UmbBlockManagerContext<UmbBlockRteTypeModel, BlockLayoutType>
- UmbBlockRteManagerContext

Index

Constructors

constructor

new UmbBlockRteManagerContext<
BlockLayoutType extends UmbBlockRteLayoutModel = UmbBlockRteLayoutModel,
>(
host: UmbControllerHost,
): UmbBlockRteManagerContext<BlockLayoutType>
Type Parameters
- BlockLayoutType extends UmbBlockRteLayoutModel = UmbBlockRteLayoutModel
Parameters
- host: UmbControllerHost
Returns UmbBlockRteManagerContext<BlockLayoutType>
Inherited from UmbBlockManagerContext.constructor
- Defined in src/packages/block/block/context/block-manager.context.ts:174

Properties

`Protected`_editorConfiguration

_editorConfiguration: UmbClassState<
undefined
| UmbPropertyEditorConfigCollection,
> = ...

_host

_host: UmbControllerHost

`Protected`_layouts

_layouts: UmbArrayState<BlockLayoutType, string> = ...

`Protected`_liveEditingMode

_liveEditingMode: UmbBooleanState<undefined> = ...

`Readonly`blockTypes

blockTypes: Observable<UmbBlockRteTypeModel[]> = ...

`Readonly`contents

contents: Observable<UmbBlockDataModel[]> = ...

`Readonly`editorConfiguration

editorConfiguration: Observable<undefined | UmbPropertyEditorConfigCollection> = ...

`Readonly`exposes

exposes: Observable<UmbBlockExposeModel[]> = ...

`Readonly`layouts

layouts: Observable<BlockLayoutType[]> = ...

`Readonly`liveEditingMode

liveEditingMode: Observable<undefined | boolean> = ...

`Readonly`pendingDeletions

pendingDeletions: Observable<string[]> = ...

propertyAlias

propertyAlias: Observable<undefined | string> = ...

`Readonly`readOnlyState

readOnlyState: UmbReadOnlyVariantGuardManager = ...

`Readonly`settings

settings: Observable<UmbBlockDataModel[]> = ...

variantId

variantId: Observable<undefined | UmbVariantId> = ...

Accessors

contentTypesLoaded

get contentTypesLoaded(): Promise<unknown[]>
Returns Promise<unknown[]>
Inherited from UmbBlockManagerContext.contentTypesLoaded
- Defined in src/packages/block/block/context/block-manager.context.ts:40

controllerAlias

get controllerAlias(): UmbControllerAlias
Returns UmbControllerAlias
Inherited from UmbBlockManagerContext.controllerAlias
- Defined in src/libs/controller-api/controller.interface.ts:3

Methods

`Protected`_createBlockData

_createBlockData(
    contentElementTypeKey: string,
    partialLayoutEntry?: Omit<BlockLayoutType, "contentKey">,
): Promise<
    {
        content: { contentTypeKey: string; key: string; values: ReturnType[] };
        layout: BlockLayoutType;
        settings: undefined | UmbBlockDataModel;
    },
>
Parameters
- contentElementTypeKey: string
- OptionalpartialLayoutEntry: Omit<BlockLayoutType, "contentKey">
Returns Promise<
    {
        content: { contentTypeKey: string; key: string; values: ReturnType[] };
        layout: BlockLayoutType;
        settings: undefined | UmbBlockDataModel;
    },
>
Inherited from UmbBlockManagerContext._createBlockData
- Defined in src/packages/block/block/context/block-manager.context.ts:512

`Protected`_createBlockElementData

_createBlockElementData(
key: string,
contentTypeKey: string,
): Promise<{ contentTypeKey: string; key: string; values: ReturnType[] }>
Parameters
- key: string
- contentTypeKey: string
Returns Promise<{ contentTypeKey: string; key: string; values: ReturnType[] }>
Inherited from UmbBlockManagerContext._createBlockElementData
- Defined in src/packages/block/block/context/block-manager.context.ts:444

addEventListener

addEventListener(
    type: string,
    callback: null | EventListenerOrEventListenerObject,
    options?: boolean | AddEventListenerOptions,
): void
The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

MDN Reference
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Inherited from UmbBlockManagerContext.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11569

addUmbController

addUmbController(controller: UmbController): void
Parameters
- controller: UmbController
Returns void
Inherited from UmbBlockManagerContext.addUmbController
- Defined in src/libs/controller-api/controller-host.interface.ts:6

blockTypeOf

blockTypeOf(
contentTypeKey: string,
): Observable<undefined | UmbBlockRteTypeModel>
Parameters
- contentTypeKey: string
Returns Observable<undefined | UmbBlockRteTypeModel>
Inherited from UmbBlockManagerContext.blockTypeOf
- Defined in src/packages/block/block/context/block-manager.context.ts:286

clearPendingDeletion

clearPendingDeletion(contentKey: string): void
Clear a pending deletion after it has been processed.
Parameters
- contentKey: string
  The content key to clear from pending deletions.
Returns void
- Defined in src/packages/block/block-rte/context/block-rte-manager.context.ts:38

consumeContext

consumeContext<
    BaseType extends UmbContextMinimal = UmbContextMinimal,
    ResultType extends UmbContextMinimal = BaseType,
>(
    alias: string | UmbContextToken<BaseType, ResultType>,
    callback: UmbContextCallback<ResultType>,
): UmbContextConsumerController<BaseType, ResultType>
Type Parameters
- BaseType extends UmbContextMinimal = UmbContextMinimal
- ResultType extends UmbContextMinimal = BaseType
Parameters
- alias: string | UmbContextToken<BaseType, ResultType>
- callback: UmbContextCallback<ResultType>
  Callback method called when context is resolved.
Returns UmbContextConsumerController<BaseType, ResultType>
Reference to the created Context Consumer Controller instance

Description
Setup a subscription for a context. The callback is called when the context is resolved.

Memberof
UmbClassInterface
Inherited from UmbBlockManagerContext.consumeContext
- Defined in src/libs/class-api/class.interface.ts:64

contentOf

contentOf(key: string): Observable<undefined | UmbBlockDataModel>
Parameters
- key: string
Returns Observable<undefined | UmbBlockDataModel>
Inherited from UmbBlockManagerContext.contentOf
- Defined in src/packages/block/block/context/block-manager.context.ts:295

contentProperty

contentProperty(key: string, propertyAlias: string): void
Parameters
- key: string
- propertyAlias: string
Returns void
Inherited from UmbBlockManagerContext.contentProperty
- Defined in src/packages/block/block/context/block-manager.context.ts:409

contentTypeNameOf

contentTypeNameOf(
contentTypeKey: string,
): undefined | Observable<undefined | string>
Parameters
- contentTypeKey: string
Returns undefined | Observable<undefined | string>
Inherited from UmbBlockManagerContext.contentTypeNameOf
- Defined in src/packages/block/block/context/block-manager.context.ts:268

contentTypeOf

contentTypeOf(
contentTypeKey: string,
): undefined | Observable<undefined | UmbContentTypeModel>
Parameters
- contentTypeKey: string
Returns undefined | Observable<undefined | UmbContentTypeModel>
Inherited from UmbBlockManagerContext.contentTypeOf
- Defined in src/packages/block/block/context/block-manager.context.ts:262

createBlockSettingsData

createBlockSettingsData(
contentElementTypeKey: string,
): Promise<{ contentTypeKey: string; key: string; values: never[] }>
Parameters
- contentElementTypeKey: string
Returns Promise<{ contentTypeKey: string; key: string; values: never[] }>
Inherited from UmbBlockManagerContext.createBlockSettingsData
- Defined in src/packages/block/block/context/block-manager.context.ts:426

createWithPresets

createWithPresets(
    contentElementTypeKey: string,
    partialLayoutEntry?: Omit<BlockLayoutType, "contentKey">,
    _originData?: UmbBlockRteWorkspaceOriginData,
): Promise<
    {
        content: { contentTypeKey: string; key: string; values: ReturnType[] };
        layout: BlockLayoutType;
        settings: undefined | UmbBlockDataModel;
    },
>
Parameters
- contentElementTypeKey: string
- OptionalpartialLayoutEntry: Omit<BlockLayoutType, "contentKey">
- Optional_originData: UmbBlockRteWorkspaceOriginData
Returns Promise<
    {
        content: { contentTypeKey: string; key: string; values: ReturnType[] };
        layout: BlockLayoutType;
        settings: undefined | UmbBlockDataModel;
    },
>
Overrides UmbBlockManagerContext.createWithPresets
- Defined in src/packages/block/block-rte/context/block-rte-manager.context.ts:54

currentExposeOf

currentExposeOf(
contentKey: string,
): Observable<undefined | false | UmbBlockExposeModel>
Parameters
- contentKey: string
Returns Observable<undefined | false | UmbBlockExposeModel>
Inherited from UmbBlockManagerContext.currentExposeOf
- Defined in src/packages/block/block/context/block-manager.context.ts:302

deleteLayoutElement

deleteLayoutElement(contentKey: string): void
Internal
Parameters
- contentKey: string
Returns void
- Defined in src/packages/block/block-rte/context/block-rte-manager.context.ts:89

destroy

destroy(): void
Returns void
Inherited from UmbBlockManagerContext.destroy
- Defined in src/libs/controller-api/controller.interface.ts:6

dispatchEvent

dispatchEvent(event: Event): boolean
The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

MDN Reference
Parameters
- event: Event
Returns boolean
Inherited from UmbBlockManagerContext.dispatchEvent
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11575

editorConfigurationPart

editorConfigurationPart(
    method: MappingFunction<
        undefined
        | UmbPropertyEditorConfigCollection,
        unknown,
    >,
): Observable<unknown>
Parameters
- method: MappingFunction<undefined | UmbPropertyEditorConfigCollection, unknown>
Returns Observable<unknown>
Inherited from UmbBlockManagerContext.editorConfigurationPart
- Defined in src/packages/block/block/context/block-manager.context.ts:99

getBlockTypeOf

getBlockTypeOf(contentTypeKey: string): undefined | UmbBlockRteTypeModel
Parameters
- contentTypeKey: string
Returns undefined | UmbBlockRteTypeModel
Inherited from UmbBlockManagerContext.getBlockTypeOf
- Defined in src/packages/block/block/context/block-manager.context.ts:354

getBlockTypes

getBlockTypes(): UmbBlockRteTypeModel[]
Returns UmbBlockRteTypeModel[]
Inherited from UmbBlockManagerContext.getBlockTypes
- Defined in src/packages/block/block/context/block-manager.context.ts:106

getContentOf

getContentOf(contentKey: string): undefined | UmbBlockDataModel
Parameters
- contentKey: string
Returns undefined | UmbBlockDataModel
Inherited from UmbBlockManagerContext.getContentOf
- Defined in src/packages/block/block/context/block-manager.context.ts:357

getContents

getContents(): UmbBlockDataModel[]
Get all contents.

Returns UmbBlockDataModel[]
- All contents.
Inherited from UmbBlockManagerContext.getContents
- Defined in src/packages/block/block/context/block-manager.context.ts:138

getContentTypeHasProperties

getContentTypeHasProperties(contentTypeKey: string): undefined | boolean
Parameters
- contentTypeKey: string
Returns undefined | boolean
Inherited from UmbBlockManagerContext.getContentTypeHasProperties
- Defined in src/packages/block/block/context/block-manager.context.ts:280

getContentTypeKeyOfContentKey

getContentTypeKeyOfContentKey(contentKey: string): undefined | string
Parameters
- contentKey: string
Returns undefined | string
Inherited from UmbBlockManagerContext.getContentTypeKeyOfContentKey
- Defined in src/packages/block/block/context/block-manager.context.ts:259

getContentTypeNameOf

getContentTypeNameOf(contentTypeKey: string): undefined | string
Parameters
- contentTypeKey: string
Returns undefined | string
Inherited from UmbBlockManagerContext.getContentTypeNameOf
- Defined in src/packages/block/block/context/block-manager.context.ts:274

getContext

getContext<
    BaseType extends UmbContextMinimal = UmbContextMinimal,
    ResultType extends UmbContextMinimal = BaseType,
>(
    alias: string | UmbContextToken<BaseType, ResultType>,
    options?: UmbClassGetContextOptions,
): Promise<undefined | ResultType>
Type Parameters
- BaseType extends UmbContextMinimal = UmbContextMinimal
- ResultType extends UmbContextMinimal = BaseType
Parameters
- alias: string | UmbContextToken<BaseType, ResultType>
- Optionaloptions: UmbClassGetContextOptions
Returns Promise<undefined | ResultType>
A Promise with the reference to the Context Api Instance

Description
Retrieve a context. Notice this is a one time retrieving of a context, meaning if you expect this to be up to date with reality you should instead use the consumeContext method.

Memberof
UmbClassInterface
Inherited from UmbBlockManagerContext.getContext
- Defined in src/libs/class-api/class.interface.ts:75

getEditorConfiguration

getEditorConfiguration(): undefined | UmbPropertyEditorConfigCollection
Returns undefined | UmbPropertyEditorConfigCollection
Inherited from UmbBlockManagerContext.getEditorConfiguration
- Defined in src/packages/block/block/context/block-manager.context.ts:96

getExposes

getExposes(): UmbBlockExposeModel[]
Get all exposes.

Returns UmbBlockExposeModel[]
- All exposes.
Inherited from UmbBlockManagerContext.getExposes
- Defined in src/packages/block/block/context/block-manager.context.ts:170

getHostElement

getHostElement(): Element
Returns Element
Inherited from UmbBlockManagerContext.getHostElement
- Defined in src/libs/controller-api/controller-host.interface.ts:9

getLayouts

getLayouts(): BlockLayoutType[]
Get all layouts.

Returns BlockLayoutType[]
- All layouts.
Inherited from UmbBlockManagerContext.getLayouts
- Defined in src/packages/block/block/context/block-manager.context.ts:122

getSettings

getSettings(): UmbBlockDataModel[]
Get all settings.

Returns UmbBlockDataModel[]
- All settings.
Inherited from UmbBlockManagerContext.getSettings
- Defined in src/packages/block/block/context/block-manager.context.ts:154

getSettingsOf

getSettingsOf(settingsKey: string): undefined | UmbBlockDataModel
Parameters
- settingsKey: string
Returns undefined | UmbBlockDataModel
Inherited from UmbBlockManagerContext.getSettingsOf
- Defined in src/packages/block/block/context/block-manager.context.ts:360

getStructure

getStructure(
unique: string,
): undefined | UmbContentTypeStructureManager<UmbContentTypeModel>
Parameters
- unique: string
Returns undefined | UmbContentTypeStructureManager<UmbContentTypeModel>
Inherited from UmbBlockManagerContext.getStructure
- Defined in src/packages/block/block/context/block-manager.context.ts:255

getUmbControllers

getUmbControllers(
filterMethod: (ctrl: UmbController) => boolean,
): UmbController[]
Parameters
- filterMethod: (ctrl: UmbController) => boolean
Returns UmbController[]
Inherited from UmbBlockManagerContext.getUmbControllers
- Defined in src/libs/controller-api/controller-host.interface.ts:5

getVariantId

getVariantId(): undefined | UmbVariantId
Returns undefined | UmbVariantId
Inherited from UmbBlockManagerContext.getVariantId
- Defined in src/packages/block/block/context/block-manager.context.ts:57

hasExposeOf

hasExposeOf(
contentKey: string,
variantId: UmbVariantId,
): undefined | Observable<boolean>
Parameters
- contentKey: string
- variantId: UmbVariantId
Returns undefined | Observable<boolean>
Inherited from UmbBlockManagerContext.hasExposeOf
- Defined in src/packages/block/block/context/block-manager.context.ts:328

hasUmbController

hasUmbController(controller: UmbController): boolean
Parameters
- controller: UmbController
Returns boolean
Inherited from UmbBlockManagerContext.hasUmbController
- Defined in src/libs/controller-api/controller-host.interface.ts:4

hostConnected

hostConnected(): void
Returns void
Inherited from UmbBlockManagerContext.hostConnected
- Defined in src/libs/controller-api/controller.interface.ts:4

hostDisconnected

hostDisconnected(): void
Returns void
Inherited from UmbBlockManagerContext.hostDisconnected
- Defined in src/libs/controller-api/controller.interface.ts:5

insert

insert(
    layoutEntry: BlockLayoutType,
    content: UmbBlockDataModel,
    settings: undefined | UmbBlockDataModel,
    originData: UmbBlockRteWorkspaceOriginData,
): boolean
Parameters
- layoutEntry: BlockLayoutType
- content: UmbBlockDataModel
- settings: undefined | UmbBlockDataModel
- originData: UmbBlockRteWorkspaceOriginData
Returns boolean
Overrides UmbBlockManagerContext.insert
- Defined in src/packages/block/block-rte/context/block-rte-manager.context.ts:72

`Protected`insertBlockData

insertBlockData(
    layoutEntry: BlockLayoutType,
    content: UmbBlockDataModel,
    settings: undefined | UmbBlockDataModel,
    _originData: UmbBlockWorkspaceOriginData,
): void
Parameters
- layoutEntry: BlockLayoutType
- content: UmbBlockDataModel
- settings: undefined | UmbBlockDataModel
- _originData: UmbBlockWorkspaceOriginData
Returns void
Inherited from UmbBlockManagerContext.insertBlockData
- Defined in src/packages/block/block/context/block-manager.context.ts:550

layoutOf

layoutOf(contentKey: string): Observable<undefined | BlockLayoutType>
Parameters
- contentKey: string
Returns Observable<undefined | BlockLayoutType>
Inherited from UmbBlockManagerContext.layoutOf
- Defined in src/packages/block/block/context/block-manager.context.ts:292

`Protected`notifyBlockInserted

notifyBlockInserted(
layoutEntry: BlockLayoutType,
originData: UmbBlockWorkspaceOriginData,
): Promise<void>
Parameters
- layoutEntry: BlockLayoutType
- originData: UmbBlockWorkspaceOriginData
Returns Promise<void>
Inherited from UmbBlockManagerContext.notifyBlockInserted
- Defined in src/packages/block/block/context/block-manager.context.ts:573

observe

observe<
    ObservableType extends undefined
    | Observable<T>,
    T,
    SpecificT = ObservableType extends Observable<U>
        ? ObservableType<ObservableType> extends undefined ? undefined | U : U
        : undefined,
    SpecificR = ObservableType extends undefined
        ? undefined
        | UmbObserverController<SpecificT>
        : UmbObserverController<SpecificT>,
>(
    source: ObservableType,
    callback?: ObserverCallback<SpecificT>,
    controllerAlias?: null | UmbControllerAlias,
): SpecificR
Type Parameters
- ObservableType extends undefined | Observable<T>
- T
- SpecificT = ObservableType extends Observable<U>
  ? ObservableType<ObservableType> extends undefined ? undefined | U : U
  : undefined
- SpecificR = ObservableType extends undefined
      ? undefined
      | UmbObserverController<SpecificT>
      : UmbObserverController<SpecificT>
Parameters
- source: ObservableType
  An Observable to observe from.
- Optionalcallback: ObserverCallback<SpecificT>
  Callback method called when data is changed.
- OptionalcontrollerAlias: null | UmbControllerAlias
  Define an explicit controller alias. If not defined then one will be generated based on the callback function. If null is parsed no controller alias will be given.
Returns SpecificR
Reference to the created Observer Controller instance.

Description
Observe an Observable. An Observable is a declared source of data that can be observed. An observables is declared from a UmbState.

Memberof
UmbClassInterface
Inherited from UmbBlockManagerContext.observe
- Defined in src/libs/class-api/class.interface.ts:27

provideContext

provideContext<R extends UmbContextMinimal = UmbContextMinimal>(
alias: string | UmbContextToken<R, R>,
instance: R,
): UmbContextProviderController<R>
Type Parameters
- R extends UmbContextMinimal = UmbContextMinimal
Parameters
- alias: string | UmbContextToken<R, R>
- instance: R
  The API instance to be exposed.
Returns UmbContextProviderController<R>
Reference to the created Context Provider Controller instance

Description
Provide a context API for this or child elements.

Memberof
UmbClassInterface
Inherited from UmbBlockManagerContext.provideContext
- Defined in src/libs/class-api/class.interface.ts:52

`Protected`removeBlockKey

removeBlockKey(contentKey: string): void
Parameters
- contentKey: string
Returns void
Inherited from UmbBlockManagerContext.removeBlockKey
- Defined in src/packages/block/block/context/block-manager.context.ts:616

removeCurrentExpose

removeCurrentExpose(contentKey: string): void
Parameters
- contentKey: string
Returns void
Inherited from UmbBlockManagerContext.removeCurrentExpose
- Defined in src/packages/block/block/context/block-manager.context.ts:396

removeEventListener

removeEventListener(
    type: string,
    callback: null | EventListenerOrEventListenerObject,
    options?: boolean | EventListenerOptions,
): void
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

MDN Reference
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optionaloptions: boolean | EventListenerOptions
Returns void
Inherited from UmbBlockManagerContext.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11581

removeExposesOf

removeExposesOf(contentKey: string): void
Parameters
- contentKey: string
Returns void
Inherited from UmbBlockManagerContext.removeExposesOf
- Defined in src/packages/block/block/context/block-manager.context.ts:393

removeManyContent

removeManyContent(contentKeys: string[]): void
Parameters
- contentKeys: string[]
Returns void
Inherited from UmbBlockManagerContext.removeManyContent
- Defined in src/packages/block/block/context/block-manager.context.ts:386

removeManyLayouts

removeManyLayouts(contentKeys: string[]): void
Parameters
- contentKeys: string[]
Returns void
- Defined in src/packages/block/block-rte/context/block-rte-manager.context.ts:45

removeManySettings

removeManySettings(settingsKeys: string[]): void
Parameters
- settingsKeys: string[]
Returns void
Inherited from UmbBlockManagerContext.removeManySettings
- Defined in src/packages/block/block/context/block-manager.context.ts:389

removeOneContent

removeOneContent(contentKey: string): void
Parameters
- contentKey: string
Returns void
Inherited from UmbBlockManagerContext.removeOneContent
- Defined in src/packages/block/block/context/block-manager.context.ts:379

removeOneLayout

removeOneLayout(contentKey: string): void
Parameters
- contentKey: string
Returns void
- Defined in src/packages/block/block-rte/context/block-rte-manager.context.ts:42

removeOneSettings

removeOneSettings(settingsKey: string): void
Parameters
- settingsKey: string
Returns void
Inherited from UmbBlockManagerContext.removeOneSettings
- Defined in src/packages/block/block/context/block-manager.context.ts:382

removeUmbController

removeUmbController(controller: UmbController): void
Parameters
- controller: UmbController
Returns void
Inherited from UmbBlockManagerContext.removeUmbController
- Defined in src/libs/controller-api/controller-host.interface.ts:8

removeUmbControllerByAlias

removeUmbControllerByAlias(unique: UmbControllerAlias): void
Parameters
- unique: UmbControllerAlias
Returns void
Inherited from UmbBlockManagerContext.removeUmbControllerByAlias
- Defined in src/libs/controller-api/controller-host.interface.ts:7

requestPendingDeletion

requestPendingDeletion(contentKey: string): void
Request a block to be deleted. This adds the contentKey to pending deletions, which will be processed by the Tiptap API to remove the HTML element first, enabling undo support.
Parameters
- contentKey: string
  The content key of the block to delete.
Returns void
- Defined in src/packages/block/block-rte/context/block-rte-manager.context.ts:30

setBlockTypes

setBlockTypes(blockTypes: UmbBlockRteTypeModel[]): void
Parameters
- blockTypes: UmbBlockRteTypeModel[]
Returns void
Inherited from UmbBlockManagerContext.setBlockTypes
- Defined in src/packages/block/block/context/block-manager.context.ts:103

setContents

setContents(contents: UmbBlockDataModel[]): void
Set all contents.
Parameters
- contents: UmbBlockDataModel[]
  All contents.
Returns void
Inherited from UmbBlockManagerContext.setContents
- Defined in src/packages/block/block/context/block-manager.context.ts:130

setEditorConfiguration

setEditorConfiguration(configs: UmbPropertyEditorConfigCollection): void
Parameters
- configs: UmbPropertyEditorConfigCollection
Returns void
Inherited from UmbBlockManagerContext.setEditorConfiguration
- Defined in src/packages/block/block/context/block-manager.context.ts:90

setExposes

setExposes(exposes: UmbBlockExposeModel[]): void
Set all exposes.
Parameters
- exposes: UmbBlockExposeModel[]
  All exposes.
Returns void
Inherited from UmbBlockManagerContext.setExposes
- Defined in src/packages/block/block/context/block-manager.context.ts:162

setLayouts

setLayouts(layouts: BlockLayoutType[]): void
Set all layouts.
Parameters
- layouts: BlockLayoutType[]
  All layouts.
Returns void
Inherited from UmbBlockManagerContext.setLayouts
- Defined in src/packages/block/block/context/block-manager.context.ts:114

setOneContent

setOneContent(contentData: UmbBlockDataModel): void
Parameters
- contentData: UmbBlockDataModel
Returns void
Inherited from UmbBlockManagerContext.setOneContent
- Defined in src/packages/block/block/context/block-manager.context.ts:368

setOneContentProperty

setOneContentProperty(key: string, propertyAlias: string, value: unknown): void
Parameters
- key: string
- propertyAlias: string
- value: unknown
Returns void
Inherited from UmbBlockManagerContext.setOneContentProperty
- Defined in src/packages/block/block/context/block-manager.context.ts:402

setOneExpose

setOneExpose(contentKey: string, variantId: UmbVariantId): void
Parameters
- contentKey: string
- variantId: UmbVariantId
Returns void
Inherited from UmbBlockManagerContext.setOneExpose
- Defined in src/packages/block/block/context/block-manager.context.ts:374

setOneLayout

setOneLayout(
layoutData: BlockLayoutType,
_originData?: UmbBlockWorkspaceOriginData,
): void
Parameters
- layoutData: BlockLayoutType
- Optional_originData: UmbBlockWorkspaceOriginData
Returns void
Inherited from UmbBlockManagerContext.setOneLayout
- Defined in src/packages/block/block/context/block-manager.context.ts:365

setOneSettings

setOneSettings(settingsData: UmbBlockDataModel): void
Parameters
- settingsData: UmbBlockDataModel
Returns void
Inherited from UmbBlockManagerContext.setOneSettings
- Defined in src/packages/block/block/context/block-manager.context.ts:371

setOneSettingsProperty

setOneSettingsProperty(key: string, propertyAlias: string, value: unknown): void
Parameters
- key: string
- propertyAlias: string
- value: unknown
Returns void
Inherited from UmbBlockManagerContext.setOneSettingsProperty
- Defined in src/packages/block/block/context/block-manager.context.ts:405

setPropertyAlias

setPropertyAlias(propertyAlias: undefined | string): void
Parameters
- propertyAlias: undefined | string
Returns void
Inherited from UmbBlockManagerContext.setPropertyAlias
- Defined in src/packages/block/block/context/block-manager.context.ts:48

setSettings

setSettings(settings: UmbBlockDataModel[]): void
Set all settings.
Parameters
- settings: UmbBlockDataModel[]
  All settings.
Returns void
Inherited from UmbBlockManagerContext.setSettings
- Defined in src/packages/block/block/context/block-manager.context.ts:146

settingsOf

settingsOf(key: string): Observable<undefined | UmbBlockDataModel>
Parameters
- key: string
Returns Observable<undefined | UmbBlockDataModel>
Inherited from UmbBlockManagerContext.settingsOf
- Defined in src/packages/block/block/context/block-manager.context.ts:298

settingsProperty

settingsProperty(key: string, propertyAlias: string): void
Parameters
- key: string
- propertyAlias: string
Returns void
Inherited from UmbBlockManagerContext.settingsProperty
- Defined in src/packages/block/block/context/block-manager.context.ts:414

setVariantId

setVariantId(variantId: undefined | UmbVariantId): void
Parameters
- variantId: undefined | UmbVariantId
Returns void
Inherited from UmbBlockManagerContext.setVariantId
- Defined in src/packages/block/block/context/block-manager.context.ts:54

Class UmbBlockRteManagerContext<BlockLayoutType>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns UmbBlockRteManagerContext<BlockLayoutType>

Properties

Protected_editorConfiguration

_host

Protected_layouts

Protected_liveEditingMode

ReadonlyblockTypes

Readonlycontents

ReadonlyeditorConfiguration

Readonlyexposes

Readonlylayouts

ReadonlyliveEditingMode

ReadonlypendingDeletions

propertyAlias

ReadonlyreadOnlyState

Readonlysettings

variantId

Accessors

contentTypesLoaded

Returns Promise<unknown[]>

controllerAlias

Returns UmbControllerAlias

Methods

Protected_createBlockData

Parameters

Returns Promise< { content: { contentTypeKey: string; key: string; values: ReturnType[] }; layout: BlockLayoutType; settings: undefined | UmbBlockDataModel; },>

Protected_createBlockElementData

Parameters

Returns Promise<{ contentTypeKey: string; key: string; values: ReturnType[] }>

addEventListener

Parameters

Returns void

addUmbController

Parameters

Returns void

blockTypeOf

Parameters

Returns Observable<undefined | UmbBlockRteTypeModel>

clearPendingDeletion

Parameters

Returns void

consumeContext

Type Parameters

Parameters

Returns UmbContextConsumerController<BaseType, ResultType>

Description

Memberof

contentOf

Parameters

Returns Observable<undefined | UmbBlockDataModel>

contentProperty

Parameters

Returns void

contentTypeNameOf

Parameters

Returns undefined | Observable<undefined | string>

contentTypeOf

Parameters

Returns undefined | Observable<undefined | UmbContentTypeModel>

createBlockSettingsData

Parameters

Returns Promise<{ contentTypeKey: string; key: string; values: never[] }>

createWithPresets

Parameters

Returns Promise< { content: { contentTypeKey: string; key: string; values: ReturnType[] }; layout: BlockLayoutType; settings: undefined | UmbBlockDataModel; },>

currentExposeOf

Parameters

Returns Observable<undefined | false | UmbBlockExposeModel>

`Protected`_editorConfiguration

`Protected`_layouts

`Protected`_liveEditingMode

`Readonly`blockTypes

`Readonly`contents

`Readonly`editorConfiguration

`Readonly`exposes

`Readonly`layouts

`Readonly`liveEditingMode

`Readonly`pendingDeletions

`Readonly`readOnlyState

`Readonly`settings

`Protected`_createBlockData

Returns Promise<
{
content: { contentTypeKey: string; key: string; values: ReturnType[] };
layout: BlockLayoutType;
settings: undefined | UmbBlockDataModel;
},
>

`Protected`_createBlockElementData

Returns Promise<
{
content: { contentTypeKey: string; key: string; values: ReturnType[] };
layout: BlockLayoutType;
settings: undefined | UmbBlockDataModel;
},
>