@egjs/flicking 4.14.2-beta.2 → 4.16.0-beta.0

package/src/core/VirtualManager.ts

@@ -2,14 +2,24 @@
  * Copyright (c) 2015 NAVER Corp.
  * egjs projects are licensed under the MIT license
  */
+
+import { CLASS } from "../constants/values";
 import Flicking from "../Flicking";
 import { range } from "../utils";
-import { CLASS } from "../const/external";
 
 import VirtualPanel from "./panel/VirtualPanel";
 
+export type PanelRenderCallback =
+  | ((
+      /** Virtual panel to render */
+      panel: VirtualPanel,
+      /** Index of the panel */
+      index: number
+    ) => string)
+  | (() => string);
+
 export interface VirtualOptions {
-  renderPanel: (panel: VirtualPanel, index: number) => string;
+  renderPanel: PanelRenderCallback;
   initialPanelCount: number;
   cache?: boolean;
   panelClass?: string;
@@ -21,55 +31,58 @@ export interface VirtualOptions {
 class VirtualManager {
   private _flicking: Flicking;
 
-  private _renderPanel: (panel: VirtualPanel, index: number) => string;
+  private _renderPanel: PanelRenderCallback;
   private _initialPanelCount: number;
   private _cache: boolean;
   private _panelClass: string;
 
   private _elements: Array<{ nativeElement: HTMLElement; visible: boolean }>;
 
-  public get elements() { return this._elements; }
+  public get elements() {
+    return this._elements;
+  }
 
   // Options
   /**
    * A rendering function for the panel element's innerHTML
-   * @ko 패널 엘리먼트의 innerHTML을 렌더링하는 함수
-   * @type {function}
-   * @param {VirtualPanel} panel Instance of the panel<ko>패널 인스턴스</ko>
-   * @param {number} index Index of the panel<ko>패널 인덱스</ko>
-   * @default "() => {}"
    */
-  public get renderPanel() { return this._renderPanel; }
+  public get renderPanel(): PanelRenderCallback {
+    return this._renderPanel;
+  }
   /**
    * Initial panel count to render
-   * @ko 최초로 렌더링할 패널의 개수
    * @readonly
-   * @type {number}
-   * @default -1
+   * @defaultValue -1
    */
-  public get initialPanelCount() { return this._initialPanelCount; }
+  public get initialPanelCount(): number {
+    return this._initialPanelCount;
+  }
   /**
    * Whether to cache rendered panel's innerHTML
-   * @ko 렌더링된 패널의 innerHTML 정보를 캐시할지 여부
-   * @type {boolean}
-   * @default false
+   * @defaultValue false
    */
-  public get cache() { return this._cache; }
+  public get cache(): boolean {
+    return this._cache;
+  }
   /**
    * The class name that will be applied to rendered panel elements
-   * @ko 렌더링되는 패널 엘리먼트에 적용될 클래스 이름
-   * @type {string}
-   * @default "flicking-panel"
+   * @defaultValue "flicking-panel"
    */
-  public get panelClass() { return this._panelClass; }
+  public get panelClass(): string {
+    return this._panelClass;
+  }
 
   public set renderPanel(val: VirtualOptions["renderPanel"]) {
     this._renderPanel = val;
     this._flicking.renderer.panels.forEach((panel: VirtualPanel) => panel.uncacheRenderResult());
   }
 
-  public set cache(val: NonNullable<VirtualOptions["cache"]>) { this._cache = val; }
-  public set panelClass(val: NonNullable<VirtualOptions["panelClass"]>) { this._panelClass = val; }
+  public set cache(val: NonNullable<VirtualOptions["cache"]>) {
+    this._cache = val;
+  }
+  public set panelClass(val: NonNullable<VirtualOptions["panelClass"]>) {
+    this._panelClass = val;
+  }
 
   public constructor(flicking: Flicking, options: VirtualOptions | null) {
     this._flicking = flicking;
@@ -116,9 +129,8 @@ class VirtualManager {
 
   /**
    * Add new virtual panels at the end of the list
-   * @ko 새로운 가상 패널들을 리스트의 끝에 추가합니다
-   * @param {number} count The number of panels to add<ko>추가할 패널의 개수</ko>
-   * @returns {Array<VirtualPanel>} The new panels added<ko>새롭게 추가된 패널들</ko>
+   * @param count - The number of panels to add
+   * @returns The new panels added
    */
   public append(count: number = 1): VirtualPanel[] {
     const flicking = this._flicking;
@@ -128,9 +140,8 @@ class VirtualManager {
 
   /**
    * Add new virtual panels at the start of the list
-   * @ko 새로운 가상 패널들을 리스트의 시작에 추가합니다
-   * @param {number} count The number of panels to add<ko>추가할 패널의 개수</ko>
-   * @returns {Array<VirtualPanel>} The new panels added<ko>새롭게 추가된 패널들</ko>
+   * @param count - The number of panels to add
+   * @returns The new panels added
    */
   public prepend(count: number = 1): VirtualPanel[] {
     return this.insert(0, count);
@@ -138,9 +149,8 @@ class VirtualManager {
 
   /**
    * Add new virtual panels at the given index
-   * @ko 새로운 가상 패널들을 주어진 인덱스에 추가합니다
-   * @param {number} count The number of panels to add<ko>추가할 패널의 개수</ko>
-   * @returns {Array<VirtualPanel>} The new panels added<ko>새롭게 추가된 패널들</ko>
+   * @param count - The number of panels to add
+   * @returns The new panels added
    */
   public insert(index: number, count: number = 1): VirtualPanel[] {
     if (count <= 0) return [];
@@ -152,9 +162,8 @@ class VirtualManager {
 
   /**
    * Remove panels at the given index
-   * @ko 주어진 인덱스에서 패널들을 삭제합니다
-   * @param {number} count The number of panels to remove<ko>삭제할 패널의 개수</ko>
-   * @returns {Array<VirtualPanel>} The panels removed<ko>삭제된 패널들</ko>
+   * @param count - The number of panels to remove
+   * @returns The panels removed
    */
   public remove(index: number, count: number): VirtualPanel[] {
     if (count <= 0) return [];
@@ -164,6 +173,9 @@ class VirtualManager {
     return flicking.renderer.batchRemove({ index, deleteCount: count, hasDOMInElements: false }) as VirtualPanel[];
   }
 
+  /**
+   * @internal
+   */
   private _initVirtualElements() {
     const flicking = this._flicking;
     const cameraElement = flicking.camera.element;

package/src/core/index.ts

@@ -2,16 +2,13 @@
  * Copyright (c) 2015 NAVER Corp.
  * egjs projects are licensed under the MIT license
  */
-import Viewport from "./Viewport";
-import FlickingError from "./FlickingError";
+
 import AnchorPoint from "./AnchorPoint";
-import VirtualManager from "./VirtualManager";
+import Viewport, { ViewportPadding } from "./Viewport";
+import VirtualManager, { PanelRenderCallback, VirtualOptions } from "./VirtualManager";
+
+export { Viewport, AnchorPoint, VirtualManager };
 
-export {
-  Viewport,
-  FlickingError,
-  AnchorPoint,
-  VirtualManager
-};
+export type { ViewportPadding, VirtualOptions, PanelRenderCallback };
 
 export * from "./panel";