CoreMedia CKEditor 5 Plugins
    Preparing search index...

    Interface BBCodeProcessingRule

    interface BBCodeProcessingRule {
        id: string;
        tags?: string[];
        toData?: (element: HTMLElement, content: string) => string | undefined;
        toView?: undefined;
    }

    Implemented by

    Index

    Properties

    id tags? toData? toView?

    Properties

    id: string

    Some ID solely used for debugging purpose. Recommended to keep unique among rules, though.

    tags?: string[]

    BBCode tags, this rule is related to. Automatically also registers tags as known to BBCode to HTML processing.

    Typically, you list tags here, which are generated during toData mapping.

    toData?: (element: HTMLElement, content: string) => string | undefined

    Transforms an element or parts of it to BBCode. Typical rules will apply mapping according to the element type, name or one of its attributes.

    It is recommended to clean any consumed attribute values, to signal that they got processed.

    Type Declaration

      • (element: HTMLElement, content: string): string | undefined

      • Parameters

        • element: HTMLElement

          element to transform

        • content: string

          the current BBCode

        Returns string | undefined

        the new BBCode to continue with; undefined to continue with BBCode as is.

    toView?: undefined

    toView mapping, thus, BBCode to HTML relies on third-party tooling. No extension point available.

    Settings

    Member Visibility

    On This Page

    Properties