CoreMedia CKEditor 5 Plugins
    Preparing search index...

    Class BBCodeList

    Maps <ol>/<ul> to [list]. Respects the type` attribute for ordered lists.

    Note that this requires the CKEditor 5 DocumentList plugin to be configured with useAttribute. No support added for list-style options added to this mapping, as BBob still will set type in toView mapping when the HTML5 preset is used.

    One more note, why list-style-type may be the better option: CSS rules may not be applied based on case-sensitive type-attributes. First, browser manufacturers need to incorporate case-sensitive matching as sketched in https://github.com/w3c/csswg-drafts/issues/2101.

    Implements

    Index

    Constructors

    constructor

    Properties

    id tags

    Methods

    toData

    Constructors

    Properties

    id: "list"

    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.

    Methods

    • 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.

      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.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods