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

interface LibraryPresetScrollEffects {
    ~scroll-self: {
        defaultConfig: {
            runGeneratorsNow: false;
        };
        immutableConfig: {};
        generateRafMutatorGenerators(target: undefined | null | Element, scrollOptions?: Partial<ScrollingOptions>): {
            backwardGenerator: (() => (() => void));
            forwardGenerator: (() => (() => void));
        };
    };
}

Properties

Properties

~scroll-self: {
    defaultConfig: {
        runGeneratorsNow: false;
    };
    immutableConfig: {};
    generateRafMutatorGenerators(target: undefined | null | Element, scrollOptions?: Partial<ScrollingOptions>): {
        backwardGenerator: (() => (() => void));
        forwardGenerator: (() => (() => void));
    };
} = ...

Element is scrolled with respect to a child element.

Type declaration

  • defaultConfig: {
        runGeneratorsNow: false;
    }
    • ReadonlyrunGeneratorsNow: false
  • immutableConfig: {}
    • generateRafMutatorGenerators:function
      • Parameters

        • target: undefined | null | Element

          child element to which our element should scroll

        • scrollOptions: Partial<ScrollingOptions> = {}

          options defining the behavior of the scroll

        Returns {
            backwardGenerator: (() => (() => void));
            forwardGenerator: (() => (() => void));
        }

        • backwardGenerator: (() => (() => void))
            • (): (() => void)
            • Returns (() => void)

                • (): void
                • Returns void

        • forwardGenerator: (() => (() => void))
            • (): (() => void)
            • Returns (() => void)

                • (): void
                • Returns void