Interface WebchalkPresetScrollEffects

Type Declaration

• defaultConfig: {}

• howOftenBuildGenerators: "on-first-play-only"

• immutableConfig: { composite: "replace" }

• buildFrameGenerators: function

  • buildFrameGenerators(
        this: Readonly<
            Pick<
                ScrollerClip<
                    Readonly<
                        StripDuplicateMethodAutocompletion<
                            {
                                defaultConfig?: Partial<(...)> & object;
                                howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                immutableConfig?: Partial<(...)> & object;
                                buildFrameGenerators(
                                    this: Readonly<Pick<AnimClip<(...), (...)>, "computeTween">>,
                                    ...effectOptions: unknown[],
                                ): EffectFrameGeneratorSet;
                            },
                        >,
                    >,
                >,
                "domElem"
                | "getEffectDetails"
                | "getStatus"
                | "getStyles"
                | "getTiming",
            >,
        > & Readonly<
            Pick<
                AnimClip<
                    Readonly<
                        StripDuplicateMethodAutocompletion<
                            {
                                defaultConfig?: Partial<(...)> & object;
                                howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                immutableConfig?: Partial<(...)> & object;
                                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",
            >,
        >,
        target: Element | null | undefined,
        scrollOptions?: Partial<ScrollingOptions>,
    ): {
        mutatorGenerator_play: () => () => void;
        mutatorGenerator_rewind: () => () => void;
    }

    Parameters

    • this: Readonly<
          Pick<
              ScrollerClip<
                  Readonly<
                      StripDuplicateMethodAutocompletion<
                          {
                              defaultConfig?: Partial<(...)> & object;
                              howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                              immutableConfig?: Partial<(...)> & object;
                              buildFrameGenerators(
                                  this: Readonly<Pick<AnimClip<(...), (...)>, "computeTween">>,
                                  ...effectOptions: unknown[],
                              ): EffectFrameGeneratorSet;
                          },
                      >,
                  >,
              >,
              "domElem"
              | "getEffectDetails"
              | "getStatus"
              | "getStyles"
              | "getTiming",
          >,
      > & Readonly<
          Pick<
              AnimClip<
                  Readonly<
                      StripDuplicateMethodAutocompletion<
                          {
                              defaultConfig?: Partial<(...)> & object;
                              howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                              immutableConfig?: Partial<(...)> & object;
                              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",
          >,
      >
    • target: Element | null | undefined

      The child element to which our element should scroll.

    • scrollOptions: Partial<ScrollingOptions> = {}

      An options object defining the behavior of the scroll.

    Returns {
        mutatorGenerator_play: () => () => void;
        mutatorGenerator_rewind: () => () => void;
    }