@egjs/flicking

Demo / Guide / API / Other components

Reliable, flexible and extendable carousel component.
📱💻🖥

---

🖱️Click each images to see its source or check our full demos.

✨ Features

• SSR ready — works with Next.js and Nuxt
• Circular mode — seamless infinite loop
• Free scroll — momentum-based native scroll experience
• Virtual scroll — render only visible panels for large datasets
• Plugins — AutoPlay, Fade, Parallax, Arrow, Pagination via @egjs/flicking-plugins
• TypeScript — fully typed API

⚙️ Installation

npm

$ npm install --save @egjs/flicking

CDN

• jsDelivr: https://cdn.jsdelivr.net/npm/@egjs/flicking/dist/
• unpkg: https://unpkg.com/@egjs/flicking/dist/
• cdnjs: https://cdnjs.com/libraries/egjs-flicking

🏃 Quick Start

HTML

Flicking requires minimal structure to initialize properly.

You don't need to consider this when using Flicking with the frameworks.

<div id="my-flicking" class="flicking-viewport">
  <div class="flicking-camera">
    <div class="panel"></div>
    <div class="panel"></div>
    <div class="panel"></div>
  </div>
</div>

ES Modules

import Flicking from "@egjs/flicking";
import "@egjs/flicking/dist/flicking.css";

const flicking = new Flicking("#my-flicking", { circular: true });

With CDN

<!-- Packaged with all dependencies -->
<script src="https://unpkg.com/@egjs/flicking/dist/flicking.pkgd.min.js"></script>
<link rel="stylesheet" href="https://unpkg.com/@egjs/flicking/dist/flicking.css">

var flicking = new Flicking("#my-flicking", { circular: true });

📦 Packages

This repository is a monorepo that contains Flicking and all its related packages.

🌐 Supported Browsers

🤖 AI Native

egjs is investing in an AI-native development experience — use-case-centered documentation, stronger TypeScript types, clearer error messages, and predictable internals to help both humans and AI agents use Flicking correctly.

See the llms.txt guide for how to feed Flicking's documentation to LLMs and AI agents.

📖 Documentation & Demos

• Demos — includes an embedded live code editor for interactive exploration
• Guide
• API

🙌 Contributing

See CONTRIBUTING.md. Please file issues on GitHub.

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