Flicking Logo
@egjs/flicking

version npm bundle size (scoped) Coveralls github DeepScan grade

GitHub commit activity npm downloads per month GitHub contributors GitHub

React Vue

Demo / Guide / API / Other components

Reliable, flexible and extendable carousel component.
πŸ“±πŸ’»πŸ–₯

-----
iPhone demo Music app demo Full page demo
Parallax demo
πŸ–±οΈClick each images to see its source or check our full demos.
## ✨ Features - **SSR ready** β€” works with [Next.js](https://nextjs.org/) and [Nuxt](https://nuxt.com/) - **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 ```bash $ 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. ```html
``` #### ES Modules ```ts import Flicking from "@egjs/flicking"; import "@egjs/flicking/dist/flicking.css"; const flicking = new Flicking("#my-flicking", { circular: true }); ``` #### With CDN ```html ``` ```js var flicking = new Flicking("#my-flicking", { circular: true }); ``` ## πŸ“¦ Packages This repository is a monorepo that contains Flicking and all its related packages. |Package|Version|Description| |:-----:|:-----:|:-----:| |[**@egjs/flicking**](https://github.com/naver/egjs-flicking/blob/master/packages/flicking/README.md)|version|Core carousel library| |[**@egjs/flicking-plugins**](https://github.com/naver/egjs-flicking/blob/master/packages/flicking-plugins/README.md)|version|Readymade effects for your carousel| |[**@egjs/react-flicking**](https://github.com/naver/egjs-flicking/blob/master/packages/react-flicking/README.md)|version|React [React](https://react.dev/) port of @egjs/flicking| |[**@egjs/vue3-flicking**](https://github.com/naver/egjs-flicking/blob/master/packages/vue3-flicking/README.md)|version|Vue.js [Vue 3](https://vuejs.org/) port of @egjs/flicking| ## 🌐 Supported Browsers |Chrome|Firefox|Safari|iOS|Android| |:---:|:---:|:---:|:---:|:---:| |Latest|Latest|Latest|7+|4+| ## πŸ€– 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](https://naver.github.io/egjs-flicking/docs/guide/llms) for how to feed Flicking's documentation to LLMs and AI agents. ## πŸ“– Documentation & Demos - [Demos](https://naver.github.io/egjs-flicking/docs/demos/basic/default) β€” includes an embedded **live code editor** for interactive exploration - [Guide](https://naver.github.io/egjs-flicking/docs/guide/quickstart) - [API](https://naver.github.io/egjs-flicking/docs/api/classes/Flicking) ## πŸ™Œ Contributing See [CONTRIBUTING.md](https://github.com/naver/egjs-flicking/blob/master/CONTRIBUTING.md). Please file issues on [GitHub](https://github.com/naver/egjs-flicking/issues). ## πŸ“œ License @egjs/flicking is released under the [MIT license](https://github.com/naver/egjs-flicking/blob/master/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. ```