egjs-flicking

by naver

🎠 ♻️ Everyday 30 million people experience. It's reliable, flexible and extendable carousel.

544 Stars 48 Forks Last release: about 1 month ago (3.5.1) MIT License 572 Commits 34 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Flicking Logo
@egjs/flicking

version npm bundle size (scoped) Travis (.org) Coveralls github GitHub commit activity npm downloads per month GitHub contributors GitHub Angular React Vue DeepScan grade

Demo / Documentation / Other components

Everyday 30 million people experience. It's reliable, flexible and extendable carousel.
πŸ“±πŸ’»πŸ–₯

Translations: πŸ‡ΊπŸ‡Έ πŸ‡°πŸ‡·

Supported Frameworks
AngularJS   React   Vue.js


iPhone demo Music app demo Full page demo
Parallax demo
Cabinet demo
πŸ–±οΈClick each images to see its source or check our full demos.

  • Easy-to-use and performant infinite carousel(slider).
  • 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

$ 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

import Flicking from "@egjs/flicking";

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

Browser

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:
var flicking = new eg.Flicking("#el", { collectStatistics: false });

πŸ“¦ Packages

|Package|Version|Description| |:-----:|:-----:|:-----:| |@egjs/flicking-plugins|version|Readymade effects for your carousel| |@egjs/ngx-flicking|version|Angular Angular port of @egjs/flicking| |@egjs/react-flicking|version|React React port of @egjs/flicking| |@egjs/vue-flicking|version|Vue.js Vue.js port of @egjs/flicking|

🌐 Supported Browsers

|IE|Chrome|Firefox|Safari|iOS|Android| |:---:|:---:|:---:|:---:|:---:|:---:| |10+|Latest|Latest|Latest|7+|4+|

πŸ“Ό Demos

Check our Demos.

πŸ“– Documentation

See Documentation page.

πŸ™Œ Contributing

See CONTRIBUTING.md.

πŸ“ Feedback

Please file an Issue.

πŸ›£οΈ Roadmap

See our Roadmap.

πŸ“œ 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.

      

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.