@egjs/flicking 4.4.1 → 4.5.1

package/README.md

@@ -6,7 +6,6 @@
 <p align="center" style="line-height: 2;">
   <a href="https://www.npmjs.com/package/@egjs/flicking" target="_blank"><img src="https://img.shields.io/npm/v/@egjs/flicking.svg?style=flat-square&color=007acc&label=version&logo=NPM" alt="version" /></a>
   <a href="https://www.npmjs.com/package/@egjs/flicking" target="_blank"><img alt="npm bundle size (scoped)" src="https://img.shields.io/bundlephobia/minzip/@egjs/flicking.svg?style=flat-square&label=%F0%9F%92%BE%20gzipped&color=007acc" /></a>
-  <a href="https://travis-ci.org/naver/egjs-flicking" target="_blank"><img alt="Travis (.org)" src="https://img.shields.io/travis/naver/egjs-flicking.svg?style=flat-square&label=build&logo=travis%20ci" /></a>
   <a href="https://coveralls.io/github/naver/egjs-flicking?branch=master&style=flat-square" target="_blank"><img alt="Coveralls github" src="https://img.shields.io/coveralls/github/naver/egjs-flicking.svg?style=flat-square&label=%E2%9C%85%20coverage" /></a>
   <a href="https://deepscan.io/dashboard#view=project&tid=3998&pid=5802&bid=46086"><img src="https://deepscan.io/api/teams/3998/projects/5802/branches/46086/badge/grade.svg" alt="DeepScan grade" /></a>
 </p>

package/declaration/Flicking.d.ts

@@ -5,7 +5,7 @@ import VirtualManager, { VirtualOptions } from "./core/VirtualManager";
 import { Control } from "./control";
 import { Camera } from "./camera";
 import { Renderer, ExternalRenderer, RendererOptions } from "./renderer";
-import { EVENTS, ALIGN, MOVE_TYPE, DIRECTION } from "./const/external";
+import { EVENTS, ALIGN, MOVE_TYPE, DIRECTION, CIRCULAR_FALLBACK } from "./const/external";
 import { HoldStartEvent, HoldEndEvent, MoveStartEvent, SelectEvent, MoveEvent, MoveEndEvent, WillChangeEvent, WillRestoreEvent, NeedPanelEvent, VisibleChangeEvent, ReachEdgeEvent, ReadyEvent, AfterResizeEvent, BeforeResizeEvent, ChangedEvent, RestoredEvent, PanelChangeEvent } from "./type/event";
 import { LiteralUnion, ValueOf } from "./type/internal";
 import { ElementLike, Plugin, Status, MoveTypeOptions } from "./type/external";
@@ -36,6 +36,7 @@ export interface FlickingOptions {
     defaultIndex: number;
     horizontal: boolean;
     circular: boolean;
+    circularFallback: LiteralUnion<ValueOf<typeof CIRCULAR_FALLBACK>>;
     bound: boolean;
     adaptive: boolean;
     panelsPerView: number;
@@ -77,6 +78,7 @@ declare class Flicking extends Component<FlickingEvents> {
     private _defaultIndex;
     private _horizontal;
     private _circular;
+    private _circularFallback;
     private _bound;
     private _adaptive;
     private _panelsPerView;
@@ -124,6 +126,10 @@ declare class Flicking extends Component<FlickingEvents> {
     get defaultIndex(): FlickingOptions["defaultIndex"];
     get horizontal(): FlickingOptions["horizontal"];
     get circular(): FlickingOptions["circular"];
+    get circularFallback(): LiteralUnion<ValueOf<{
+        readonly LINEAR: "linear";
+        readonly BOUND: "bound";
+    }>, string>;
     get bound(): FlickingOptions["bound"];
     get adaptive(): FlickingOptions["adaptive"];
     get panelsPerView(): FlickingOptions["panelsPerView"];
@@ -177,7 +183,7 @@ declare class Flicking extends Component<FlickingEvents> {
     set renderOnlyVisible(val: FlickingOptions["renderOnlyVisible"]);
     set autoResize(val: FlickingOptions["autoResize"]);
     set useResizeObserver(val: FlickingOptions["useResizeObserver"]);
-    constructor(root: HTMLElement | string, { align, defaultIndex, horizontal, circular, bound, adaptive, panelsPerView, noPanelStyleOverride, resizeOnContentsReady, needPanelThreshold, preventEventsBeforeInit, deceleration, duration, easing, inputType, moveType, threshold, interruptable, bounce, iOSEdgeSwipeThreshold, preventClickOnDrag, disableOnInit, renderOnlyVisible, virtual, autoInit, autoResize, useResizeObserver, externalRenderer, renderExternal }?: Partial<FlickingOptions>);
+    constructor(root: HTMLElement | string, { align, defaultIndex, horizontal, circular, circularFallback, bound, adaptive, panelsPerView, noPanelStyleOverride, resizeOnContentsReady, needPanelThreshold, preventEventsBeforeInit, deceleration, duration, easing, inputType, moveType, threshold, interruptable, bounce, iOSEdgeSwipeThreshold, preventClickOnDrag, disableOnInit, renderOnlyVisible, virtual, autoInit, autoResize, useResizeObserver, externalRenderer, renderExternal }?: Partial<FlickingOptions>);
     init(): Promise<void>;
     destroy(): void;
     prev(duration?: number): Promise<void>;

package/declaration/camera/Camera.d.ts

@@ -1,32 +1,32 @@
 import Flicking, { FlickingOptions } from "../Flicking";
 import Panel from "../core/panel/Panel";
 import AnchorPoint from "../core/AnchorPoint";
+import { CameraMode } from "./mode";
 export interface CameraOptions {
     align: FlickingOptions["align"];
 }
-declare abstract class Camera {
-    protected _align: FlickingOptions["align"];
-    protected _flicking: Flicking | null;
-    protected _el: HTMLElement;
-    protected _transform: string;
-    protected _position: number;
-    protected _alignPos: number;
-    protected _offset: number;
-    protected _range: {
-        min: number;
-        max: number;
-    };
-    protected _visiblePanels: Panel[];
-    protected _anchors: AnchorPoint[];
-    protected _needPanelTriggered: {
-        prev: boolean;
-        next: boolean;
-    };
+declare class Camera {
+    private _align;
+    private _flicking;
+    private _mode;
+    private _el;
+    private _transform;
+    private _position;
+    private _alignPos;
+    private _offset;
+    private _circularOffset;
+    private _circularEnabled;
+    private _range;
+    private _visiblePanels;
+    private _anchors;
+    private _needPanelTriggered;
     get element(): HTMLElement;
     get children(): HTMLElement[];
     get position(): number;
     get alignPosition(): number;
     get offset(): number;
+    get circularEnabled(): boolean;
+    get mode(): CameraMode;
     get range(): {
         min: number;
         max: number;
@@ -52,7 +52,6 @@ declare abstract class Camera {
     get align(): FlickingOptions["align"];
     set align(val: FlickingOptions["align"]);
     constructor({ align }?: Partial<CameraOptions>);
-    abstract updateRange(): this;
     init(flicking: Flicking): this;
     destroy(): this;
     lookAt(pos: number): void;
@@ -65,16 +64,19 @@ declare abstract class Camera {
     clampToReachablePosition(position: number): number;
     canReach(panel: Panel): boolean;
     canSee(panel: Panel): boolean;
+    updateRange(): this;
     updateAlignPos(): this;
     updateAnchors(): this;
     updateAdaptiveHeight(): void;
     updateOffset(): this;
     resetNeedPanelHistory(): this;
     applyTransform(): this;
-    protected _resetInternalValues(): void;
-    protected _refreshVisiblePanels(): void;
-    protected _checkNeedPanel(): void;
-    protected _checkReachEnd(prevPos: number, newPos: number): void;
-    protected _checkTranslateSupport: () => void;
+    private _resetInternalValues;
+    private _refreshVisiblePanels;
+    private _checkNeedPanel;
+    private _checkReachEnd;
+    private _checkTranslateSupport;
+    private _updateMode;
+    private _togglePanels;
 }
 export default Camera;

package/declaration/camera/index.d.ts

@@ -1,6 +1,4 @@
 import Camera, { CameraOptions } from "./Camera";
-import LinearCamera from "./LinearCamera";
-import CircularCamera from "./CircularCamera";
-import BoundCamera from "./BoundCamera";
-export { Camera, LinearCamera, CircularCamera, BoundCamera };
+export { Camera };
 export type { CameraOptions };
+export * from "./mode";

package/declaration/camera/mode/BoundCameraMode.d.ts

@@ -0,0 +1,13 @@
+import AnchorPoint from "../../core/AnchorPoint";
+import CameraMode from "./CameraMode";
+declare class BoundCameraMode extends CameraMode {
+    checkAvailability(): boolean;
+    getRange(): {
+        min: number;
+        max: number;
+    };
+    getAnchors(): AnchorPoint[];
+    findAnchorIncludePosition(position: number): AnchorPoint | null;
+    private _findNearestPanel;
+}
+export default BoundCameraMode;

package/declaration/camera/mode/CameraMode.d.ts

@@ -0,0 +1,19 @@
+import Flicking from "../../Flicking";
+import Panel from "../../core/panel/Panel";
+import AnchorPoint from "../../core/AnchorPoint";
+declare abstract class CameraMode {
+    protected _flicking: Flicking;
+    constructor(flicking: Flicking);
+    abstract checkAvailability(): boolean;
+    abstract getRange(): {
+        min: number;
+        max: number;
+    };
+    getAnchors(): AnchorPoint[];
+    findAnchorIncludePosition(position: number): AnchorPoint | null;
+    clampToReachablePosition(position: number): number;
+    getCircularOffset(): number;
+    canReach(panel: Panel): boolean;
+    canSee(panel: Panel): boolean;
+}
+export default CameraMode;

package/declaration/camera/mode/CircularCameraMode.d.ts

@@ -0,0 +1,18 @@
+import Panel from "../../core/panel/Panel";
+import AnchorPoint from "../../core/AnchorPoint";
+import CameraMode from "./CameraMode";
+declare class CircularCameraMode extends CameraMode {
+    checkAvailability(): boolean;
+    getRange(): {
+        min: number;
+        max: number;
+    };
+    getAnchors(): AnchorPoint[];
+    findAnchorIncludePosition(position: number): AnchorPoint | null;
+    getCircularOffset(): number;
+    clampToReachablePosition(position: number): number;
+    canReach(panel: Panel): boolean;
+    canSee(panel: Panel): boolean;
+    private _calcPanelAreaSum;
+}
+export default CircularCameraMode;

package/declaration/camera/mode/LinearCameraMode.d.ts

@@ -0,0 +1,9 @@
+import CameraMode from "./CameraMode";
+declare class LinearCameraMode extends CameraMode {
+    checkAvailability(): boolean;
+    getRange(): {
+        min: number;
+        max: number;
+    };
+}
+export default LinearCameraMode;

package/declaration/camera/mode/index.d.ts

@@ -0,0 +1,6 @@
+import CameraMode from "./CameraMode";
+import LinearCameraMode from "./LinearCameraMode";
+import CircularCameraMode from "./CircularCameraMode";
+import BoundCameraMode from "./BoundCameraMode";
+export { LinearCameraMode, CircularCameraMode, BoundCameraMode };
+export type { CameraMode };

package/declaration/const/external.d.ts

@@ -38,3 +38,7 @@ export declare const CLASS: {
     HIDDEN: string;
     DEFAULT_VIRTUAL: string;
 };
+export declare const CIRCULAR_FALLBACK: {
+    readonly LINEAR: "linear";
+    readonly BOUND: "bound";
+};

package/declaration/control/StrictControl.d.ts

@@ -12,6 +12,7 @@ declare class StrictControl extends Control {
     constructor({ count }?: Partial<StrictControlOptions>);
     destroy(): void;
     updateInput(): this;
+    moveToPanel(panel: Panel, options: Parameters<Control["moveToPanel"]>[1]): Promise<void>;
     moveToPosition(position: number, duration: number, axesEvent?: OnRelease): Promise<void>;
     setActive: (newActivePanel: Panel, prevActivePanel: Panel | null, isTrusted: boolean) => void;
     private _resetIndexRange;

package/declaration/type/external.d.ts

@@ -20,9 +20,7 @@ export interface Status {
         html?: string;
     }>;
 }
-export declare type MoveTypeOptions<T extends ValueOf<typeof MOVE_TYPE>> = T extends typeof MOVE_TYPE.SNAP ? [T] | [T, Partial<SnapControlOptions>] : T extends typeof MOVE_TYPE.FREE_SCROLL ? [T] | [T, Partial<FreeControlOptions>] : T extends typeof MOVE_TYPE.STRICT ? [T] | [T, Partial<StrictControlOptions>] : [
-    T
-];
+export declare type MoveTypeOptions<T extends ValueOf<typeof MOVE_TYPE>> = T extends typeof MOVE_TYPE.SNAP ? [T] | [T, Partial<SnapControlOptions>] : T extends typeof MOVE_TYPE.FREE_SCROLL ? [T] | [T, Partial<FreeControlOptions>] : T extends typeof MOVE_TYPE.STRICT ? [T] | [T, Partial<StrictControlOptions>] : [T];
 export interface ControlParams {
     range: {
         min: number;