♻️ Everyday 30 million people experience. It's reliable, flexible and extendable carousel.
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](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)|
|Core carousel library|
|[**@egjs/flicking-plugins**](https://github.com/naver/egjs-flicking/blob/master/packages/flicking-plugins/README.md)|
|Readymade effects for your carousel|
|[**@egjs/react-flicking**](https://github.com/naver/egjs-flicking/blob/master/packages/react-flicking/README.md)|
| [React](https://react.dev/) port of @egjs/flicking|
|[**@egjs/vue3-flicking**](https://github.com/naver/egjs-flicking/blob/master/packages/vue3-flicking/README.md)|
| [Vue 3](https://vuejs.org/) port of @egjs/flicking|
## Supported Browsers
||||||
|:---:|:---:|:---:|:---:|:---:|
|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).
```
…
```