Flicking

Reliable, flexible and extendable carousel

README

Flicking Logo
@egjs/flicking

version npm bundle size (scoped) Coveralls github DeepScan grade

GitHub commit activity npm downloads per month GitHub contributors GitHub

Angular React Vue Preact Svelte

Demo / Documentation / Other components

Everyday 30 million people experience. It's reliable, flexible and extendable carousel.
📱💻🖥

Supported Frameworks
AngularJS   React   Vue.js   Preact   Svelte


iPhone demo Music app demo Full page demo
Parallax demo
🖱️Click each images to see its source or check our full demos.

✨ Features

- Use it in a framework you like.
  - We supports all major JS frameworks like React, Vue, Angular
- SSR(Server Side Rendering) ready
  - You can use Flicking at your favorite SSR frameworks like Next.js or Nuxt.js.
- Circular(Loop) Mode
- Ready-to-use plugins you can grab right away.
  - Autoplay, Fade effect, Parallax effect, ...
- Restore state like position and active slide with persist
- You can make native-scroll like UI with bound and moveType: freeScroll
- Supports both Desktop & Mobile
- Rich API
- Supports IE9+ with the polyfill

⚙️ Installation

npm

  1. ``` sh
  2. $ npm install --save @egjs/flicking
  3. ```

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.


  1. ``` html
  2. <div id="my-flicking" class="flicking-viewport">
  3.   <div class="flicking-camera">
  4.     <div class="panel"></div>
  5.     <div class="panel"></div>
  6.     <div class="panel"></div>
  7.   </div>
  8. </div>
  9. ```

ES Modules

  1. ```ts
  2. import Flicking from "@egjs/flicking";
  3. // import styles
  4. import "@egjs/flicking/dist/flicking.css"; // Supports IE10+, using CSS flex
  5. // Or...
  6. import "@egjs/flicking/dist/flicking.inline.css"; //Supports IE9+, using CSS inline-box

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

With CDN

  1. ``` html
  2. <script src="https://unpkg.com/@egjs/flicking@4.0.0-beta.4/dist/flicking.pkgd.min.js"></script>
  3. <link rel="stylesheet" href="https://unpkg.com/@egjs/flicking@4.0.0/dist/flicking.css">
  4. ```
  1. ``` js
  2. var flicking = new Flicking("#my-flicking", { circular: true });
  3. ```

📦 Packages

|Package|Version|Description|
|:-----:|:-----:|:-----:|
|[**@egjs/flicking-plugins**](https://github.com/naver/egjs-flicking-plugins)|version|Readymade effects for your carousel||[**@egjs/ngx-flicking**](https://github.com/naver/egjs-flicking/blob/master/packages/ngx-flicking/README.md)|version|Angular [Angular](https://angular.io/) port of @egjs/flicking||[**@egjs/react-flicking**](https://github.com/naver/egjs-flicking/blob/master/packages/react-flicking/README.md)|version|React [React](https://reactjs.org/) port of @egjs/flicking||[**@egjs/vue-flicking**](https://github.com/naver/egjs-flicking/blob/master/packages/vue-flicking/README.md)|version|Vue.js [Vue.js@2](https://vuejs.org/v2/guide/index.html) port of @egjs/flicking||[**@egjs/vue3-flicking**](https://github.com/naver/egjs-flicking/blob/master/packages/vue3-flicking/README.md)|version|Vue.js [Vue.js@3](https://v3.vuejs.org/) port of @egjs/flicking||[**@egjs/preact-flicking**](https://github.com/naver/egjs-flicking/blob/master/packages/preact-flicking/README.md)|version|Preact [Preact](https://preactjs.com/guide/v10/getting-started) port of @egjs/flicking||[**@egjs/svelte-flicking**](https://github.com/naver/egjs-flicking/blob/master/packages/svelte-flicking/README.md)|version|Svelte [Svelte](https://svelte.dev/) port of @egjs/flicking|

🌐 Supported Browsers

|IE|Chrome|Firefox|Safari|iOS|Android|
|:---:|:---:|:---:|:---:|:---:|:---:|
|9+(With polyfill), 11+ for Angular & Svelte|Latest|Latest|Latest|7+|4+|

📼 Demos

Check our Demos.

📖 Documentation

See Documentation page.

🙌 Contributing


📝 Feedback

Please file an Issue.

🛣️ Roadmap

See our Roadmap.

📜 License

@egjs/flicking is released under the MIT license.

  1. ```
  2. Copyright (c) 2015-present NAVER Corp.
  3. Permission is hereby granted, free of charge, to any person obtaining a copy
  4. of this software and associated documentation files (the "Software"), to deal
  5. in the Software without restriction, including without limitation the rights
  6. to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  7. copies of the Software, and to permit persons to whom the Software is
  8. furnished to do so, subject to the following conditions:
  9. The above copyright notice and this permission notice shall be included in
  10. all copies or substantial portions of the Software.
  11. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  12. IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  13. FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
  14. AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  15. LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  16. OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  17. THE SOFTWARE.
  18. ```