@witchcraft/editor
    Preparing search index...

    Interface HighlightMarkOptions<T>

    interface HighlightMarkOptions<
        T extends string = `slot${[1, 2, 3, 4, 5][number]}`,
    > {
        colors: Record<T, { color: string; matches?: string[]; name: string }>;
        defaultColor: T;
        HTMLAttributes: Record<string, any>;
    }

    Type Parameters

    • T extends string = `slot${[1, 2, 3, 4, 5][number]}`

    Hierarchy (View Summary)

    Index

    Properties

    colors defaultColor HTMLAttributes

    Properties

    colors: Record<T, { color: string; matches?: string[]; name: string }>

    The colors to use for the highlight in Record<name, {color: string, name: string}> format.

    This is to allow the colors/slots to be configurable by the user without needing to change the document when they do so since only the key is stored.

    The value is a record to allow additional properties to be stored.

    The matches property can be used to specify an additional array of strings/colors to match when parsing HTML.

    The default is Record<"slotX", {color: "rgbaa(...)", name: "colorName", matches?: [name, "#color"]}>

    defaultColor: T

    For when a non-matching color is found in the HTML. Default is slot1 which is yellow.

    HTMLAttributes: Record<string, any>

    Settings

    Member Visibility

    On This Page

    Properties