@umbraco-cms/backoffice
    Preparing search index...

    Class UmbUfmContext

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    filters: Observable<UmbUfmFilterType[]> = ...

    Observable of all registered UFM filters. Aliases reflect the canonical form registered by each filter's manifest (camelCase for built-in filters since v18 — e.g. stripHtml, not strip-html). Use getFilterByAlias for alias-based lookup; it maps deprecated kebab-case aliases automatically.

    Accessors

    Methods

    • 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: EventListenerOrEventListenerObject | null
      • Optionaloptions: boolean | AddEventListenerOptions

      Returns void

    • The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().

      MDN Reference

      Parameters

      • event: Event

      Returns boolean

    • Get a filter by its alias. Deprecated kebab-case aliases (e.g. strip-html, title-case, word-limit) are transparently resolved to their camelCase equivalents, with a one-time deprecation warning logged per alias.

      Parameters

      • alias: string

        The alias of the filter to retrieve.

      Returns UmbUfmFilterFunction

      The filter function associated with the alias, or undefined if not found.

    • Get the filters registered in the UFM context. Aliases reflect the canonical form registered by each filter's manifest (camelCase for built-in filters since v18 — e.g. stripHtml, not strip-html). Use getFilterByAlias for alias-based lookup; it maps deprecated kebab-case aliases automatically.

      Returns UmbUfmFilterType[]

      An array of filters with their aliases and filter functions.

    • Parse markdown content, optionally inline.

      Parameters

      • markdown: string

        The markdown string to parse.

      • inline: boolean

        If true, parse inline markdown; otherwise, parse block markdown.

      Returns Promise<string>

      A promise that resolves to the parsed HTML string.

    • The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.

      MDN Reference

      Parameters

      • type: string
      • callback: EventListenerOrEventListenerObject | null
      • Optionaloptions: boolean | EventListenerOptions

      Returns void