libPresetScrolls: {
    ~scroll-self: {
        defaultConfig: {};
        effectCompositionFrequency: "on-first-play-only";
        immutableConfig: {
            composite: "replace";
        };
        composeEffect(target: undefined | null | Element, scrollOptions?: Partial<ScrollingOptions>): {
            backwardMutatorGenerator: (() => (() => void));
            forwardMutatorGenerator: (() => (() => void));
        };
    };
} = ...

Type declaration

  • ~scroll-self: {
        defaultConfig: {};
        effectCompositionFrequency: "on-first-play-only";
        immutableConfig: {
            composite: "replace";
        };
        composeEffect(target: undefined | null | Element, scrollOptions?: Partial<ScrollingOptions>): {
            backwardMutatorGenerator: (() => (() => void));
            forwardMutatorGenerator: (() => (() => void));
        };
    }

    Element is scrolled with respect to a child element.

    • defaultConfig: {}
      • effectCompositionFrequency: "on-first-play-only"
      • immutableConfig: {
            composite: "replace";
        }
        • Readonlycomposite: "replace"
      • composeEffect: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 {
              backwardMutatorGenerator: (() => (() => void));
              forwardMutatorGenerator: (() => (() => void));
          }

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

                  • (): void
                  • Returns void

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

                  • (): void
                  • Returns void