Skip to content

Commit

Permalink
feat: add dragThreshold option
Browse files Browse the repository at this point in the history
  • Loading branch information
malangfox committed Jun 25, 2024
1 parent 778d573 commit 25b1b2d
Show file tree
Hide file tree
Showing 4 changed files with 100 additions and 3 deletions.
33 changes: 33 additions & 0 deletions docs/src/pages/Options.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -857,6 +857,39 @@ It should be dragged above the threshold to change the current panel.
</ColumnItem>
</Columns>

### dragThreshold
Minimal distance of user input before recognizing (unit: px).
It should be dragged above the dragThreshold to move the panel.

<Columns>
<ColumnItem is={6}>

```js
dragThreshold: 1
```

</ColumnItem>
<ColumnItem is={6}>
<Flicking dragThreshold={1}>
{ Panels(5) }
</Flicking>
</ColumnItem>
</Columns>
<Columns>
<ColumnItem is={6}>

```js
dragThreshold: 30
```

</ColumnItem>
<ColumnItem is={6}>
<Flicking dragThreshold={30}>
{ Panels(5) }
</Flicking>
</ColumnItem>
</Columns>

### interruptable
Set animation to be interruptable by click/touch.

Expand Down
26 changes: 24 additions & 2 deletions src/Flicking.ts
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ export interface FlickingOptions {
inputType: string[];
moveType: ValueOf<typeof MOVE_TYPE> | MoveTypeOptions<ValueOf<typeof MOVE_TYPE>>;
threshold: number;
dragThreshold: number;
interruptable: boolean;
bounce: number | string | [number | string, number | string];
iOSEdgeSwipeThreshold: number;
Expand Down Expand Up @@ -152,6 +153,7 @@ class Flicking extends Component<FlickingEvents> {
private _inputType: FlickingOptions["inputType"];
private _moveType: FlickingOptions["moveType"];
private _threshold: FlickingOptions["threshold"];
private _dragThreshold: FlickingOptions["dragThreshold"];
private _interruptable: FlickingOptions["interruptable"];
private _bounce: FlickingOptions["bounce"];
private _iOSEdgeSwipeThreshold: FlickingOptions["iOSEdgeSwipeThreshold"];
Expand Down Expand Up @@ -350,7 +352,7 @@ class Flicking extends Component<FlickingEvents> {
public get align() { return this._align; }
/**
* Index of the panel to move when Flicking's {@link Flicking#init init()} is called. A zero-based integer
* @ko Flicking의 {@link Flicking#init init()}이 호출될 때 이동할 디폴트 패널의 인덱스로, 0부터 시작하는 정수입니다
* @ko Flicking의 {@link Flicking#init init()}이 호출될 때 이동할 디폴트 패널의 인덱스로, 0부터 시작하는 정수입니다.
* @type {number}
* @default 0
* @see {@link https://naver.github.io/egjs-flicking/Options#defaultindex defaultIndex ( Options )}
Expand Down Expand Up @@ -528,12 +530,20 @@ class Flicking extends Component<FlickingEvents> {
public get moveType() { return this._moveType; }
/**
* Movement threshold to change panel (unit: px). It should be dragged above the threshold to change the current panel.
* @ko 패널 변경을 위한 이동 임계값 (단위: px). 주어진 값 이상으로 스크롤해야만 패널 변경이 가능하다.
* @ko 패널 변경을 위한 이동 임계값 (단위: px). 주어진 값 이상으로 스크롤해야만 패널 변경이 가능합니다.
* @type {number}
* @default 40
* @see {@link https://naver.github.io/egjs-flicking/Options#threshold Threshold ( Options )}
*/
public get threshold() { return this._threshold; }
/**
* Minimal distance of user input before recognizing (unit: px). It should be dragged above the dragThreshold to move the panel.
* @ko 사용자의 입력을 인식하기 위한 최소한의 거리 (단위: px). 주어진 값 이상으로 스크롤해야만 패널이 움직입니다.
* @type {number}
* @default 1
* @see {@link https://naver.github.io/egjs-flicking/Options#dragThreshold dragThreshold ( Options )}
*/
public get dragThreshold() { return this._dragThreshold; }
/**
* Set animation to be interruptable by click/touch.
* @ko 사용자의 클릭/터치로 인해 애니메이션을 도중에 멈출 수 있도록 설정합니다.
Expand Down Expand Up @@ -845,6 +855,16 @@ class Flicking extends Component<FlickingEvents> {
}

public set threshold(val: FlickingOptions["threshold"]) { this._threshold = val; }

public set dragThreshold(val: FlickingOptions["dragThreshold"]) {
this._dragThreshold = val;
const panInput = this._control.controller.panInput;

if (panInput) {
panInput.options.threshold = val;
}
}

public set interruptable(val: FlickingOptions["interruptable"]) {
this._interruptable = val;

Expand Down Expand Up @@ -969,6 +989,7 @@ class Flicking extends Component<FlickingEvents> {
inputType = ["mouse", "touch"],
moveType = "snap",
threshold = 40,
dragThreshold = 1,
interruptable = true,
bounce = "20%",
iOSEdgeSwipeThreshold = 30,
Expand Down Expand Up @@ -1014,6 +1035,7 @@ class Flicking extends Component<FlickingEvents> {
this._inputType = inputType;
this._moveType = moveType;
this._threshold = threshold;
this._dragThreshold = dragThreshold;
this._interruptable = interruptable;
this._bounce = bounce;
this._iOSEdgeSwipeThreshold = iOSEdgeSwipeThreshold;
Expand Down
2 changes: 1 addition & 1 deletion src/control/AxesController.ts
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ class AxesController {
});
this._panInput = new PanInput(flicking.viewport.element, {
inputType: flicking.inputType,
threshold: 1,
threshold: flicking.dragThreshold,
iOSEdgeSwipeThreshold: flicking.iOSEdgeSwipeThreshold,
preventDefaultOnDrag: flicking.preventDefaultOnDrag,
scale: flicking.horizontal ? [flicking.camera.panelOrder === ORDER.RTL ? 1 : -1, 0] : [0, -1],
Expand Down
42 changes: 42 additions & 0 deletions test/unit/Flicking.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -689,6 +689,48 @@ describe("Flicking", () => {
});
});

describe("dragThreshold", () => {
it("is 1 by default", async () => {
const flicking = await createFlicking(El.DEFAULT_HORIZONTAL);

expect(flicking.dragThreshold).to.equal(1);
});

it("should trigger move event when moving above dragThreshold", async () => {
const flicking = await createFlicking(El.DEFAULT_HORIZONTAL, { dragThreshold: 50 });
const moveSpy = sinon.spy();
flicking.on(EVENTS.MOVE, moveSpy);


await simulate(flicking.element, { deltaX: -51, duration: 3000 });

expect(moveSpy.called).to.be.true;
});

it("should not trigger move event when moving below dragThreshold", async () => {
const flicking = await createFlicking(El.DEFAULT_HORIZONTAL, { dragThreshold: 50 });
const moveSpy = sinon.spy();
flicking.on(EVENTS.MOVE, moveSpy);

await simulate(flicking.element, { deltaX: -49, duration: 3000 });

expect(moveSpy.called).to.be.false;
});

it("should update axes option when changed", async () => {
const flicking = await createFlicking(El.DEFAULT_HORIZONTAL, {
dragThreshold: 50
});
const panOptions = flicking.control.controller.panInput.options;
const prevVal = panOptions.threshold;

flicking.dragThreshold = 30;

expect(prevVal).to.equal(50);
expect(panOptions.threshold).to.equal(30);
});
});

describe("interruptable", () => {
it("is true by default", async () => {
const flicking = await createFlicking(El.DEFAULT_HORIZONTAL);
Expand Down

0 comments on commit 25b1b2d

Please sign in to comment.