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

interface LibraryPresetEmphasisEffects {
    ~highlight: {
        defaultConfig: {
            cssClasses: {
                toAddOnStart: ["wbmtr-highlightable"];
            };
        };
        immutableConfig: {};
        generateKeyframeGenerators(color?: string): {
            backwardGenerator: (() => ({
                --wbmtr-highlight-color: string;
                backgroundPositionX?: undefined;
                easing: string;
                offset?: undefined;
            } | {
                --wbmtr-highlight-color?: undefined;
                backgroundPositionX: string;
                easing?: undefined;
                offset: number;
            } | {
                --wbmtr-highlight-color: string;
                backgroundPositionX?: undefined;
                easing?: undefined;
                offset?: undefined;
            })[]);
            forwardGenerator: (() => ({
                --wbmtr-highlight-color: string;
                backgroundPositionX?: undefined;
                easing: string;
                offset?: undefined;
            } | {
                --wbmtr-highlight-color?: undefined;
                backgroundPositionX: string;
                easing?: undefined;
                offset: number;
            } | {
                --wbmtr-highlight-color: string;
                backgroundPositionX?: undefined;
                easing?: undefined;
                offset?: undefined;
            })[]);
        };
    };
    ~un-highlight: {
        defaultConfig: {
            cssClasses: {
                toRemoveOnFinish: ["wbmtr-highlightable"];
            };
        };
        immutableConfig: {};
        generateKeyframes(): {
            forwardFrames: [{
                backgroundPositionX: "0%";
            }, {
                backgroundPositionX: "100%";
            }];
        };
    };
}

Properties

~highlight: {
    defaultConfig: {
        cssClasses: {
            toAddOnStart: ["wbmtr-highlightable"];
        };
    };
    immutableConfig: {};
    generateKeyframeGenerators(color?: string): {
        backwardGenerator: (() => ({
            --wbmtr-highlight-color: string;
            backgroundPositionX?: undefined;
            easing: string;
            offset?: undefined;
        } | {
            --wbmtr-highlight-color?: undefined;
            backgroundPositionX: string;
            easing?: undefined;
            offset: number;
        } | {
            --wbmtr-highlight-color: string;
            backgroundPositionX?: undefined;
            easing?: undefined;
            offset?: undefined;
        })[]);
        forwardGenerator: (() => ({
            --wbmtr-highlight-color: string;
            backgroundPositionX?: undefined;
            easing: string;
            offset?: undefined;
        } | {
            --wbmtr-highlight-color?: undefined;
            backgroundPositionX: string;
            easing?: undefined;
            offset: number;
        } | {
            --wbmtr-highlight-color: string;
            backgroundPositionX?: undefined;
            easing?: undefined;
            offset?: undefined;
        })[]);
    };
} = ...

Element is highlighted in the specified color.

Type declaration

  • defaultConfig: {
        cssClasses: {
            toAddOnStart: ["wbmtr-highlightable"];
        };
    }
    • ReadonlycssClasses: {
          toAddOnStart: ["wbmtr-highlightable"];
      }
      • ReadonlytoAddOnStart: ["wbmtr-highlightable"]
  • immutableConfig: {}
    • generateKeyframeGenerators:function
      • Parameters

        • color: string = 'default'

          color to use for the highlight

        Returns {
            backwardGenerator: (() => ({
                --wbmtr-highlight-color: string;
                backgroundPositionX?: undefined;
                easing: string;
                offset?: undefined;
            } | {
                --wbmtr-highlight-color?: undefined;
                backgroundPositionX: string;
                easing?: undefined;
                offset: number;
            } | {
                --wbmtr-highlight-color: string;
                backgroundPositionX?: undefined;
                easing?: undefined;
                offset?: undefined;
            })[]);
            forwardGenerator: (() => ({
                --wbmtr-highlight-color: string;
                backgroundPositionX?: undefined;
                easing: string;
                offset?: undefined;
            } | {
                --wbmtr-highlight-color?: undefined;
                backgroundPositionX: string;
                easing?: undefined;
                offset: number;
            } | {
                --wbmtr-highlight-color: string;
                backgroundPositionX?: undefined;
                easing?: undefined;
                offset?: undefined;
            })[]);
        }

        • backwardGenerator: (() => ({
              --wbmtr-highlight-color: string;
              backgroundPositionX?: undefined;
              easing: string;
              offset?: undefined;
          } | {
              --wbmtr-highlight-color?: undefined;
              backgroundPositionX: string;
              easing?: undefined;
              offset: number;
          } | {
              --wbmtr-highlight-color: string;
              backgroundPositionX?: undefined;
              easing?: undefined;
              offset?: undefined;
          })[])
            • (): ({
                  --wbmtr-highlight-color: string;
                  backgroundPositionX?: undefined;
                  easing: string;
                  offset?: undefined;
              } | {
                  --wbmtr-highlight-color?: undefined;
                  backgroundPositionX: string;
                  easing?: undefined;
                  offset: number;
              } | {
                  --wbmtr-highlight-color: string;
                  backgroundPositionX?: undefined;
                  easing?: undefined;
                  offset?: undefined;
              })[]
            • Returns ({
                  --wbmtr-highlight-color: string;
                  backgroundPositionX?: undefined;
                  easing: string;
                  offset?: undefined;
              } | {
                  --wbmtr-highlight-color?: undefined;
                  backgroundPositionX: string;
                  easing?: undefined;
                  offset: number;
              } | {
                  --wbmtr-highlight-color: string;
                  backgroundPositionX?: undefined;
                  easing?: undefined;
                  offset?: undefined;
              })[]

        • forwardGenerator: (() => ({
              --wbmtr-highlight-color: string;
              backgroundPositionX?: undefined;
              easing: string;
              offset?: undefined;
          } | {
              --wbmtr-highlight-color?: undefined;
              backgroundPositionX: string;
              easing?: undefined;
              offset: number;
          } | {
              --wbmtr-highlight-color: string;
              backgroundPositionX?: undefined;
              easing?: undefined;
              offset?: undefined;
          })[])
            • (): ({
                  --wbmtr-highlight-color: string;
                  backgroundPositionX?: undefined;
                  easing: string;
                  offset?: undefined;
              } | {
                  --wbmtr-highlight-color?: undefined;
                  backgroundPositionX: string;
                  easing?: undefined;
                  offset: number;
              } | {
                  --wbmtr-highlight-color: string;
                  backgroundPositionX?: undefined;
                  easing?: undefined;
                  offset?: undefined;
              })[]
            • Returns ({
                  --wbmtr-highlight-color: string;
                  backgroundPositionX?: undefined;
                  easing: string;
                  offset?: undefined;
              } | {
                  --wbmtr-highlight-color?: undefined;
                  backgroundPositionX: string;
                  easing?: undefined;
                  offset: number;
              } | {
                  --wbmtr-highlight-color: string;
                  backgroundPositionX?: undefined;
                  easing?: undefined;
                  offset?: undefined;
              })[]

    ~un-highlight: {
        defaultConfig: {
            cssClasses: {
                toRemoveOnFinish: ["wbmtr-highlightable"];
            };
        };
        immutableConfig: {};
        generateKeyframes(): {
            forwardFrames: [{
                backgroundPositionX: "0%";
            }, {
                backgroundPositionX: "100%";
            }];
        };
    } = ...

    Element is unhighlighted.

    Type declaration

    • defaultConfig: {
          cssClasses: {
              toRemoveOnFinish: ["wbmtr-highlightable"];
          };
      }
      • ReadonlycssClasses: {
            toRemoveOnFinish: ["wbmtr-highlightable"];
        }
        • ReadonlytoRemoveOnFinish: ["wbmtr-highlightable"]
    • immutableConfig: {}
      • generateKeyframes:function
        • Returns {
              forwardFrames: [{
                  backgroundPositionX: "0%";
              }, {
                  backgroundPositionX: "100%";
              }];
          }

          • ReadonlyforwardFrames: [{
                backgroundPositionX: "0%";
            }, {
                backgroundPositionX: "100%";
            }]