@egjs/flicking 4.12.0-beta.1 → 4.12.0-beta.3

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@egjs/flicking",
-	"version": "4.12.0-beta.1",
+	"version": "4.12.0-beta.3",
 	"description": "Everyday 30 million people experience. It's reliable, flexible and extendable carousel.",
 	"main": "dist/flicking.cjs.js",
 	"module": "dist/flicking.esm.js",

package/src/CrossFlicking.ts

@@ -6,7 +6,8 @@
 import Flicking, { FlickingOptions } from "./Flicking";
 import { ChangedEvent, MoveEndEvent, MoveEvent } from "./type/event";
 import { LiteralUnion, ValueOf } from "./type/internal";
-import { EVENTS, MOVE_DIRECTION } from "./const/external";
+import { CLASS, EVENTS, MOVE_DIRECTION } from "./const/external";
+import { getDataAttributes, getElement, includes, toArray } from "./utils";
 
 /**
  * @interface
@@ -39,6 +40,7 @@ export interface CrossFlickingOptions {
  * @property {string | undefined} [panels.html] An `outerHTML` of the panel element<ko>패널 엘리먼트의 `outerHTML`</ko>
  */
 export interface VerticalState {
+  key: string;
   start: number;
   end: number;
   element: HTMLElement;
@@ -59,11 +61,39 @@ export class CrossFlicking extends Flicking {
 
   // Internal State
   private _verticalState: VerticalState[];
-
   private _moveDirection: LiteralUnion<ValueOf<typeof MOVE_DIRECTION>> | null;
   private _nextIndex: number;
 
   // Components
+  /**
+   * {@link Control} instance of the Flicking
+   * @ko 현재 Flicking에 활성화된 {@link Control} 인스턴스
+   * @type {Control}
+   * @default SnapControl
+   * @readonly
+   * @see Control
+   * @see SnapControl
+   * @see FreeControl
+   */
+  public get verticalFlicking() {
+    return this._verticalFlicking;
+  }
+
+  // Internal States
+  /**
+   * Whether Flicking's {@link Flicking#init init()} is called.
+   * This is `true` when {@link Flicking#init init()} is called, and is `false` after calling {@link Flicking#destroy destroy()}.
+   * @ko Flicking의 {@link Flicking#init init()}이 호출되었는지를 나타내는 멤버 변수.
+   * 이 값은 {@link Flicking#init init()}이 호출되었으면 `true`로 변하고, {@link Flicking#destroy destroy()}호출 이후에 다시 `false`로 변경됩니다.
+   * @type {boolean}
+   * @default false
+   * @readonly
+   */
+  public get verticalState() {
+    return this._verticalState;
+  }
+
+  // Options Getter
   /**
    * Change active panel index on mouse/touch hold while animating.
    * `index` of the `willChange`/`willRestore` event will be used as new index.
@@ -78,7 +108,6 @@ export class CrossFlicking extends Flicking {
   }
 
   // Options Setter
-  // UI / LAYOUT
   // public set align(val: FlickingOptions["align"]) {
   //   this._align = val;
   // }
@@ -90,7 +119,7 @@ export class CrossFlicking extends Flicking {
     super(root);
 
     // Internal states
-    this._verticalState = [];
+    this._verticalState = this._createVerticalState();
     this._moveDirection = null;
     this._nextIndex = 0;
 
@@ -98,7 +127,7 @@ export class CrossFlicking extends Flicking {
     this._verticalOptions = verticalOptions;
 
     // Create core components
-    // this._viewport = new Viewport(this, getElement(root));
+    this._verticalFlicking = this._createVerticalFlicking();
   }
 
   /**
@@ -110,46 +139,121 @@ export class CrossFlicking extends Flicking {
    * @return {Promise<void>}
    */
   public init(): Promise<void> {
-    return super.init().then(() => {
-      // data-index로 분류하기 전에 임시로 모든 children에 대해 vertical flicking으로 해보자.
-      // camera.children들에 대해 갯수 세기
-      let verticalPanels = ``;
-      this._verticalState = this.camera.children.reduce(
-        (state: VerticalState[], child: HTMLElement) => {
+    return super.init().then(() => this._addComponentEvents());
+  }
+
+  private _addComponentEvents(): void {
+    this.on(EVENTS.HOLD_START, this._onHorizontalHoldStart);
+    this.on(EVENTS.MOVE, this._onHorizontalMove);
+    this.on(EVENTS.MOVE_END, this._onHorizontalMoveEnd);
+
+    this._verticalFlicking.forEach((flicking) => {
+      flicking.on(EVENTS.HOLD_START, this._onVerticalHoldStart);
+      flicking.on(EVENTS.MOVE, this._onVerticalMove);
+      flicking.on(EVENTS.MOVE_END, this._onVerticalMoveEnd);
+      flicking.on(EVENTS.CHANGED, this._onVerticalChanged);
+    });
+  }
+
+  private _createVerticalState(): VerticalState[] {
+    // data-index로 분류하기 전에 임시로 모든 children에 대해 vertical flicking으로 해보자.
+    // panels에 data-attributes가 붙어있을 때와 안 붙어있을 때를 다르게 처리
+    // 붙어있다면 가상의 viewport들을 index 갯수만큼 만들어줘야 한다
+    const cameraEl = this.camera.element;
+    const panels = toArray(cameraEl.children) as HTMLElement[];
+    let verticalState: VerticalState[];
+    let verticalPanels: string = "";
+
+    // check data attribute exists
+    const groupKeys: string[] = [];
+    const groupPanels: Record<string, HTMLElement[]> = {};
+    const verticalCamera = document.createElement("div");
+    verticalCamera.classList.add(CLASS.CAMERA);
+
+    panels.forEach((panel) => {
+      const groupKey = getDataAttributes(panel, "data-flicking-").groupkey;
+      if (groupKey && !includes(groupKeys, groupKey)) {
+        groupKeys.push(groupKey);
+        groupPanels[groupKey] = [panel];
+      } else if (groupKey) {
+        groupPanels[groupKey].push(panel);
+      }
+      return groupKey;
+    });
+
+    if (groupKeys.length) {
+      panels.forEach(() => this.remove(0));
+      verticalState = groupKeys.reduce(
+        (state: VerticalState[], key: string) => {
           const start = state.length ? +state[state.length - 1].end + 1 : 0;
-          verticalPanels += child.children[0].innerHTML;
+          const element = groupPanels[key].reduce(
+            (el: HTMLElement, panel: HTMLElement) => {
+              verticalPanels += panel.outerHTML;
+              el.appendChild(panel);
+              return el;
+            },
+            document.createElement("div")
+          );
           return [
             ...state,
             {
+              key,
               start,
-              end: start + child.children[0].children.length - 1,
-              element: child,
+              end: start + groupPanels[key].length - 1,
+              element: element,
             },
           ];
         },
         []
       );
-      this.camera.children.forEach((child) => {
-        child.children[0].innerHTML = verticalPanels;
+
+      verticalCamera.innerHTML = verticalPanels;
+      cameraEl.innerHTML = "";
+      groupKeys.forEach(() => {
+        const panel = document.createElement("div");
+        panel.classList.add(CLASS.VIEWPORT, CLASS.VERTICAL);
+        panel.innerHTML = verticalCamera.outerHTML;
+        this.append(panel);
       });
-      this._verticalFlicking = this.camera.children.map((child, i) => {
-        return new Flicking(child, {
-          ...this.verticalOptions,
-          horizontal: false,
-          panelsPerView: 1,
-          defaultIndex: this._verticalState[i].start,
+    } else {
+      verticalState = panels.reduce(
+        (state: VerticalState[], panel: HTMLElement, i: number) => {
+          const start = state.length ? +state[state.length - 1].end + 1 : 0;
+          verticalPanels += panel.innerHTML;
+          return [
+            ...state,
+            {
+              key: i.toString(),
+              start,
+              end: start + panel.children.length - 1,
+              element: panel,
+            },
+          ];
+        },
+        []
+      );
+
+      verticalCamera.innerHTML = verticalPanels;
+      panels.forEach((panel) => {
+        [CLASS.VIEWPORT, CLASS.VERTICAL].forEach((className) => {
+          if (!panel.classList.contains(className)) {
+            panel.classList.add(className);
+          }
         });
+        panel.innerHTML = verticalCamera.outerHTML;
       });
+    }
 
-      this.on(EVENTS.HOLD_START, this._onHorizontalHoldStart);
-      this.on(EVENTS.MOVE, this._onHorizontalMove);
-      this.on(EVENTS.MOVE_END, this._onHorizontalMoveEnd);
+    return verticalState;
+  }
 
-      this._verticalFlicking.forEach((child) => {
-        child.on(EVENTS.HOLD_START, this._onVerticalHoldStart);
-        child.on(EVENTS.MOVE, this._onVerticalMove);
-        child.on(EVENTS.MOVE_END, this._onVerticalMoveEnd);
-        child.on(EVENTS.CHANGED, this._onVerticalChanged);
+  private _createVerticalFlicking(): Flicking[] {
+    return this.camera.children.map((panel, i) => {
+      return new Flicking(panel, {
+        ...this.verticalOptions,
+        horizontal: false,
+        panelsPerView: 1,
+        defaultIndex: this._verticalState[i].start,
       });
     });
   }

package/src/const/external.ts

@@ -94,6 +94,8 @@ export const MOVE_TYPE = {
 } as const;
 
 export const CLASS = {
+  VIEWPORT: "flicking-viewport",
+  CAMERA: "flicking-camera",
   VERTICAL: "vertical",
   HIDDEN: "flicking-hidden",
   DEFAULT_VIRTUAL: "flicking-panel"

package/src/utils.ts

@@ -349,3 +349,24 @@ export const setPrototypeOf = Object.setPrototypeOf || ((obj, proto) => {
   obj.__proto__ = proto;
   return obj;
 });
+
+export const camelize = (str: string): string => {
+  return str.replace(/[\s-_]([a-z])/g, (all, letter) => letter.toUpperCase());
+};
+
+export const getDataAttributes = (element: HTMLElement, attributePrefix: string): Record<string, string> => {
+  const dataAttributes: Record<string, string> = {};
+  const attributes = element.attributes;
+  const length = attributes.length;
+
+  for (let i = 0; i < length; ++i) {
+    const attribute = attributes[i];
+    const { name, value } = attribute;
+    if (name.indexOf(attributePrefix) === -1) {
+      continue;
+    }
+    dataAttributes[camelize(name.replace(attributePrefix, ""))] = value;
+  }
+
+  return dataAttributes;
+};