Interface WebchalkPresetEmphasisEffects

Typings for the preset emphasis animation effects that come with the library's emphasis bank.

interface WebchalkPresetEmphasisEffects {
    "~highlight": {
        defaultConfig: {
            cssClasses: { toAddOnStart: ["webchalk-highlightable"] };
        };
        howOftenBuildGenerators: "on-every-play";
        immutableConfig: { composite: "replace" };
        buildFrameGenerators(
            this: Readonly<
                Pick<
                    EmphasisClip<
                        Readonly<
                            StripDuplicateMethodAutocompletion<
                                {
                                    defaultConfig?: (...) & (...);
                                    howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                    immutableConfig?: (...) & (...);
                                    buildFrameGenerators(
                                        this: Readonly<Pick<(...), (...)>>,
                                        ...effectOptions: unknown[],
                                    ): EffectFrameGeneratorSet;
                                },
                            >,
                        >,
                    >,
                    | "domElem"
                    | "getEffectDetails"
                    | "getStatus"
                    | "getStyles"
                    | "getTiming",
                >,
            > & Readonly<
                Pick<
                    AnimClip<
                        Readonly<
                            StripDuplicateMethodAutocompletion<
                                {
                                    defaultConfig?: (...) & (...);
                                    howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                    immutableConfig?: (...) & (...);
                                    buildFrameGenerators(
                                        this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>, "computeTween">>,
                                        ...effectOptions: unknown[],
                                    ): EffectFrameGeneratorSet;
                                },
                            >,
                        >,
                        AnimClipConfig,
                    >,
                    "computeTween",
                >,
            >,
            color?: string,
        ): {
            keyframesGenerator_play: () => (
                | {
                    "--webchalk-highlight-color": string;
                    backgroundPositionX?: undefined;
                    easing: string;
                    offset?: undefined;
                }
                | {
                    "--webchalk-highlight-color"?: undefined;
                    backgroundPositionX: string;
                    easing?: undefined;
                    offset: number;
                }
                | {
                    "--webchalk-highlight-color": string;
                    backgroundPositionX?: undefined;
                    easing?: undefined;
                    offset?: undefined;
                }
            )[];
            keyframesGenerator_rewind: () => (
                | {
                    "--webchalk-highlight-color": string;
                    backgroundPositionX?: undefined;
                    easing: string;
                    offset?: undefined;
                }
                | {
                    "--webchalk-highlight-color"?: undefined;
                    backgroundPositionX: string;
                    easing?: undefined;
                    offset: number;
                }
                | {
                    "--webchalk-highlight-color": string;
                    backgroundPositionX?: undefined;
                    easing?: undefined;
                    offset?: undefined;
                }
            )[];
        };
    } & {
        defaultConfig: {
            cssClasses: { toAddOnStart: ["webchalk-highlightable"] };
        };
        howOftenBuildGenerators: "on-every-play";
        immutableConfig: { composite: "replace" };
        buildFrameGenerators(
            this: Readonly<
                Pick<
                    EmphasisClip<
                        Readonly<
                            StripDuplicateMethodAutocompletion<
                                {
                                    defaultConfig?: (...) & (...);
                                    howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                    immutableConfig?: (...) & (...);
                                    buildFrameGenerators(
                                        this: Readonly<Pick<(...), (...)>>,
                                        ...effectOptions: unknown[],
                                    ): EffectFrameGeneratorSet;
                                },
                            >,
                        >,
                    >,
                    | "domElem"
                    | "getEffectDetails"
                    | "getStatus"
                    | "getStyles"
                    | "getTiming",
                >,
            > & Readonly<
                Pick<
                    AnimClip<
                        Readonly<
                            StripDuplicateMethodAutocompletion<
                                {
                                    defaultConfig?: (...) & (...);
                                    howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                    immutableConfig?: (...) & (...);
                                    buildFrameGenerators(
                                        this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>, "computeTween">>,
                                        ...effectOptions: unknown[],
                                    ): EffectFrameGeneratorSet;
                                },
                            >,
                        >,
                        AnimClipConfig,
                    >,
                    "computeTween",
                >,
            >,
            color?: string,
        ): {
            keyframesGenerator_play: () => (
                | {
                    "--webchalk-highlight-color": string;
                    backgroundPositionX?: undefined;
                    easing: string;
                    offset?: undefined;
                }
                | {
                    "--webchalk-highlight-color"?: undefined;
                    backgroundPositionX: string;
                    easing?: undefined;
                    offset: number;
                }
                | {
                    "--webchalk-highlight-color": string;
                    backgroundPositionX?: undefined;
                    easing?: undefined;
                    offset?: undefined;
                }
            )[];
            keyframesGenerator_rewind: () => (
                | {
                    "--webchalk-highlight-color": string;
                    backgroundPositionX?: undefined;
                    easing: string;
                    offset?: undefined;
                }
                | {
                    "--webchalk-highlight-color"?: undefined;
                    backgroundPositionX: string;
                    easing?: undefined;
                    offset: number;
                }
                | {
                    "--webchalk-highlight-color": string;
                    backgroundPositionX?: undefined;
                    easing?: undefined;
                    offset?: undefined;
                }
            )[];
        };
    } & {
        defaultConfig: {
            cssClasses: { toAddOnStart: ["webchalk-highlightable"] };
        };
        howOftenBuildGenerators: "on-every-play";
        immutableConfig: { composite: "replace" };
        buildFrameGenerators(
            this: Readonly<
                Pick<
                    EmphasisClip<
                        Readonly<
                            StripDuplicateMethodAutocompletion<
                                {
                                    defaultConfig?: (...) & (...);
                                    howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                    immutableConfig?: (...) & (...);
                                    buildFrameGenerators(
                                        this: Readonly<Pick<(...), (...)>>,
                                        ...effectOptions: unknown[],
                                    ): EffectFrameGeneratorSet;
                                },
                            >,
                        >,
                    >,
                    | "domElem"
                    | "getEffectDetails"
                    | "getStatus"
                    | "getStyles"
                    | "getTiming",
                >,
            > & Readonly<
                Pick<
                    AnimClip<
                        Readonly<
                            StripDuplicateMethodAutocompletion<
                                {
                                    defaultConfig?: (...) & (...);
                                    howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                    immutableConfig?: (...) & (...);
                                    buildFrameGenerators(
                                        this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>, "computeTween">>,
                                        ...effectOptions: unknown[],
                                    ): EffectFrameGeneratorSet;
                                },
                            >,
                        >,
                        AnimClipConfig,
                    >,
                    "computeTween",
                >,
            >,
            color?: string,
        ): {
            keyframesGenerator_play: () => (
                | {
                    "--webchalk-highlight-color": string;
                    backgroundPositionX?: undefined;
                    easing: string;
                    offset?: undefined;
                }
                | {
                    "--webchalk-highlight-color"?: undefined;
                    backgroundPositionX: string;
                    easing?: undefined;
                    offset: number;
                }
                | {
                    "--webchalk-highlight-color": string;
                    backgroundPositionX?: undefined;
                    easing?: undefined;
                    offset?: undefined;
                }
            )[];
            keyframesGenerator_rewind: () => (
                | {
                    "--webchalk-highlight-color": string;
                    backgroundPositionX?: undefined;
                    easing: string;
                    offset?: undefined;
                }
                | {
                    "--webchalk-highlight-color"?: undefined;
                    backgroundPositionX: string;
                    easing?: undefined;
                    offset: number;
                }
                | {
                    "--webchalk-highlight-color": string;
                    backgroundPositionX?: undefined;
                    easing?: undefined;
                    offset?: undefined;
                }
            )[];
        };
    } & {
        defaultConfig: {
            cssClasses: { toAddOnStart: ["webchalk-highlightable"] };
        };
        howOftenBuildGenerators: "on-every-play";
        immutableConfig: { composite: "replace" };
        buildFrameGenerators(
            this: Readonly<
                Pick<
                    EmphasisClip<
                        Readonly<
                            StripDuplicateMethodAutocompletion<
                                {
                                    defaultConfig?: (...) & (...);
                                    howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                    immutableConfig?: (...) & (...);
                                    buildFrameGenerators(
                                        this: Readonly<Pick<(...), (...)>>,
                                        ...effectOptions: unknown[],
                                    ): EffectFrameGeneratorSet;
                                },
                            >,
                        >,
                    >,
                    | "domElem"
                    | "getEffectDetails"
                    | "getStatus"
                    | "getStyles"
                    | "getTiming",
                >,
            > & Readonly<
                Pick<
                    AnimClip<
                        Readonly<
                            StripDuplicateMethodAutocompletion<
                                {
                                    defaultConfig?: (...) & (...);
                                    howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                    immutableConfig?: (...) & (...);
                                    buildFrameGenerators(
                                        this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>, "computeTween">>,
                                        ...effectOptions: unknown[],
                                    ): EffectFrameGeneratorSet;
                                },
                            >,
                        >,
                        AnimClipConfig,
                    >,
                    "computeTween",
                >,
            >,
            color?: string,
        ): {
            keyframesGenerator_play: () => (
                | {
                    "--webchalk-highlight-color": string;
                    backgroundPositionX?: undefined;
                    easing: string;
                    offset?: undefined;
                }
                | {
                    "--webchalk-highlight-color"?: undefined;
                    backgroundPositionX: string;
                    easing?: undefined;
                    offset: number;
                }
                | {
                    "--webchalk-highlight-color": string;
                    backgroundPositionX?: undefined;
                    easing?: undefined;
                    offset?: undefined;
                }
            )[];
            keyframesGenerator_rewind: () => (
                | {
                    "--webchalk-highlight-color": string;
                    backgroundPositionX?: undefined;
                    easing: string;
                    offset?: undefined;
                }
                | {
                    "--webchalk-highlight-color"?: undefined;
                    backgroundPositionX: string;
                    easing?: undefined;
                    offset: number;
                }
                | {
                    "--webchalk-highlight-color": string;
                    backgroundPositionX?: undefined;
                    easing?: undefined;
                    offset?: undefined;
                }
            )[];
        };
    };
    "~un-highlight": {
        defaultConfig: {
            cssClasses: { toRemoveOnFinish: ["webchalk-highlightable"] };
        };
        howOftenBuildGenerators: "on-every-play";
        immutableConfig: { composite: "replace" };
        buildFrameGenerators(
            this: Readonly<
                Pick<
                    EmphasisClip<
                        Readonly<
                            StripDuplicateMethodAutocompletion<
                                {
                                    defaultConfig?: (...) & (...);
                                    howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                    immutableConfig?: (...) & (...);
                                    buildFrameGenerators(
                                        this: Readonly<Pick<(...), (...)>>,
                                        ...effectOptions: unknown[],
                                    ): EffectFrameGeneratorSet;
                                },
                            >,
                        >,
                    >,
                    | "domElem"
                    | "getEffectDetails"
                    | "getStatus"
                    | "getStyles"
                    | "getTiming",
                >,
            > & Readonly<
                Pick<
                    AnimClip<
                        Readonly<
                            StripDuplicateMethodAutocompletion<
                                {
                                    defaultConfig?: (...) & (...);
                                    howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                    immutableConfig?: (...) & (...);
                                    buildFrameGenerators(
                                        this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>, "computeTween">>,
                                        ...effectOptions: unknown[],
                                    ): EffectFrameGeneratorSet;
                                },
                            >,
                        >,
                        AnimClipConfig,
                    >,
                    "computeTween",
                >,
            >,
        ): { keyframesGenerator_play: () => { backgroundPositionX: string }[] };
    } & {
        defaultConfig: {
            cssClasses: { toRemoveOnFinish: ["webchalk-highlightable"] };
        };
        howOftenBuildGenerators: "on-every-play";
        immutableConfig: { composite: "replace" };
        buildFrameGenerators(
            this: Readonly<
                Pick<
                    EmphasisClip<
                        Readonly<
                            StripDuplicateMethodAutocompletion<
                                {
                                    defaultConfig?: (...) & (...);
                                    howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                    immutableConfig?: (...) & (...);
                                    buildFrameGenerators(
                                        this: Readonly<Pick<(...), (...)>>,
                                        ...effectOptions: unknown[],
                                    ): EffectFrameGeneratorSet;
                                },
                            >,
                        >,
                    >,
                    | "domElem"
                    | "getEffectDetails"
                    | "getStatus"
                    | "getStyles"
                    | "getTiming",
                >,
            > & Readonly<
                Pick<
                    AnimClip<
                        Readonly<
                            StripDuplicateMethodAutocompletion<
                                {
                                    defaultConfig?: (...) & (...);
                                    howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                    immutableConfig?: (...) & (...);
                                    buildFrameGenerators(
                                        this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>, "computeTween">>,
                                        ...effectOptions: unknown[],
                                    ): EffectFrameGeneratorSet;
                                },
                            >,
                        >,
                        AnimClipConfig,
                    >,
                    "computeTween",
                >,
            >,
        ): { keyframesGenerator_play: () => { backgroundPositionX: string }[] };
    } & {
        defaultConfig: {
            cssClasses: { toRemoveOnFinish: ["webchalk-highlightable"] };
        };
        howOftenBuildGenerators: "on-every-play";
        immutableConfig: { composite: "replace" };
        buildFrameGenerators(
            this: Readonly<
                Pick<
                    EmphasisClip<
                        Readonly<
                            StripDuplicateMethodAutocompletion<
                                {
                                    defaultConfig?: (...) & (...);
                                    howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                    immutableConfig?: (...) & (...);
                                    buildFrameGenerators(
                                        this: Readonly<Pick<(...), (...)>>,
                                        ...effectOptions: unknown[],
                                    ): EffectFrameGeneratorSet;
                                },
                            >,
                        >,
                    >,
                    | "domElem"
                    | "getEffectDetails"
                    | "getStatus"
                    | "getStyles"
                    | "getTiming",
                >,
            > & Readonly<
                Pick<
                    AnimClip<
                        Readonly<
                            StripDuplicateMethodAutocompletion<
                                {
                                    defaultConfig?: (...) & (...);
                                    howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                    immutableConfig?: (...) & (...);
                                    buildFrameGenerators(
                                        this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>, "computeTween">>,
                                        ...effectOptions: unknown[],
                                    ): EffectFrameGeneratorSet;
                                },
                            >,
                        >,
                        AnimClipConfig,
                    >,
                    "computeTween",
                >,
            >,
        ): { keyframesGenerator_play: () => { backgroundPositionX: string }[] };
    } & {
        defaultConfig: {
            cssClasses: { toRemoveOnFinish: ["webchalk-highlightable"] };
        };
        howOftenBuildGenerators: "on-every-play";
        immutableConfig: { composite: "replace" };
        buildFrameGenerators(
            this: Readonly<
                Pick<
                    EmphasisClip<
                        Readonly<
                            StripDuplicateMethodAutocompletion<
                                {
                                    defaultConfig?: (...) & (...);
                                    howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                    immutableConfig?: (...) & (...);
                                    buildFrameGenerators(
                                        this: Readonly<Pick<(...), (...)>>,
                                        ...effectOptions: unknown[],
                                    ): EffectFrameGeneratorSet;
                                },
                            >,
                        >,
                    >,
                    | "domElem"
                    | "getEffectDetails"
                    | "getStatus"
                    | "getStyles"
                    | "getTiming",
                >,
            > & Readonly<
                Pick<
                    AnimClip<
                        Readonly<
                            StripDuplicateMethodAutocompletion<
                                {
                                    defaultConfig?: (...) & (...);
                                    howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                    immutableConfig?: (...) & (...);
                                    buildFrameGenerators(
                                        this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>, "computeTween">>,
                                        ...effectOptions: unknown[],
                                    ): EffectFrameGeneratorSet;
                                },
                            >,
                        >,
                        AnimClipConfig,
                    >,
                    "computeTween",
                >,
            >,
        ): { keyframesGenerator_play: () => { backgroundPositionX: string }[] };
    };
}

Index

Properties

~highlight ~un-highlight

Properties

~highlight

"~highlight": {
    defaultConfig: {
        cssClasses: { toAddOnStart: ["webchalk-highlightable"] };
    };
    howOftenBuildGenerators: "on-every-play";
    immutableConfig: { composite: "replace" };
    buildFrameGenerators(
        this: Readonly<
            Pick<
                EmphasisClip<
                    Readonly<
                        StripDuplicateMethodAutocompletion<
                            {
                                defaultConfig?: (...) & (...);
                                howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                immutableConfig?: (...) & (...);
                                buildFrameGenerators(
                                    this: Readonly<Pick<(...), (...)>>,
                                    ...effectOptions: unknown[],
                                ): EffectFrameGeneratorSet;
                            },
                        >,
                    >,
                >,
                "domElem"
                | "getEffectDetails"
                | "getStatus"
                | "getStyles"
                | "getTiming",
            >,
        > & Readonly<
            Pick<
                AnimClip<
                    Readonly<
                        StripDuplicateMethodAutocompletion<
                            {
                                defaultConfig?: (...) & (...);
                                howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                immutableConfig?: (...) & (...);
                                buildFrameGenerators(
                                    this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>, "computeTween">>,
                                    ...effectOptions: unknown[],
                                ): EffectFrameGeneratorSet;
                            },
                        >,
                    >,
                    AnimClipConfig,
                >,
                "computeTween",
            >,
        >,
        color?: string,
    ): {
        keyframesGenerator_play: () => (
            | {
                "--webchalk-highlight-color": string;
                backgroundPositionX?: undefined;
                easing: string;
                offset?: undefined;
            }
            | {
                "--webchalk-highlight-color"?: undefined;
                backgroundPositionX: string;
                easing?: undefined;
                offset: number;
            }
            | {
                "--webchalk-highlight-color": string;
                backgroundPositionX?: undefined;
                easing?: undefined;
                offset?: undefined;
            }
        )[];
        keyframesGenerator_rewind: () => (
            | {
                "--webchalk-highlight-color": string;
                backgroundPositionX?: undefined;
                easing: string;
                offset?: undefined;
            }
            | {
                "--webchalk-highlight-color"?: undefined;
                backgroundPositionX: string;
                easing?: undefined;
                offset: number;
            }
            | {
                "--webchalk-highlight-color": string;
                backgroundPositionX?: undefined;
                easing?: undefined;
                offset?: undefined;
            }
        )[];
    };
} & {
    defaultConfig: {
        cssClasses: { toAddOnStart: ["webchalk-highlightable"] };
    };
    howOftenBuildGenerators: "on-every-play";
    immutableConfig: { composite: "replace" };
    buildFrameGenerators(
        this: Readonly<
            Pick<
                EmphasisClip<
                    Readonly<
                        StripDuplicateMethodAutocompletion<
                            {
                                defaultConfig?: (...) & (...);
                                howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                immutableConfig?: (...) & (...);
                                buildFrameGenerators(
                                    this: Readonly<Pick<(...), (...)>>,
                                    ...effectOptions: unknown[],
                                ): EffectFrameGeneratorSet;
                            },
                        >,
                    >,
                >,
                "domElem"
                | "getEffectDetails"
                | "getStatus"
                | "getStyles"
                | "getTiming",
            >,
        > & Readonly<
            Pick<
                AnimClip<
                    Readonly<
                        StripDuplicateMethodAutocompletion<
                            {
                                defaultConfig?: (...) & (...);
                                howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                immutableConfig?: (...) & (...);
                                buildFrameGenerators(
                                    this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>, "computeTween">>,
                                    ...effectOptions: unknown[],
                                ): EffectFrameGeneratorSet;
                            },
                        >,
                    >,
                    AnimClipConfig,
                >,
                "computeTween",
            >,
        >,
        color?: string,
    ): {
        keyframesGenerator_play: () => (
            | {
                "--webchalk-highlight-color": string;
                backgroundPositionX?: undefined;
                easing: string;
                offset?: undefined;
            }
            | {
                "--webchalk-highlight-color"?: undefined;
                backgroundPositionX: string;
                easing?: undefined;
                offset: number;
            }
            | {
                "--webchalk-highlight-color": string;
                backgroundPositionX?: undefined;
                easing?: undefined;
                offset?: undefined;
            }
        )[];
        keyframesGenerator_rewind: () => (
            | {
                "--webchalk-highlight-color": string;
                backgroundPositionX?: undefined;
                easing: string;
                offset?: undefined;
            }
            | {
                "--webchalk-highlight-color"?: undefined;
                backgroundPositionX: string;
                easing?: undefined;
                offset: number;
            }
            | {
                "--webchalk-highlight-color": string;
                backgroundPositionX?: undefined;
                easing?: undefined;
                offset?: undefined;
            }
        )[];
    };
} & {
    defaultConfig: {
        cssClasses: { toAddOnStart: ["webchalk-highlightable"] };
    };
    howOftenBuildGenerators: "on-every-play";
    immutableConfig: { composite: "replace" };
    buildFrameGenerators(
        this: Readonly<
            Pick<
                EmphasisClip<
                    Readonly<
                        StripDuplicateMethodAutocompletion<
                            {
                                defaultConfig?: (...) & (...);
                                howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                immutableConfig?: (...) & (...);
                                buildFrameGenerators(
                                    this: Readonly<Pick<(...), (...)>>,
                                    ...effectOptions: unknown[],
                                ): EffectFrameGeneratorSet;
                            },
                        >,
                    >,
                >,
                "domElem"
                | "getEffectDetails"
                | "getStatus"
                | "getStyles"
                | "getTiming",
            >,
        > & Readonly<
            Pick<
                AnimClip<
                    Readonly<
                        StripDuplicateMethodAutocompletion<
                            {
                                defaultConfig?: (...) & (...);
                                howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                immutableConfig?: (...) & (...);
                                buildFrameGenerators(
                                    this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>, "computeTween">>,
                                    ...effectOptions: unknown[],
                                ): EffectFrameGeneratorSet;
                            },
                        >,
                    >,
                    AnimClipConfig,
                >,
                "computeTween",
            >,
        >,
        color?: string,
    ): {
        keyframesGenerator_play: () => (
            | {
                "--webchalk-highlight-color": string;
                backgroundPositionX?: undefined;
                easing: string;
                offset?: undefined;
            }
            | {
                "--webchalk-highlight-color"?: undefined;
                backgroundPositionX: string;
                easing?: undefined;
                offset: number;
            }
            | {
                "--webchalk-highlight-color": string;
                backgroundPositionX?: undefined;
                easing?: undefined;
                offset?: undefined;
            }
        )[];
        keyframesGenerator_rewind: () => (
            | {
                "--webchalk-highlight-color": string;
                backgroundPositionX?: undefined;
                easing: string;
                offset?: undefined;
            }
            | {
                "--webchalk-highlight-color"?: undefined;
                backgroundPositionX: string;
                easing?: undefined;
                offset: number;
            }
            | {
                "--webchalk-highlight-color": string;
                backgroundPositionX?: undefined;
                easing?: undefined;
                offset?: undefined;
            }
        )[];
    };
} & {
    defaultConfig: {
        cssClasses: { toAddOnStart: ["webchalk-highlightable"] };
    };
    howOftenBuildGenerators: "on-every-play";
    immutableConfig: { composite: "replace" };
    buildFrameGenerators(
        this: Readonly<
            Pick<
                EmphasisClip<
                    Readonly<
                        StripDuplicateMethodAutocompletion<
                            {
                                defaultConfig?: (...) & (...);
                                howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                immutableConfig?: (...) & (...);
                                buildFrameGenerators(
                                    this: Readonly<Pick<(...), (...)>>,
                                    ...effectOptions: unknown[],
                                ): EffectFrameGeneratorSet;
                            },
                        >,
                    >,
                >,
                "domElem"
                | "getEffectDetails"
                | "getStatus"
                | "getStyles"
                | "getTiming",
            >,
        > & Readonly<
            Pick<
                AnimClip<
                    Readonly<
                        StripDuplicateMethodAutocompletion<
                            {
                                defaultConfig?: (...) & (...);
                                howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                immutableConfig?: (...) & (...);
                                buildFrameGenerators(
                                    this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>, "computeTween">>,
                                    ...effectOptions: unknown[],
                                ): EffectFrameGeneratorSet;
                            },
                        >,
                    >,
                    AnimClipConfig,
                >,
                "computeTween",
            >,
        >,
        color?: string,
    ): {
        keyframesGenerator_play: () => (
            | {
                "--webchalk-highlight-color": string;
                backgroundPositionX?: undefined;
                easing: string;
                offset?: undefined;
            }
            | {
                "--webchalk-highlight-color"?: undefined;
                backgroundPositionX: string;
                easing?: undefined;
                offset: number;
            }
            | {
                "--webchalk-highlight-color": string;
                backgroundPositionX?: undefined;
                easing?: undefined;
                offset?: undefined;
            }
        )[];
        keyframesGenerator_rewind: () => (
            | {
                "--webchalk-highlight-color": string;
                backgroundPositionX?: undefined;
                easing: string;
                offset?: undefined;
            }
            | {
                "--webchalk-highlight-color"?: undefined;
                backgroundPositionX: string;
                easing?: undefined;
                offset: number;
            }
            | {
                "--webchalk-highlight-color": string;
                backgroundPositionX?: undefined;
                easing?: undefined;
                offset?: undefined;
            }
        )[];
    };
} = ...

The element is highlighted in the specified color.

Type Declaration

defaultConfig: { cssClasses: { toAddOnStart: ["webchalk-highlightable"] } }
howOftenBuildGenerators: "on-every-play"
immutableConfig: { composite: "replace" }
buildFrameGenerators: function
- buildFrameGenerators(
      this: Readonly<
          Pick<
              EmphasisClip<
                  Readonly<
                      StripDuplicateMethodAutocompletion<
                          {
                              defaultConfig?: (...) & (...);
                              howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                              immutableConfig?: (...) & (...);
                              buildFrameGenerators(
                                  this: Readonly<Pick<(...), (...)>>,
                                  ...effectOptions: unknown[],
                              ): EffectFrameGeneratorSet;
                          },
                      >,
                  >,
              >,
              "domElem"
              | "getEffectDetails"
              | "getStatus"
              | "getStyles"
              | "getTiming",
          >,
      > & Readonly<
          Pick<
              AnimClip<
                  Readonly<
                      StripDuplicateMethodAutocompletion<
                          {
                              defaultConfig?: (...) & (...);
                              howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                              immutableConfig?: (...) & (...);
                              buildFrameGenerators(
                                  this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>, "computeTween">>,
                                  ...effectOptions: unknown[],
                              ): EffectFrameGeneratorSet;
                          },
                      >,
                  >,
                  AnimClipConfig,
              >,
              "computeTween",
          >,
      >,
      color?: string,
  ): {
      keyframesGenerator_play: () => (
          | {
              "--webchalk-highlight-color": string;
              backgroundPositionX?: undefined;
              easing: string;
              offset?: undefined;
          }
          | {
              "--webchalk-highlight-color"?: undefined;
              backgroundPositionX: string;
              easing?: undefined;
              offset: number;
          }
          | {
              "--webchalk-highlight-color": string;
              backgroundPositionX?: undefined;
              easing?: undefined;
              offset?: undefined;
          }
      )[];
      keyframesGenerator_rewind: () => (
          | {
              "--webchalk-highlight-color": string;
              backgroundPositionX?: undefined;
              easing: string;
              offset?: undefined;
          }
          | {
              "--webchalk-highlight-color"?: undefined;
              backgroundPositionX: string;
              easing?: undefined;
              offset: number;
          }
          | {
              "--webchalk-highlight-color": string;
              backgroundPositionX?: undefined;
              easing?: undefined;
              offset?: undefined;
          }
      )[];
  }
  Parameters
  - this: Readonly<
        Pick<
            EmphasisClip<
                Readonly<
                    StripDuplicateMethodAutocompletion<
                        {
                            defaultConfig?: (...) & (...);
                            howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                            immutableConfig?: (...) & (...);
                            buildFrameGenerators(
                                this: Readonly<Pick<(...), (...)>>,
                                ...effectOptions: unknown[],
                            ): EffectFrameGeneratorSet;
                        },
                    >,
                >,
            >,
            "domElem"
            | "getEffectDetails"
            | "getStatus"
            | "getStyles"
            | "getTiming",
        >,
    > & Readonly<
        Pick<
            AnimClip<
                Readonly<
                    StripDuplicateMethodAutocompletion<
                        {
                            defaultConfig?: (...) & (...);
                            howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                            immutableConfig?: (...) & (...);
                            buildFrameGenerators(
                                this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>, "computeTween">>,
                                ...effectOptions: unknown[],
                            ): EffectFrameGeneratorSet;
                        },
                    >,
                >,
                AnimClipConfig,
            >,
            "computeTween",
        >,
    >
  - color: string = 'default'
    The color to use for the highlight.
  Returns {
      keyframesGenerator_play: () => (
          | {
              "--webchalk-highlight-color": string;
              backgroundPositionX?: undefined;
              easing: string;
              offset?: undefined;
          }
          | {
              "--webchalk-highlight-color"?: undefined;
              backgroundPositionX: string;
              easing?: undefined;
              offset: number;
          }
          | {
              "--webchalk-highlight-color": string;
              backgroundPositionX?: undefined;
              easing?: undefined;
              offset?: undefined;
          }
      )[];
      keyframesGenerator_rewind: () => (
          | {
              "--webchalk-highlight-color": string;
              backgroundPositionX?: undefined;
              easing: string;
              offset?: undefined;
          }
          | {
              "--webchalk-highlight-color"?: undefined;
              backgroundPositionX: string;
              easing?: undefined;
              offset: number;
          }
          | {
              "--webchalk-highlight-color": string;
              backgroundPositionX?: undefined;
              easing?: undefined;
              offset?: undefined;
          }
      )[];
  }
  - Defined in src/2_animationEffects/webchalkPresetEffectBanks.ts:559

defaultConfig: { cssClasses: { toAddOnStart: ["webchalk-highlightable"] } }
howOftenBuildGenerators: "on-every-play"
immutableConfig: { composite: "replace" }
buildFrameGenerators: function
- buildFrameGenerators(
      this: Readonly<
          Pick<
              EmphasisClip<
                  Readonly<
                      StripDuplicateMethodAutocompletion<
                          {
                              defaultConfig?: (...) & (...);
                              howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                              immutableConfig?: (...) & (...);
                              buildFrameGenerators(
                                  this: Readonly<Pick<(...), (...)>>,
                                  ...effectOptions: unknown[],
                              ): EffectFrameGeneratorSet;
                          },
                      >,
                  >,
              >,
              "domElem"
              | "getEffectDetails"
              | "getStatus"
              | "getStyles"
              | "getTiming",
          >,
      > & Readonly<
          Pick<
              AnimClip<
                  Readonly<
                      StripDuplicateMethodAutocompletion<
                          {
                              defaultConfig?: (...) & (...);
                              howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                              immutableConfig?: (...) & (...);
                              buildFrameGenerators(
                                  this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>, "computeTween">>,
                                  ...effectOptions: unknown[],
                              ): EffectFrameGeneratorSet;
                          },
                      >,
                  >,
                  AnimClipConfig,
              >,
              "computeTween",
          >,
      >,
      color?: string,
  ): {
      keyframesGenerator_play: () => (
          | {
              "--webchalk-highlight-color": string;
              backgroundPositionX?: undefined;
              easing: string;
              offset?: undefined;
          }
          | {
              "--webchalk-highlight-color"?: undefined;
              backgroundPositionX: string;
              easing?: undefined;
              offset: number;
          }
          | {
              "--webchalk-highlight-color": string;
              backgroundPositionX?: undefined;
              easing?: undefined;
              offset?: undefined;
          }
      )[];
      keyframesGenerator_rewind: () => (
          | {
              "--webchalk-highlight-color": string;
              backgroundPositionX?: undefined;
              easing: string;
              offset?: undefined;
          }
          | {
              "--webchalk-highlight-color"?: undefined;
              backgroundPositionX: string;
              easing?: undefined;
              offset: number;
          }
          | {
              "--webchalk-highlight-color": string;
              backgroundPositionX?: undefined;
              easing?: undefined;
              offset?: undefined;
          }
      )[];
  }
  Parameters
  - this: Readonly<
        Pick<
            EmphasisClip<
                Readonly<
                    StripDuplicateMethodAutocompletion<
                        {
                            defaultConfig?: (...) & (...);
                            howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                            immutableConfig?: (...) & (...);
                            buildFrameGenerators(
                                this: Readonly<Pick<(...), (...)>>,
                                ...effectOptions: unknown[],
                            ): EffectFrameGeneratorSet;
                        },
                    >,
                >,
            >,
            "domElem"
            | "getEffectDetails"
            | "getStatus"
            | "getStyles"
            | "getTiming",
        >,
    > & Readonly<
        Pick<
            AnimClip<
                Readonly<
                    StripDuplicateMethodAutocompletion<
                        {
                            defaultConfig?: (...) & (...);
                            howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                            immutableConfig?: (...) & (...);
                            buildFrameGenerators(
                                this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>, "computeTween">>,
                                ...effectOptions: unknown[],
                            ): EffectFrameGeneratorSet;
                        },
                    >,
                >,
                AnimClipConfig,
            >,
            "computeTween",
        >,
    >
  - color: string = 'default'
    The color to use for the highlight.
  Returns {
      keyframesGenerator_play: () => (
          | {
              "--webchalk-highlight-color": string;
              backgroundPositionX?: undefined;
              easing: string;
              offset?: undefined;
          }
          | {
              "--webchalk-highlight-color"?: undefined;
              backgroundPositionX: string;
              easing?: undefined;
              offset: number;
          }
          | {
              "--webchalk-highlight-color": string;
              backgroundPositionX?: undefined;
              easing?: undefined;
              offset?: undefined;
          }
      )[];
      keyframesGenerator_rewind: () => (
          | {
              "--webchalk-highlight-color": string;
              backgroundPositionX?: undefined;
              easing: string;
              offset?: undefined;
          }
          | {
              "--webchalk-highlight-color"?: undefined;
              backgroundPositionX: string;
              easing?: undefined;
              offset: number;
          }
          | {
              "--webchalk-highlight-color": string;
              backgroundPositionX?: undefined;
              easing?: undefined;
              offset?: undefined;
          }
      )[];
  }
  - Defined in src/2_animationEffects/webchalkPresetEffectBanks.ts:559

defaultConfig: { cssClasses: { toAddOnStart: ["webchalk-highlightable"] } }
howOftenBuildGenerators: "on-every-play"
immutableConfig: { composite: "replace" }
buildFrameGenerators: function
- buildFrameGenerators(
      this: Readonly<
          Pick<
              EmphasisClip<
                  Readonly<
                      StripDuplicateMethodAutocompletion<
                          {
                              defaultConfig?: (...) & (...);
                              howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                              immutableConfig?: (...) & (...);
                              buildFrameGenerators(
                                  this: Readonly<Pick<(...), (...)>>,
                                  ...effectOptions: unknown[],
                              ): EffectFrameGeneratorSet;
                          },
                      >,
                  >,
              >,
              "domElem"
              | "getEffectDetails"
              | "getStatus"
              | "getStyles"
              | "getTiming",
          >,
      > & Readonly<
          Pick<
              AnimClip<
                  Readonly<
                      StripDuplicateMethodAutocompletion<
                          {
                              defaultConfig?: (...) & (...);
                              howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                              immutableConfig?: (...) & (...);
                              buildFrameGenerators(
                                  this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>, "computeTween">>,
                                  ...effectOptions: unknown[],
                              ): EffectFrameGeneratorSet;
                          },
                      >,
                  >,
                  AnimClipConfig,
              >,
              "computeTween",
          >,
      >,
      color?: string,
  ): {
      keyframesGenerator_play: () => (
          | {
              "--webchalk-highlight-color": string;
              backgroundPositionX?: undefined;
              easing: string;
              offset?: undefined;
          }
          | {
              "--webchalk-highlight-color"?: undefined;
              backgroundPositionX: string;
              easing?: undefined;
              offset: number;
          }
          | {
              "--webchalk-highlight-color": string;
              backgroundPositionX?: undefined;
              easing?: undefined;
              offset?: undefined;
          }
      )[];
      keyframesGenerator_rewind: () => (
          | {
              "--webchalk-highlight-color": string;
              backgroundPositionX?: undefined;
              easing: string;
              offset?: undefined;
          }
          | {
              "--webchalk-highlight-color"?: undefined;
              backgroundPositionX: string;
              easing?: undefined;
              offset: number;
          }
          | {
              "--webchalk-highlight-color": string;
              backgroundPositionX?: undefined;
              easing?: undefined;
              offset?: undefined;
          }
      )[];
  }
  Parameters
  - this: Readonly<
        Pick<
            EmphasisClip<
                Readonly<
                    StripDuplicateMethodAutocompletion<
                        {
                            defaultConfig?: (...) & (...);
                            howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                            immutableConfig?: (...) & (...);
                            buildFrameGenerators(
                                this: Readonly<Pick<(...), (...)>>,
                                ...effectOptions: unknown[],
                            ): EffectFrameGeneratorSet;
                        },
                    >,
                >,
            >,
            "domElem"
            | "getEffectDetails"
            | "getStatus"
            | "getStyles"
            | "getTiming",
        >,
    > & Readonly<
        Pick<
            AnimClip<
                Readonly<
                    StripDuplicateMethodAutocompletion<
                        {
                            defaultConfig?: (...) & (...);
                            howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                            immutableConfig?: (...) & (...);
                            buildFrameGenerators(
                                this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>, "computeTween">>,
                                ...effectOptions: unknown[],
                            ): EffectFrameGeneratorSet;
                        },
                    >,
                >,
                AnimClipConfig,
            >,
            "computeTween",
        >,
    >
  - color: string = 'default'
    The color to use for the highlight.
  Returns {
      keyframesGenerator_play: () => (
          | {
              "--webchalk-highlight-color": string;
              backgroundPositionX?: undefined;
              easing: string;
              offset?: undefined;
          }
          | {
              "--webchalk-highlight-color"?: undefined;
              backgroundPositionX: string;
              easing?: undefined;
              offset: number;
          }
          | {
              "--webchalk-highlight-color": string;
              backgroundPositionX?: undefined;
              easing?: undefined;
              offset?: undefined;
          }
      )[];
      keyframesGenerator_rewind: () => (
          | {
              "--webchalk-highlight-color": string;
              backgroundPositionX?: undefined;
              easing: string;
              offset?: undefined;
          }
          | {
              "--webchalk-highlight-color"?: undefined;
              backgroundPositionX: string;
              easing?: undefined;
              offset: number;
          }
          | {
              "--webchalk-highlight-color": string;
              backgroundPositionX?: undefined;
              easing?: undefined;
              offset?: undefined;
          }
      )[];
  }
  - Defined in src/2_animationEffects/webchalkPresetEffectBanks.ts:559

defaultConfig: { cssClasses: { toAddOnStart: ["webchalk-highlightable"] } }
howOftenBuildGenerators: "on-every-play"
immutableConfig: { composite: "replace" }
buildFrameGenerators: function
- buildFrameGenerators(
      this: Readonly<
          Pick<
              EmphasisClip<
                  Readonly<
                      StripDuplicateMethodAutocompletion<
                          {
                              defaultConfig?: (...) & (...);
                              howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                              immutableConfig?: (...) & (...);
                              buildFrameGenerators(
                                  this: Readonly<Pick<(...), (...)>>,
                                  ...effectOptions: unknown[],
                              ): EffectFrameGeneratorSet;
                          },
                      >,
                  >,
              >,
              "domElem"
              | "getEffectDetails"
              | "getStatus"
              | "getStyles"
              | "getTiming",
          >,
      > & Readonly<
          Pick<
              AnimClip<
                  Readonly<
                      StripDuplicateMethodAutocompletion<
                          {
                              defaultConfig?: (...) & (...);
                              howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                              immutableConfig?: (...) & (...);
                              buildFrameGenerators(
                                  this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>, "computeTween">>,
                                  ...effectOptions: unknown[],
                              ): EffectFrameGeneratorSet;
                          },
                      >,
                  >,
                  AnimClipConfig,
              >,
              "computeTween",
          >,
      >,
      color?: string,
  ): {
      keyframesGenerator_play: () => (
          | {
              "--webchalk-highlight-color": string;
              backgroundPositionX?: undefined;
              easing: string;
              offset?: undefined;
          }
          | {
              "--webchalk-highlight-color"?: undefined;
              backgroundPositionX: string;
              easing?: undefined;
              offset: number;
          }
          | {
              "--webchalk-highlight-color": string;
              backgroundPositionX?: undefined;
              easing?: undefined;
              offset?: undefined;
          }
      )[];
      keyframesGenerator_rewind: () => (
          | {
              "--webchalk-highlight-color": string;
              backgroundPositionX?: undefined;
              easing: string;
              offset?: undefined;
          }
          | {
              "--webchalk-highlight-color"?: undefined;
              backgroundPositionX: string;
              easing?: undefined;
              offset: number;
          }
          | {
              "--webchalk-highlight-color": string;
              backgroundPositionX?: undefined;
              easing?: undefined;
              offset?: undefined;
          }
      )[];
  }
  Parameters
  - this: Readonly<
        Pick<
            EmphasisClip<
                Readonly<
                    StripDuplicateMethodAutocompletion<
                        {
                            defaultConfig?: (...) & (...);
                            howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                            immutableConfig?: (...) & (...);
                            buildFrameGenerators(
                                this: Readonly<Pick<(...), (...)>>,
                                ...effectOptions: unknown[],
                            ): EffectFrameGeneratorSet;
                        },
                    >,
                >,
            >,
            "domElem"
            | "getEffectDetails"
            | "getStatus"
            | "getStyles"
            | "getTiming",
        >,
    > & Readonly<
        Pick<
            AnimClip<
                Readonly<
                    StripDuplicateMethodAutocompletion<
                        {
                            defaultConfig?: (...) & (...);
                            howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                            immutableConfig?: (...) & (...);
                            buildFrameGenerators(
                                this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>, "computeTween">>,
                                ...effectOptions: unknown[],
                            ): EffectFrameGeneratorSet;
                        },
                    >,
                >,
                AnimClipConfig,
            >,
            "computeTween",
        >,
    >
  - color: string = 'default'
    The color to use for the highlight.
  Returns {
      keyframesGenerator_play: () => (
          | {
              "--webchalk-highlight-color": string;
              backgroundPositionX?: undefined;
              easing: string;
              offset?: undefined;
          }
          | {
              "--webchalk-highlight-color"?: undefined;
              backgroundPositionX: string;
              easing?: undefined;
              offset: number;
          }
          | {
              "--webchalk-highlight-color": string;
              backgroundPositionX?: undefined;
              easing?: undefined;
              offset?: undefined;
          }
      )[];
      keyframesGenerator_rewind: () => (
          | {
              "--webchalk-highlight-color": string;
              backgroundPositionX?: undefined;
              easing: string;
              offset?: undefined;
          }
          | {
              "--webchalk-highlight-color"?: undefined;
              backgroundPositionX: string;
              easing?: undefined;
              offset: number;
          }
          | {
              "--webchalk-highlight-color": string;
              backgroundPositionX?: undefined;
              easing?: undefined;
              offset?: undefined;
          }
      )[];
  }
  - Defined in src/2_animationEffects/webchalkPresetEffectBanks.ts:559

~un-highlight

"~un-highlight": {
    defaultConfig: {
        cssClasses: { toRemoveOnFinish: ["webchalk-highlightable"] };
    };
    howOftenBuildGenerators: "on-every-play";
    immutableConfig: { composite: "replace" };
    buildFrameGenerators(
        this: Readonly<
            Pick<
                EmphasisClip<
                    Readonly<
                        StripDuplicateMethodAutocompletion<
                            {
                                defaultConfig?: (...) & (...);
                                howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                immutableConfig?: (...) & (...);
                                buildFrameGenerators(
                                    this: Readonly<Pick<(...), (...)>>,
                                    ...effectOptions: unknown[],
                                ): EffectFrameGeneratorSet;
                            },
                        >,
                    >,
                >,
                "domElem"
                | "getEffectDetails"
                | "getStatus"
                | "getStyles"
                | "getTiming",
            >,
        > & Readonly<
            Pick<
                AnimClip<
                    Readonly<
                        StripDuplicateMethodAutocompletion<
                            {
                                defaultConfig?: (...) & (...);
                                howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                immutableConfig?: (...) & (...);
                                buildFrameGenerators(
                                    this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>, "computeTween">>,
                                    ...effectOptions: unknown[],
                                ): EffectFrameGeneratorSet;
                            },
                        >,
                    >,
                    AnimClipConfig,
                >,
                "computeTween",
            >,
        >,
    ): { keyframesGenerator_play: () => { backgroundPositionX: string }[] };
} & {
    defaultConfig: {
        cssClasses: { toRemoveOnFinish: ["webchalk-highlightable"] };
    };
    howOftenBuildGenerators: "on-every-play";
    immutableConfig: { composite: "replace" };
    buildFrameGenerators(
        this: Readonly<
            Pick<
                EmphasisClip<
                    Readonly<
                        StripDuplicateMethodAutocompletion<
                            {
                                defaultConfig?: (...) & (...);
                                howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                immutableConfig?: (...) & (...);
                                buildFrameGenerators(
                                    this: Readonly<Pick<(...), (...)>>,
                                    ...effectOptions: unknown[],
                                ): EffectFrameGeneratorSet;
                            },
                        >,
                    >,
                >,
                "domElem"
                | "getEffectDetails"
                | "getStatus"
                | "getStyles"
                | "getTiming",
            >,
        > & Readonly<
            Pick<
                AnimClip<
                    Readonly<
                        StripDuplicateMethodAutocompletion<
                            {
                                defaultConfig?: (...) & (...);
                                howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                immutableConfig?: (...) & (...);
                                buildFrameGenerators(
                                    this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>, "computeTween">>,
                                    ...effectOptions: unknown[],
                                ): EffectFrameGeneratorSet;
                            },
                        >,
                    >,
                    AnimClipConfig,
                >,
                "computeTween",
            >,
        >,
    ): { keyframesGenerator_play: () => { backgroundPositionX: string }[] };
} & {
    defaultConfig: {
        cssClasses: { toRemoveOnFinish: ["webchalk-highlightable"] };
    };
    howOftenBuildGenerators: "on-every-play";
    immutableConfig: { composite: "replace" };
    buildFrameGenerators(
        this: Readonly<
            Pick<
                EmphasisClip<
                    Readonly<
                        StripDuplicateMethodAutocompletion<
                            {
                                defaultConfig?: (...) & (...);
                                howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                immutableConfig?: (...) & (...);
                                buildFrameGenerators(
                                    this: Readonly<Pick<(...), (...)>>,
                                    ...effectOptions: unknown[],
                                ): EffectFrameGeneratorSet;
                            },
                        >,
                    >,
                >,
                "domElem"
                | "getEffectDetails"
                | "getStatus"
                | "getStyles"
                | "getTiming",
            >,
        > & Readonly<
            Pick<
                AnimClip<
                    Readonly<
                        StripDuplicateMethodAutocompletion<
                            {
                                defaultConfig?: (...) & (...);
                                howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                immutableConfig?: (...) & (...);
                                buildFrameGenerators(
                                    this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>, "computeTween">>,
                                    ...effectOptions: unknown[],
                                ): EffectFrameGeneratorSet;
                            },
                        >,
                    >,
                    AnimClipConfig,
                >,
                "computeTween",
            >,
        >,
    ): { keyframesGenerator_play: () => { backgroundPositionX: string }[] };
} & {
    defaultConfig: {
        cssClasses: { toRemoveOnFinish: ["webchalk-highlightable"] };
    };
    howOftenBuildGenerators: "on-every-play";
    immutableConfig: { composite: "replace" };
    buildFrameGenerators(
        this: Readonly<
            Pick<
                EmphasisClip<
                    Readonly<
                        StripDuplicateMethodAutocompletion<
                            {
                                defaultConfig?: (...) & (...);
                                howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                immutableConfig?: (...) & (...);
                                buildFrameGenerators(
                                    this: Readonly<Pick<(...), (...)>>,
                                    ...effectOptions: unknown[],
                                ): EffectFrameGeneratorSet;
                            },
                        >,
                    >,
                >,
                "domElem"
                | "getEffectDetails"
                | "getStatus"
                | "getStyles"
                | "getTiming",
            >,
        > & Readonly<
            Pick<
                AnimClip<
                    Readonly<
                        StripDuplicateMethodAutocompletion<
                            {
                                defaultConfig?: (...) & (...);
                                howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                immutableConfig?: (...) & (...);
                                buildFrameGenerators(
                                    this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>, "computeTween">>,
                                    ...effectOptions: unknown[],
                                ): EffectFrameGeneratorSet;
                            },
                        >,
                    >,
                    AnimClipConfig,
                >,
                "computeTween",
            >,
        >,
    ): { keyframesGenerator_play: () => { backgroundPositionX: string }[] };
} = ...

The element is unhighlighted.

Type Declaration

defaultConfig: { cssClasses: { toRemoveOnFinish: ["webchalk-highlightable"] } }
howOftenBuildGenerators: "on-every-play"
immutableConfig: { composite: "replace" }
buildFrameGenerators: function
- buildFrameGenerators(
      this: Readonly<
          Pick<
              EmphasisClip<
                  Readonly<
                      StripDuplicateMethodAutocompletion<
                          {
                              defaultConfig?: (...) & (...);
                              howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                              immutableConfig?: (...) & (...);
                              buildFrameGenerators(
                                  this: Readonly<Pick<(...), (...)>>,
                                  ...effectOptions: unknown[],
                              ): EffectFrameGeneratorSet;
                          },
                      >,
                  >,
              >,
              "domElem"
              | "getEffectDetails"
              | "getStatus"
              | "getStyles"
              | "getTiming",
          >,
      > & Readonly<
          Pick<
              AnimClip<
                  Readonly<
                      StripDuplicateMethodAutocompletion<
                          {
                              defaultConfig?: (...) & (...);
                              howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                              immutableConfig?: (...) & (...);
                              buildFrameGenerators(
                                  this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>, "computeTween">>,
                                  ...effectOptions: unknown[],
                              ): EffectFrameGeneratorSet;
                          },
                      >,
                  >,
                  AnimClipConfig,
              >,
              "computeTween",
          >,
      >,
  ): { keyframesGenerator_play: () => { backgroundPositionX: string }[] }
  Parameters
  - this: Readonly<
        Pick<
            EmphasisClip<
                Readonly<
                    StripDuplicateMethodAutocompletion<
                        {
                            defaultConfig?: (...) & (...);
                            howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                            immutableConfig?: (...) & (...);
                            buildFrameGenerators(
                                this: Readonly<Pick<(...), (...)>>,
                                ...effectOptions: unknown[],
                            ): EffectFrameGeneratorSet;
                        },
                    >,
                >,
            >,
            "domElem"
            | "getEffectDetails"
            | "getStatus"
            | "getStyles"
            | "getTiming",
        >,
    > & Readonly<
        Pick<
            AnimClip<
                Readonly<
                    StripDuplicateMethodAutocompletion<
                        {
                            defaultConfig?: (...) & (...);
                            howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                            immutableConfig?: (...) & (...);
                            buildFrameGenerators(
                                this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>, "computeTween">>,
                                ...effectOptions: unknown[],
                            ): EffectFrameGeneratorSet;
                        },
                    >,
                >,
                AnimClipConfig,
            >,
            "computeTween",
        >,
    >
  Returns { keyframesGenerator_play: () => { backgroundPositionX: string }[] }
  - Defined in src/2_animationEffects/webchalkPresetEffectBanks.ts:613

defaultConfig: { cssClasses: { toRemoveOnFinish: ["webchalk-highlightable"] } }
howOftenBuildGenerators: "on-every-play"
immutableConfig: { composite: "replace" }
buildFrameGenerators: function
- buildFrameGenerators(
      this: Readonly<
          Pick<
              EmphasisClip<
                  Readonly<
                      StripDuplicateMethodAutocompletion<
                          {
                              defaultConfig?: (...) & (...);
                              howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                              immutableConfig?: (...) & (...);
                              buildFrameGenerators(
                                  this: Readonly<Pick<(...), (...)>>,
                                  ...effectOptions: unknown[],
                              ): EffectFrameGeneratorSet;
                          },
                      >,
                  >,
              >,
              "domElem"
              | "getEffectDetails"
              | "getStatus"
              | "getStyles"
              | "getTiming",
          >,
      > & Readonly<
          Pick<
              AnimClip<
                  Readonly<
                      StripDuplicateMethodAutocompletion<
                          {
                              defaultConfig?: (...) & (...);
                              howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                              immutableConfig?: (...) & (...);
                              buildFrameGenerators(
                                  this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>, "computeTween">>,
                                  ...effectOptions: unknown[],
                              ): EffectFrameGeneratorSet;
                          },
                      >,
                  >,
                  AnimClipConfig,
              >,
              "computeTween",
          >,
      >,
  ): { keyframesGenerator_play: () => { backgroundPositionX: string }[] }
  Parameters
  - this: Readonly<
        Pick<
            EmphasisClip<
                Readonly<
                    StripDuplicateMethodAutocompletion<
                        {
                            defaultConfig?: (...) & (...);
                            howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                            immutableConfig?: (...) & (...);
                            buildFrameGenerators(
                                this: Readonly<Pick<(...), (...)>>,
                                ...effectOptions: unknown[],
                            ): EffectFrameGeneratorSet;
                        },
                    >,
                >,
            >,
            "domElem"
            | "getEffectDetails"
            | "getStatus"
            | "getStyles"
            | "getTiming",
        >,
    > & Readonly<
        Pick<
            AnimClip<
                Readonly<
                    StripDuplicateMethodAutocompletion<
                        {
                            defaultConfig?: (...) & (...);
                            howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                            immutableConfig?: (...) & (...);
                            buildFrameGenerators(
                                this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>, "computeTween">>,
                                ...effectOptions: unknown[],
                            ): EffectFrameGeneratorSet;
                        },
                    >,
                >,
                AnimClipConfig,
            >,
            "computeTween",
        >,
    >
  Returns { keyframesGenerator_play: () => { backgroundPositionX: string }[] }
  - Defined in src/2_animationEffects/webchalkPresetEffectBanks.ts:613

defaultConfig: { cssClasses: { toRemoveOnFinish: ["webchalk-highlightable"] } }
howOftenBuildGenerators: "on-every-play"
immutableConfig: { composite: "replace" }
buildFrameGenerators: function
- buildFrameGenerators(
      this: Readonly<
          Pick<
              EmphasisClip<
                  Readonly<
                      StripDuplicateMethodAutocompletion<
                          {
                              defaultConfig?: (...) & (...);
                              howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                              immutableConfig?: (...) & (...);
                              buildFrameGenerators(
                                  this: Readonly<Pick<(...), (...)>>,
                                  ...effectOptions: unknown[],
                              ): EffectFrameGeneratorSet;
                          },
                      >,
                  >,
              >,
              "domElem"
              | "getEffectDetails"
              | "getStatus"
              | "getStyles"
              | "getTiming",
          >,
      > & Readonly<
          Pick<
              AnimClip<
                  Readonly<
                      StripDuplicateMethodAutocompletion<
                          {
                              defaultConfig?: (...) & (...);
                              howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                              immutableConfig?: (...) & (...);
                              buildFrameGenerators(
                                  this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>, "computeTween">>,
                                  ...effectOptions: unknown[],
                              ): EffectFrameGeneratorSet;
                          },
                      >,
                  >,
                  AnimClipConfig,
              >,
              "computeTween",
          >,
      >,
  ): { keyframesGenerator_play: () => { backgroundPositionX: string }[] }
  Parameters
  - this: Readonly<
        Pick<
            EmphasisClip<
                Readonly<
                    StripDuplicateMethodAutocompletion<
                        {
                            defaultConfig?: (...) & (...);
                            howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                            immutableConfig?: (...) & (...);
                            buildFrameGenerators(
                                this: Readonly<Pick<(...), (...)>>,
                                ...effectOptions: unknown[],
                            ): EffectFrameGeneratorSet;
                        },
                    >,
                >,
            >,
            "domElem"
            | "getEffectDetails"
            | "getStatus"
            | "getStyles"
            | "getTiming",
        >,
    > & Readonly<
        Pick<
            AnimClip<
                Readonly<
                    StripDuplicateMethodAutocompletion<
                        {
                            defaultConfig?: (...) & (...);
                            howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                            immutableConfig?: (...) & (...);
                            buildFrameGenerators(
                                this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>, "computeTween">>,
                                ...effectOptions: unknown[],
                            ): EffectFrameGeneratorSet;
                        },
                    >,
                >,
                AnimClipConfig,
            >,
            "computeTween",
        >,
    >
  Returns { keyframesGenerator_play: () => { backgroundPositionX: string }[] }
  - Defined in src/2_animationEffects/webchalkPresetEffectBanks.ts:613

defaultConfig: { cssClasses: { toRemoveOnFinish: ["webchalk-highlightable"] } }
howOftenBuildGenerators: "on-every-play"
immutableConfig: { composite: "replace" }
buildFrameGenerators: function
- buildFrameGenerators(
      this: Readonly<
          Pick<
              EmphasisClip<
                  Readonly<
                      StripDuplicateMethodAutocompletion<
                          {
                              defaultConfig?: (...) & (...);
                              howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                              immutableConfig?: (...) & (...);
                              buildFrameGenerators(
                                  this: Readonly<Pick<(...), (...)>>,
                                  ...effectOptions: unknown[],
                              ): EffectFrameGeneratorSet;
                          },
                      >,
                  >,
              >,
              "domElem"
              | "getEffectDetails"
              | "getStatus"
              | "getStyles"
              | "getTiming",
          >,
      > & Readonly<
          Pick<
              AnimClip<
                  Readonly<
                      StripDuplicateMethodAutocompletion<
                          {
                              defaultConfig?: (...) & (...);
                              howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                              immutableConfig?: (...) & (...);
                              buildFrameGenerators(
                                  this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>, "computeTween">>,
                                  ...effectOptions: unknown[],
                              ): EffectFrameGeneratorSet;
                          },
                      >,
                  >,
                  AnimClipConfig,
              >,
              "computeTween",
          >,
      >,
  ): { keyframesGenerator_play: () => { backgroundPositionX: string }[] }
  Parameters
  - this: Readonly<
        Pick<
            EmphasisClip<
                Readonly<
                    StripDuplicateMethodAutocompletion<
                        {
                            defaultConfig?: (...) & (...);
                            howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                            immutableConfig?: (...) & (...);
                            buildFrameGenerators(
                                this: Readonly<Pick<(...), (...)>>,
                                ...effectOptions: unknown[],
                            ): EffectFrameGeneratorSet;
                        },
                    >,
                >,
            >,
            "domElem"
            | "getEffectDetails"
            | "getStatus"
            | "getStyles"
            | "getTiming",
        >,
    > & Readonly<
        Pick<
            AnimClip<
                Readonly<
                    StripDuplicateMethodAutocompletion<
                        {
                            defaultConfig?: (...) & (...);
                            howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                            immutableConfig?: (...) & (...);
                            buildFrameGenerators(
                                this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>, "computeTween">>,
                                ...effectOptions: unknown[],
                            ): EffectFrameGeneratorSet;
                        },
                    >,
                >,
                AnimClipConfig,
            >,
            "computeTween",
        >,
    >
  Returns { keyframesGenerator_play: () => { backgroundPositionX: string }[] }
  - Defined in src/2_animationEffects/webchalkPresetEffectBanks.ts:613

Interface WebchalkPresetEmphasisEffects

Index

Properties

Properties

~highlight

Type Declaration

defaultConfig: { cssClasses: { toAddOnStart: ["webchalk-highlightable"] } }

howOftenBuildGenerators: "on-every-play"

immutableConfig: { composite: "replace" }

buildFrameGenerators: function

Parameters

defaultConfig: { cssClasses: { toAddOnStart: ["webchalk-highlightable"] } }

howOftenBuildGenerators: "on-every-play"

immutableConfig: { composite: "replace" }

buildFrameGenerators: function

Parameters

defaultConfig: { cssClasses: { toAddOnStart: ["webchalk-highlightable"] } }

howOftenBuildGenerators: "on-every-play"

immutableConfig: { composite: "replace" }

buildFrameGenerators: function

Parameters

defaultConfig: { cssClasses: { toAddOnStart: ["webchalk-highlightable"] } }

howOftenBuildGenerators: "on-every-play"

immutableConfig: { composite: "replace" }

buildFrameGenerators: function

Parameters

~un-highlight

Type Declaration

defaultConfig: { cssClasses: { toRemoveOnFinish: ["webchalk-highlightable"] } }

howOftenBuildGenerators: "on-every-play"

immutableConfig: { composite: "replace" }

buildFrameGenerators: function

Parameters

Returns { keyframesGenerator_play: () => { backgroundPositionX: string }[] }

defaultConfig: { cssClasses: { toRemoveOnFinish: ["webchalk-highlightable"] } }

howOftenBuildGenerators: "on-every-play"

immutableConfig: { composite: "replace" }

buildFrameGenerators: function

Parameters

Returns { keyframesGenerator_play: () => { backgroundPositionX: string }[] }

defaultConfig: { cssClasses: { toRemoveOnFinish: ["webchalk-highlightable"] } }

howOftenBuildGenerators: "on-every-play"

immutableConfig: { composite: "replace" }

buildFrameGenerators: function

Parameters

Returns { keyframesGenerator_play: () => { backgroundPositionX: string }[] }

defaultConfig: { cssClasses: { toRemoveOnFinish: ["webchalk-highlightable"] } }

howOftenBuildGenerators: "on-every-play"

immutableConfig: { composite: "replace" }

buildFrameGenerators: function

Parameters

Returns { keyframesGenerator_play: () => { backgroundPositionX: string }[] }

Settings

On This Page