Giter VIP home page Giter VIP logo

egjs-flicking's Introduction

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

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

๐Ÿƒ Quick Start

Typescript

import Flicking from "@egjs/flicking";

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

Browser

<script src="https://cdnjs.cloudflare.com/ajax/libs/egjs-flicking/3.x.x/flicking.js"></script>
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.

โœ…

<div id="wrapper" style="height: 120px">
  <div class="panel"></div>
  <div class="panel"></div>
  <div class="panel"></div>
</div>
<div id="wrapper">
  <!-- Least one of them should have fixed height -->
  <div class="panel" style="height: 120px;"></div>
  <div class="panel"></div>
  <div class="panel"></div>
</div>

โŒ

<div id="wrapper"> <!-- Wrapper height is dependent on panel height -->
  <div class="panel" style="height: 100%;"></div>
  <div class="panel" style="height: 100%;"></div>
  <div class="panel" style="height: 100%;"></div>
</div>

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.

ย ย ย ย ย ย 

egjs-flicking's People

Contributors

daybrush avatar greenkeeper[bot] avatar hiuny avatar james-song avatar netil avatar parksb avatar sculove avatar uyeong avatar woodneck avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.