README.md

@egjs/react-flicking

React wrapper of @egjs/flicking

Demo / Documentation / Other components

⚙️ Installation

npm install --save @egjs/react-flicking

🏃 Quick Start

import Flicking, { MoveEvent, WillChangeEvent } from "@egjs/react-flicking";

<Flicking
  viewportTag="div"
  cameraTag="div"
  cameraClass=""
  renderOnSameKey={false}
  align="center"
  onMove={(e: MoveEvent) => {}}
  onWillChange={(e: WillChangeEvent) => {}}
  horizontal={true}
  circular={true}
>
  <div>panel 0</div>
  <div>panel 1</div>
  <div>panel 2</div>
</Flicking>

✨ React exclusive options

• viewportTag: HTML tag for .flicking-viewport element. (default: "div")
• cameraTag: HTML tag for .flicking-camera element. (default: "div")
• cameraClass: className for .flicking-camera element. (default: "")
• renderOnSameKey: Whether to always render children even they have the same keys (default: false)
  • Flicking doesn't rerender when children have same length & keys for performance by default.
  • If you have to bypass this behavior, like when you have to update panel's innerHTML without changing the list of child elements, you can either set this option to true, or you can call Flicking component's forceUpdate().

📦 Packages

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

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

📖 More Options & Examples

Options / Demos

🙌 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.