Skip to content

Commit

Permalink
Feat: Expose trackpad's axis values and add a scrollToPosition method
Browse files Browse the repository at this point in the history
  • Loading branch information
bbazukun123 committed May 21, 2024
1 parent d8f40af commit bb86ae4
Showing 1 changed file with 40 additions and 1 deletion.
41 changes: 40 additions & 1 deletion src/ScrollBox.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { ColorSource, Ticker, utils, Point } from '@pixi/core';
import { ColorSource, Ticker, utils, Point, IPointData } from '@pixi/core';
import { Container, DisplayObject, IDestroyOptions } from '@pixi/display';
import { EventMode, FederatedPointerEvent } from '@pixi/events';
import { Graphics } from '@pixi/graphics';
Expand Down Expand Up @@ -693,6 +693,21 @@ export class ScrollBox extends Container
this.stopRenderHiddenItems();
}

/**
* Scrolls to the given position.
* @param position - x and y position object.
* @param position.x - x position.
* @param position.y - y position.
*/
scrollToPosition({ x, y }: Partial<IPointData>)
{
if (x === undefined && y === undefined) return;
this.renderAllItems();
if (x !== undefined) this.scrollX = -x;
if (y !== undefined) this.scrollY = -y;
this.stopRenderHiddenItems();
}

/** Gets component height. */
override get height(): number
{
Expand Down Expand Up @@ -721,6 +736,30 @@ export class ScrollBox extends Container
this.scrollTop();
}

/** Gets the current raw scroll position on the x-axis (Negated Value). */
get scrollX(): number
{
return this._trackpad.xAxis.value;
}

/** Sets the current raw scroll position on the x-axis (Negated Value). */
set scrollX(value: number)
{
this._trackpad.xAxis.value = value;
}

/** Gets the current raw scroll position on the y-axis (Negated Value). */
get scrollY(): number
{
return this._trackpad.yAxis.value;
}

/** Sets the current raw scroll position on the y-axis (Negated Value). */
set scrollY(value: number)
{
this._trackpad.yAxis.value = value;
}

protected update()
{
if (!this.list) return;
Expand Down

0 comments on commit bb86ae4

Please sign in to comment.