@egjs/react-flicking

@egjs/react-flicking

React wrapper of @egjs/flicking

Demo / Documentation / Other components

⚙️ Installation

npm install --save @egjs/react-flicking

🏃 Quick Start

import { FlickingEvent, SelectEvent, ChangeEvent, NeedPanelEvent } from "@egjs/flicking";
import Flicking from "@egjs/react-flicking";
import { Parallax, Fade, AutoPlay } from "@egjs/flicking-plugins";

<Flicking
  tag = "div"
  viewportTag = "div"
  cameraTag = "div"
  onNeedPanel = {(e: NeedPanelEvent) => {}}
  onMoveStart = {(e: FlickingEvent) => {}}
  onMove = {(e: FlickingEvent) => {}}
  onMoveEnd = {(e: FlickingEvent) => {}}
  onHoldStart = {(e: FlickingEvent) => {}}
  onHoldEnd = {(e: FlickingEvent) => {}}
  onRestore = {(e: FlickingEvent) => {}}
  onSelect = {(e: SelectEvent) => {}}
  onChange = {(e: ChangeEvent) => {}}
  classPrefix = "eg-flick"
  deceleration = {0.0075}
  horizontal = {true}
  circular = {false}
  infinite = {false}
  infiniteThreshold = {0}
  lastIndex = {Infinity}
  threshold = {40}
  duration = {100}
  panelEffect = {x => 1 - Math.pow(1 - x, 3)}
  defaultIndex = {0}
  inputType = {["touch", "mouse"]}
  thresholdAngle = {45}
  bounce = {10}
  autoResize = {false}
  adaptive = {false}
  zIndex = {2000}
  bound = {false}
  overflow = {false}
  hanger = {"50%"}
  anchor = {"50%"}
  gap = {0}
  moveType = {{type: "snap", count: 1}}
  collectStatistics = {true}
>
  <div>panel 0</div>
  <div>panel 1</div>
  <div>panel 2</div>
</Flicking>

Collect statistics

Flicking applies Google Analytics (GA) to collect which features are useful to users. For example, the use of the freeScroll option, or the value of the gap option, and so on. Statistics also DO NOT contain any information that can identify an individual. Statistics on the usage will serve as basis for making better products. To disable GA, set the collectStatistics option to false as follows:

<Flicking collectStatistics = {false}/>

📦 Packages

You can use all plugins just like native @egjs/flicking.

Check @egjs/flicking-plugins for readymade effects we're providing.

📖 More Examples

See our code sandbox examples.

🙌 Contributing

See CONTRIBUTING.md.

📝 Feedback

Please file an Issue with label "React".

📜 License

egjs-flicking is released under the MIT license.

Copyright (c) 2015-present NAVER Corp.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.