Function scrollElementTo

scrollElementTo(
    element: HTMLElement,
    options: {
        duration?: number;
        easing?:
            | "linearTween"
            | "easeInQuad"
            | "easeOutQuad"
            | "easeInOutQuad"
            | "easeInCuaic"
            | "easeOutCuaic"
            | "easeInOutCuaic"
            | "easeInQuart"
            | "easeOutQuart"
            | "easeInOutQuart"
            | "easeInQuint"
            | "easeOutQuint"
            | "easeInOutQuint"
            | "easeInSine"
            | "easeOutSine"
            | "easeInOutSine"
            | "easeInExpo"
            | "easeOutExpo"
            | "easeInOutExpo"
            | "easeInCirc"
            | "easeOutCirc"
            | "easeInOutCirc";
        x?: number;
        y?: number;
    },
): undefined
| Promise<unknown>
Scrolls an element to a given x/y scrollposition in the supplied duration. Has multiple different easing functions to choose from.
Parameters
- element: HTMLElement
- options: {
      duration?: number;
      easing?:
          | "linearTween"
          | "easeInQuad"
          | "easeOutQuad"
          | "easeInOutQuad"
          | "easeInCuaic"
          | "easeOutCuaic"
          | "easeInOutCuaic"
          | "easeInQuart"
          | "easeOutQuart"
          | "easeInOutQuart"
          | "easeInQuint"
          | "easeOutQuint"
          | "easeInOutQuint"
          | "easeInSine"
          | "easeOutSine"
          | "easeInOutSine"
          | "easeInExpo"
          | "easeOutExpo"
          | "easeInOutExpo"
          | "easeInCirc"
          | "easeOutCirc"
          | "easeInOutCirc";
      x?: number;
      y?: number;
  }
  - Optionalduration?: number
    Default
    300
  - Optionaleasing?:
        | "linearTween"
        | "easeInQuad"
        | "easeOutQuad"
        | "easeInOutQuad"
        | "easeInCuaic"
        | "easeOutCuaic"
        | "easeInOutCuaic"
        | "easeInQuart"
        | "easeOutQuart"
        | "easeInOutQuart"
        | "easeInQuint"
        | "easeOutQuint"
        | "easeInOutQuint"
        | "easeInSine"
        | "easeOutSine"
        | "easeInOutSine"
        | "easeInExpo"
        | "easeOutExpo"
        | "easeInOutExpo"
        | "easeInCirc"
        | "easeOutCirc"
        | "easeInOutCirc"
    Default
    easeOutCuaic
  - Optionalx?: number
  - Optionaly?: number
Returns undefined | Promise<unknown>
a promise that resolves when the scroll finishes.
- Defined in work/library/library/src/dom/scroll-element-to.ts:6

Function scrollElementTo

Parameters

`Optional`duration?: number

Default

Default

`Optional`x?: number

`Optional`y?: number

Returns undefined | Promise<unknown>

Settings

Function scrollElementTo

Parameters

Optionalduration?: number

Default

Default

Optionalx?: number

Optionaly?: number

Returns undefined | Promise<unknown>

Settings

`Optional`duration?: number

`Optional`x?: number

`Optional`y?: number