@egjs/flicking

Demo / Documentation / Other components

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

Supported Frameworks

-----

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

- Easy-to-use and performant infinite carousel(slider). - You can use 3 [options](https://naver.github.io/egjs-flicking/release/latest/doc/eg.Flicking.html#.FlickingOptions)(`renderOnlyVisible`, `isEqualsSize`, `isConstantSize`) to make your carousel more performant. - Check the effect! ⇒ [https://www.youtube.com/watch?v=R-DKq-fqeSI](https://www.youtube.com/watch?v=R-DKq-fqeSI) - Every options are compatible with each others. - Except for mutual exclusive options (like `circular` and `bound`). - Provides various scroll movement types that you can choose. - Ready-to-use plugins you can grab right away. - Supports all major frameworks(Angular, React, Vue). ## ⚙️ 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 #### Typescript ```ts import Flicking from "@egjs/flicking"; const flicking = new Flicking("#el", { circular: true }); ``` #### Browser ```html ``` ```js var flicking = new eg.Flicking("#el", { circular: true }); ``` #### DOM Structure ⚠️ NOTICE: Flicking requires minimal structure to initialize properly. As Flicking applies `position: absolute` for panels, either wrapper or panel should have fixed height value. ✅ ```html

``` ```html

``` ❌ ```html

``` #### Collect statistics Flicking applies Google Analytics (GA) to collect which features are useful to users. For example, the use of the `freeScroll` option, or the value of the `gap` option, and so on. Statistics also DO NOT contain any information that can identify an individual. Statistics on the usage will serve as basis for making better products. To disable GA, set the `collectStatistics` option to `false` as follows: ```js var flicking = new eg.Flicking("#el", { collectStatistics: false }); ``` ## 📦 Packages |Package|Version|Description| |:-----:|:-----:|:-----:| |[**@egjs/flicking-plugins**](https://github.com/naver/egjs-flicking-plugins)|

|Readymade effects for your carousel| |[**@egjs/ngx-flicking**](https://github.com/naver/egjs-flicking/blob/master/packages/ngx-flicking/README.md)|

[Angular](https://angular.io/) port of @egjs/flicking| |[**@egjs/react-flicking**](https://github.com/naver/egjs-flicking/blob/master/packages/react-flicking/README.md)|

[React](https://reactjs.org/) port of @egjs/flicking| |[**@egjs/vue-flicking**](https://github.com/naver/egjs-flicking/blob/master/packages/vue-flicking/README.md)|

[Vue.js](https://vuejs.org/v2/guide/index.html) port of @egjs/flicking| ## 🌐 Supported Browsers |

| |:---:|:---:|:---:|:---:|:---:|:---:| |10+|Latest|Latest|Latest|7+|4+| ## 📼 Demos Check our [Demos](https://naver.github.io/egjs-flicking/). ## 📖 Documentation See [Documentation](https://naver.github.io/egjs-flicking/release/latest/doc/index.html) page. ## 🙌 Contributing See [CONTRIBUTING.md](https://github.com/naver/egjs-flicking/blob/master/CONTRIBUTING.md). ## 📝 Feedback Please file an [Issue](https://github.com/naver/egjs-flicking/issues). ## 🛣️ Roadmap See our [Roadmap](https://github.com/naver/egjs-flicking/issues?utf8=%E2%9C%93&q=is%3Aissue+label%3A%F0%9F%9B%A3%EF%B8%8FRoadmap+). ## 📜 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. ```