@egjs/flicking 4.12.0-beta.0 → 4.12.0-beta.10

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@egjs/flicking",
-	"version": "4.12.0-beta.0",
+	"version": "4.12.0-beta.10",
 	"description": "Everyday 30 million people experience. It's reliable, flexible and extendable carousel.",
 	"main": "dist/flicking.cjs.js",
 	"module": "dist/flicking.esm.js",
@@ -12,7 +12,8 @@
 	"types": "declaration/index.d.ts",
 	"scripts": {
 		"start": "concurrently \"rollup -w --config ./rollup.config.dev.js\" \"http-serve\"",
-		"build": "run-s build:bundle build:declaration build:css printsizes",
+		"build": "run-s build:bundle build:declaration printsizes",
+    "build-react": "run-s build:bundle build:declaration && pvu --build=react-flicking",
 		"build:bundle": "rm -rf ./dist && rollup -c",
 		"build:declaration": "rm -rf ./declaration && tsc -p tsconfig.declaration.json",
 		"build:css": "run-s build:css-clear build:sass build:css-prefix build:css-min",

package/sass/flicking.sass

@@ -2,9 +2,16 @@
   position: relative
   overflow: hidden
   &.vertical
+    display: -webkit-inline-box
+    display: -ms-inline-flexbox
     display: inline-flex
     >.flicking-camera
+      display: -webkit-inline-box
+      display: -ms-inline-flexbox
       display: inline-flex
+      -webkit-box-orient: vertical
+      -webkit-box-direction: normal
+      -ms-flex-direction: column
       flex-direction: column
   &.flicking-hidden
     >.flicking-camera
@@ -14,10 +21,16 @@
 .flicking-camera
   width: 100%
   height: 100%
+  display: -webkit-box
+  display: -ms-flexbox
   display: flex
   position: relative
+  -webkit-box-orient: horizontal
+  -webkit-box-direction: normal
+  -ms-flex-direction: row
   flex-direction: row
   z-index: 1
   will-change: transform
   >*
+    -ms-flex-negative: 0
     flex-shrink: 0

package/src/CrossFlicking.ts

@@ -0,0 +1,439 @@
+/*
+ * Copyright (c) 2015 NAVER Corp.
+ * egjs projects are licensed under the MIT license
+ */
+import { ComponentEvent } from "@egjs/component";
+import { EventKey } from "@egjs/component/declaration/types";
+
+import Flicking, { FlickingEvents, FlickingOptions } from "./Flicking";
+import {
+  ChangedEvent,
+  HoldEndEvent,
+  HoldStartEvent,
+  MoveEndEvent,
+  MoveEvent,
+  MoveStartEvent,
+  WillChangeEvent
+} from "./type/event";
+import { LiteralUnion, ValueOf } from "./type/internal";
+import { CLASS, EVENTS, MOVE_DIRECTION } from "./const/external";
+import { getDataAttributes, includes, toArray } from "./utils";
+
+export const SIDE_EVENTS = {
+  HOLD_START: "sideHoldStart",
+  HOLD_END: "sideHoldEnd",
+  MOVE_START: "sideMoveStart",
+  MOVE: "sideMove",
+  MOVE_END: "sideMoveEnd",
+  WILL_CHANGE: "sideWillChange",
+  CHANGED: "sideChanged"
+} as const;
+
+export type CrossFlickingEvent<T> = { mainIndex: number } & T;
+
+export interface CrossFlickingEvents extends FlickingEvents {
+  [SIDE_EVENTS.HOLD_START]: CrossFlickingEvent<HoldStartEvent>;
+  [SIDE_EVENTS.HOLD_END]: CrossFlickingEvent<HoldEndEvent>;
+  [SIDE_EVENTS.MOVE_START]: CrossFlickingEvent<MoveStartEvent>;
+  [SIDE_EVENTS.MOVE]: CrossFlickingEvent<MoveEvent>;
+  [SIDE_EVENTS.MOVE_END]: CrossFlickingEvent<MoveEndEvent>;
+  [SIDE_EVENTS.WILL_CHANGE]: CrossFlickingEvent<WillChangeEvent>;
+  [SIDE_EVENTS.CHANGED]: CrossFlickingEvent<ChangedEvent>;
+}
+
+export interface CrossFlickingOptions extends FlickingOptions {
+  sideOptions: Partial<FlickingOptions> | undefined;
+  preserveIndex: boolean | undefined;
+  disableSlideOnHold: boolean | undefined;
+  disableIndexSync: boolean | undefined;
+}
+
+export interface SideState {
+  key: string;
+  start: number;
+  end: number;
+  element: HTMLElement;
+}
+
+export class CrossFlicking extends Flicking {
+  // Core components
+  private _sideFlicking: Flicking[];
+
+  // Options
+  private _sideOptions: CrossFlickingOptions["sideOptions"];
+  private _preserveIndex: CrossFlickingOptions["preserveIndex"];
+  private _disableSlideOnHold: CrossFlickingOptions["disableSlideOnHold"];
+  private _disableIndexSync: CrossFlickingOptions["disableIndexSync"];
+
+  // Internal State
+  private _sideState: SideState[];
+  private _moveDirection: LiteralUnion<ValueOf<typeof MOVE_DIRECTION>> | null;
+  private _originalDragThreshold: number;
+  private _nextIndex: number;
+
+  // Components
+  public get sideFlicking() {
+    return this._sideFlicking;
+  }
+
+  public get sideState() {
+    return this._sideState;
+  }
+
+  // Options Getter
+  public get sideOptions() { return this._sideOptions; }
+
+  public get preserveIndex() { return this._preserveIndex; }
+
+  public get disableSlideOnHold() { return this._disableSlideOnHold; }
+
+  public get disableIndexSync() { return this._disableIndexSync; }
+
+  // Options Setter
+  public set sideOptions(val: CrossFlickingOptions["sideOptions"]) {
+    this._sideOptions = val;
+  }
+
+  public set preserveIndex(val: CrossFlickingOptions["preserveIndex"]) {
+    this._preserveIndex = val;
+  }
+
+  public set disableSlideOnHold(val: CrossFlickingOptions["disableSlideOnHold"]) {
+    this._disableSlideOnHold = val;
+  }
+
+  public set disableIndexSync(val: CrossFlickingOptions["disableIndexSync"]) {
+    this._disableIndexSync = val;
+  }
+
+  public constructor(
+    root: HTMLElement | string,
+    options: Partial<CrossFlickingOptions>
+  ) {
+    super(root, options);
+    const {
+      sideOptions = {},
+      preserveIndex = true,
+      disableSlideOnHold = true,
+      disableIndexSync = false
+    } = options;
+
+    // Internal states
+    this._moveDirection = null;
+    this._nextIndex = 0;
+    this._originalDragThreshold = this.dragThreshold;
+
+    // Bind options
+    this._sideOptions = sideOptions;
+    this._preserveIndex = preserveIndex;
+    this._disableSlideOnHold = disableSlideOnHold;
+    this._disableIndexSync = disableIndexSync;
+  }
+
+  public init(): Promise<void> {
+    return super.init().then(() => {
+      this._sideState = this._createSideState();
+      this._sideFlicking = this._createSideFlicking();
+      this._addComponentEvents();
+    });
+  }
+
+  public destroy(): void {
+    this._sideFlicking.forEach((flicking) => {
+      flicking.destroy();
+    });
+    super.destroy();
+  }
+
+  private _addComponentEvents(): void {
+    this.on(EVENTS.HOLD_START, this._onHorizontalHoldStart);
+    this.on(EVENTS.MOVE, this._onHorizontalMove);
+    this.on(EVENTS.MOVE_END, this._onHorizontalMoveEnd);
+
+    this._sideFlicking.forEach((flicking, mainIndex) => {
+      flicking.on(EVENTS.HOLD_START, this._onSideHoldStart);
+      flicking.on(EVENTS.MOVE, this._onSideMove);
+      flicking.on(EVENTS.MOVE_END, this._onSideMoveEnd);
+      flicking.on(EVENTS.CHANGED, this._onSideChanged);
+
+      Object.keys(SIDE_EVENTS).forEach((name: EventKey<FlickingEvents>) => {
+        flicking.on(EVENTS[name], (event) => {
+          this.trigger(
+            new ComponentEvent(SIDE_EVENTS[name], {
+              mainIndex,
+              ...event
+            })
+          );
+        });
+      });
+    });
+  }
+
+  private _createSideState(): SideState[] {
+    const viewportEl = this.element;
+    const cameraEl = this.camera.element;
+    const panels = toArray(cameraEl.children) as HTMLElement[];
+    const isCrossStructure = getDataAttributes(
+      viewportEl,
+      "data-cross-"
+    ).structure;
+    let sideState: SideState[] = [];
+
+    if (!isCrossStructure) {
+      const groupPanels = this._getGroupFromAttribute(panels);
+      const groupKeys = Object.keys(groupPanels);
+
+      if (groupKeys.length) {
+        sideState = this._getSideStateFromGroup(groupPanels);
+        this.remove(0, this.panelCount - groupKeys.length);
+      } else {
+        sideState = this._getSideStateFromPanels(panels);
+      }
+
+      this._createCrossStructure(sideState);
+    } else {
+      sideState = this._getSideStateFromCrossStructure(panels);
+    }
+
+    void this.resize();
+
+    return sideState;
+  }
+
+  private _createCrossStructure(sideState: SideState[]) {
+    const sideCamera = document.createElement("div");
+    let sidePanels: string = "";
+
+    sideCamera.classList.add(CLASS.CAMERA);
+    sideState.forEach((state, i) => {
+      const panel = this.camera.children[i];
+      sidePanels += state.element.innerHTML;
+      Array.from(panel.attributes).forEach((attribute) =>
+        panel.removeAttribute(attribute.name)
+      );
+    });
+
+    sideCamera.innerHTML = sidePanels;
+
+    sideState.forEach((_, i) => {
+      const panel = this.camera.children[i];
+      [CLASS.VIEWPORT, CLASS.VERTICAL].forEach((className) => {
+        if (!panel.classList.contains(className)) {
+          panel.classList.add(className);
+        }
+      });
+      panel.innerHTML = sideCamera.outerHTML;
+    });
+
+    this.element.setAttribute("data-cross-structure", "true");
+  }
+
+  private _getGroupFromAttribute(
+    panels: HTMLElement[]
+  ): Record<string, HTMLElement[]> {
+    const groupKeys: string[] = [];
+    const groupPanels: Record<string, HTMLElement[]> = {};
+
+    panels.forEach((panel) => {
+      const groupKey = getDataAttributes(panel, "data-cross-").groupkey;
+      if (groupKey && !includes(groupKeys, groupKey)) {
+        groupKeys.push(groupKey);
+        groupPanels[groupKey] = [panel];
+      } else if (groupKey) {
+        groupPanels[groupKey].push(panel);
+      }
+    });
+
+    return groupPanels;
+  }
+
+  private _getSideStateFromGroup(
+    groupPanels: Record<string, HTMLElement[]>
+  ): SideState[] {
+    return Object.keys(groupPanels).reduce(
+      (state: SideState[], key: string) => {
+        const start = state.length ? +state[state.length - 1].end + 1 : 0;
+        const element = groupPanels[key].reduce(
+          (el: HTMLElement, panel: HTMLElement) => {
+            el.innerHTML += panel.outerHTML;
+            return el;
+          },
+          document.createElement("div")
+        );
+        return [
+          ...state,
+          {
+            key,
+            start,
+            end: start + groupPanels[key].length - 1,
+            element: element
+          }
+        ];
+      },
+      []
+    );
+  }
+
+  private _getSideStateFromPanels(panels: HTMLElement[]): SideState[] {
+    return panels.reduce(
+      (state: SideState[], panel: HTMLElement, i: number) => {
+        const start = state.length ? +state[state.length - 1].end + 1 : 0;
+        return [
+          ...state,
+          {
+            key: i.toString(),
+            start,
+            end: start + panel.children.length - 1,
+            element: panel
+          }
+        ];
+      },
+      []
+    );
+  }
+
+  private _getSideStateFromCrossStructure(panels: HTMLElement[]): SideState[] {
+    const groupPanels = this._getGroupFromAttribute(panels);
+    return this._getSideStateFromGroup(groupPanels);
+  }
+
+  private _createSideFlicking(): Flicking[] {
+    return this.sideState.map((state, i) => {
+      return new Flicking(this.camera.children[i], {
+        ...this.sideOptions,
+        horizontal: false,
+        panelsPerView: 1,
+        defaultIndex: state.start
+      });
+    });
+  }
+
+  private _syncToCategory = (index: number, outerIndex: number): void => {
+    if (this._disableIndexSync) {
+      return;
+    }
+
+    this.stopAnimation();
+    this._sideFlicking.forEach((child, i) => {
+      const { start, end } = this._sideState[i];
+
+      if (start <= index && end >= index && outerIndex !== i) {
+        child.stopAnimation();
+        void child.moveTo(index, 0);
+        void this.moveTo(i, 0);
+      }
+    });
+  };
+
+  private _setDraggable = (
+    direction: ValueOf<typeof MOVE_DIRECTION>,
+    draggable: boolean
+  ): void => {
+    if (!this._disableSlideOnHold) {
+      return;
+    }
+
+    const dragThreshold = this._originalDragThreshold;
+    const threshold = draggable
+      ? dragThreshold && dragThreshold >= 10
+        ? dragThreshold
+        : 10
+      : Infinity;
+
+    if ((direction === MOVE_DIRECTION.HORIZONTAL) === this.horizontal) {
+      this.dragThreshold = threshold;
+    } else if ((direction === MOVE_DIRECTION.VERTICAL) === this.horizontal) {
+      this._sideFlicking.forEach((child) => {
+        child.dragThreshold = threshold;
+      });
+    }
+  };
+
+  private _setPreviousSideIndex = () => {
+    this._sideFlicking.forEach((child, i) => {
+      const { start, end } = this._sideState[i];
+
+      if (this._preserveIndex) {
+        if (this._nextIndex !== i) {
+          if (child.index < start) {
+            child.stopAnimation();
+            void child.moveTo(start, 0);
+          } else if (child.index > end) {
+            child.stopAnimation();
+            void child.moveTo(end, 0);
+          }
+        }
+      } else {
+        if (this._nextIndex !== i) {
+          void child.moveTo(start, 0);
+        }
+      }
+    });
+  };
+
+  private _onHorizontalHoldStart = (): void => {
+    this._setDraggable(MOVE_DIRECTION.HORIZONTAL, true);
+    this._moveDirection = null;
+  };
+
+  private _onHorizontalMove = (e: MoveEvent): void => {
+    if (e.isTrusted && !this._moveDirection) {
+      this._setDraggable(MOVE_DIRECTION.VERTICAL, false);
+      this._moveDirection = MOVE_DIRECTION.HORIZONTAL;
+    }
+  };
+
+  private _onHorizontalMoveEnd = (e: MoveEndEvent): void => {
+    const visiblePanels = this.visiblePanels;
+
+    if (visiblePanels.length > 1) {
+      this._nextIndex =
+        e.direction === "NEXT"
+          ? visiblePanels[1].index
+          : visiblePanels[0].index;
+    } else {
+      this._nextIndex = visiblePanels[0].index;
+    }
+
+    this._setDraggable(MOVE_DIRECTION.VERTICAL, true);
+    this._moveDirection = null;
+
+    // _syncToCategory에서 완전히 가로 이동이 이루어지기 전에 세로 방향 index가 변하는 경우가 있어 requestAnimationFrame 처리
+    requestAnimationFrame(() => this._setPreviousSideIndex());
+
+    if (e.isTrusted) {
+      this._syncToCategory(
+        this._sideFlicking[this._nextIndex].index,
+        this._nextIndex
+      );
+    }
+  };
+
+  private _onSideHoldStart = (): void => {
+    this._setDraggable(MOVE_DIRECTION.VERTICAL, true);
+    this._moveDirection = null;
+  };
+
+  private _onSideMove = (e: MoveEvent): void => {
+    if (e.isTrusted && !this._moveDirection) {
+      this._setDraggable(MOVE_DIRECTION.HORIZONTAL, false);
+      this._moveDirection = MOVE_DIRECTION.VERTICAL;
+    }
+  };
+
+  private _onSideMoveEnd = (): void => {
+    this._setDraggable(MOVE_DIRECTION.HORIZONTAL, true);
+    this._moveDirection = null;
+  };
+
+  private _onSideChanged = (e: ChangedEvent): void => {
+    // If this.visiblePanels.length >= 2, it means that horizontal flicking is being dragged.
+    // In this case, syncToCategory in _onHorizontalMoveEnd will fire after moving finishes, so we don't fire it here.
+    if (
+      this.visiblePanels.length < 2 &&
+      this._sideFlicking[this.index] === e.currentTarget
+    ) {
+      this._syncToCategory(e.index, this.index);
+    }
+  };
+}

package/src/camera/Camera.ts

@@ -32,6 +32,7 @@ class Camera {
   private _mode: CameraMode;
   private _el: HTMLElement;
   private _transform: string;
+  private _lookedOffset = 0;
   private _position: number;
   private _alignPos: number;
   private _offset: number;
@@ -292,6 +293,8 @@ class Camera {
    * @return {this}
    */
   public lookAt(pos: number): void {
+    const prevOffset = this._offset;
+    const isChangedOffset = this._lookedOffset !== prevOffset;
     const flicking = getFlickingAttached(this._flicking);
     const prevPos = this._position;
 
@@ -304,7 +307,12 @@ class Camera {
     if (toggled) {
       void flicking.renderer.render().then(() => {
         this.updateOffset();
+        this._lookedOffset = this._offset;
       });
+    } else if (isChangedOffset) {
+      // sync offset for renderOnlyVisible on resize
+      this.updateOffset();
+      this._lookedOffset = this._offset;
     } else {
       this.applyTransform();
     }
@@ -502,8 +510,8 @@ class Camera {
   }
 
   /**
-   * Update Viewport's height to active panel's height
-   * @ko 현재 선택된 패널의 높이와 동일하도록 뷰포트의 높이를 업데이트합니다
+   * Update Viewport's height to visible panel's max height
+   * @ko 현재 활성화된 패널과 보이는 패널의 최대 높이와 동일하도록 뷰포트의 높이를 업데이트합니다
    * @throws {FlickingError}
    * {@link ERROR_CODE NOT_ATTACHED_TO_FLICKING} When {@link Camera#init init} is not called before
    * <ko>{@link ERROR_CODE NOT_ATTACHED_TO_FLICKING} {@link Camera#init init}이 이전에 호출되지 않은 경우</ko>
@@ -513,11 +521,22 @@ class Camera {
   public updateAdaptiveHeight() {
     const flicking = getFlickingAttached(this._flicking);
     const activePanel = flicking.control.activePanel;
+    const visiblePanels = flicking.visiblePanels;
+
+    const selectedPanels = [...visiblePanels];
+
+    if (activePanel) {
+      selectedPanels.push(activePanel);
+    }
+
+    if (!flicking.horizontal || !flicking.adaptive || !selectedPanels.length) return;
+
+
+    const maxHeight = Math.max(...selectedPanels.map(panel => panel.height));
 
-    if (!flicking.horizontal || !flicking.adaptive || !activePanel) return;
 
     flicking.viewport.setSize({
-      height: activePanel.height
+      height: maxHeight
     });
   }
 
@@ -599,6 +618,7 @@ class Camera {
 
   private _resetInternalValues() {
     this._position = 0;
+    this._lookedOffset = 0;
     this._alignPos = 0;
     this._offset = 0;
     this._circularOffset = 0;

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"
@@ -122,3 +124,15 @@ export const ORDER = {
   LTR: "ltr",
   RTL: "rtl"
 } as const;
+
+/**
+ * An object that contains the direction that {@link Flicking} is moving
+ * @ko {@link Flicking}이 움직이는 방향을 담고 있는 객체
+ * @type {object}
+ * @property {"horizontal"} HORIZONTAL horizontal<ko>수평 방향</ko>
+ * @property {"vertical"} VERTICAL vertical<ko>수직 방향</ko>
+ */
+export const MOVE_DIRECTION = {
+  HORIZONTAL: "horizontal",
+  VERTICAL: "vertical"
+} as const;

package/src/index.ts

@@ -4,6 +4,9 @@
  */
 import Flicking from "./Flicking";
 import type { FlickingOptions, FlickingEvents } from "./Flicking";
+import type { CrossFlickingOptions } from "./CrossFlicking";
+
+export * from "./CrossFlicking";
 
 export * from "./core";
 export * from "./camera";
@@ -15,6 +18,6 @@ export * from "./utils";
 
 export * from "./type/event";
 export * from "./type/external";
-export type { FlickingOptions, FlickingEvents };
+export type { FlickingOptions, FlickingEvents, CrossFlickingOptions };
 
 export default Flicking;

package/src/index.umd.ts

@@ -3,6 +3,7 @@
  * egjs projects are licensed under the MIT license
  */
 import Flicking from "./Flicking";
+import * as CrossFlicking from "./CrossFlicking";
 import * as Core from "./core";
 import * as Camera from "./camera";
 import * as Control from "./control";
@@ -19,5 +20,6 @@ merge(Flicking, Renderer);
 merge(Flicking, Constants);
 merge(Flicking, CFC);
 merge(Flicking, Utils);
+merge(Flicking, CrossFlicking);
 
 export default Flicking;

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;
+};

package/dist/flicking-inline.css

@@ -1,45 +0,0 @@
-.flicking-viewport {
-  position: relative;
-  overflow: hidden;
-}
-
-.flicking-viewport:not(.vertical) {
-  width: 100%;
-  height: 100%;
-}
-
-.flicking-viewport.vertical,
-.flicking-viewport.vertical > .flicking-camera {
-  display: inline-block;
-}
-
-.flicking-viewport.vertical.middle > .flicking-camera > * {
-  vertical-align: middle;
-}
-
-.flicking-viewport.vertical.bottom > .flicking-camera > * {
-  vertical-align: bottom;
-}
-
-.flicking-viewport.vertical > .flicking-camera > * {
-  display: block;
-}
-
-.flicking-viewport.flicking-hidden > .flicking-camera > * {
-  visibility: hidden;
-}
-
-.flicking-camera {
-  width: 100%;
-  height: 100%;
-  position: relative;
-  z-index: 1;
-  white-space: nowrap;
-  will-change: transform;
-}
-
-.flicking-camera > * {
-  display: inline-block;
-  white-space: normal;
-  vertical-align: top;
-}

package/dist/flicking-inline.min.css

@@ -1 +0,0 @@
-.flicking-viewport{position:relative;overflow:hidden}.flicking-viewport:not(.vertical){width:100%;height:100%}.flicking-viewport.vertical,.flicking-viewport.vertical>.flicking-camera{display:inline-block}.flicking-viewport.vertical.middle>.flicking-camera>*{vertical-align:middle}.flicking-viewport.vertical.bottom>.flicking-camera>*{vertical-align:bottom}.flicking-viewport.vertical>.flicking-camera>*{display:block}.flicking-viewport.flicking-hidden>.flicking-camera>*{visibility:hidden}.flicking-camera{width:100%;height:100%;position:relative;z-index:1;white-space:nowrap;will-change:transform}.flicking-camera>*{display:inline-block;white-space:normal;vertical-align:top}