@egjs/ngx-flicking

Angular wrapper of @egjs/flicking

Demo / Documentation / Other components

⚙️ Installation

npm install @egjs/ngx-flicking
# Or if you're using yarn
yarn add @egjs/ngx-flicking
# Or if you're using pnpm
pnpm install @egjs/ngx-flicking

🏃 Quick Start

Module definition

+import { NgxFlickingModule } from '@egjs/ngx-flicking';
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';

@NgModule({
  declarations: [
    AppComponent
  ],
  imports: [
    BrowserModule,
+   NgxFlickingModule /* Add in imports */
  ],
  providers: [],
  bootstrap: [AppComponent]
})
export class AppModule { } /* Your app */

Then we have to bundle flicking.css. The file may be imported into the styles.scss or defined in the angular.json configuration in the options.build.styles list:

// styles.scss
@import '@egjs/flicking/dist/flicking.css';

Template & Script

import { Plugin } from '@egjs/ngx-flicking';
import { Fade, AutoPlay } from '@egjs/flicking-plugins';

@Component({
  selector: 'flicking-demo',
  template: `
    <ngx-flicking
      [options]="{ circular: true, duration: 500 }"
      [plugins]="plugins"
      (needPanel)="onNeedPanel($event)"
    >
      <div class="panel">
        <img src="https://naver.github.io/egjs-flicking/images/bg01.jpg" />
      </div>
      <div class="panel">
        <img src="https://naver.github.io/egjs-flicking/images/bg02.jpg" />
      </div>
      <div class="panel">
        <img src="https://naver.github.io/egjs-flicking/images/bg03.jpg" />
      </div>
    </ngx-flicking>
  `,
})
export class FlickingDemo implements OnInit {
  plugins: Plugin[] = [
    new Fade(),
    new AutoPlay({
      duration: 2000,
      direction: 'NEXT',
    }),
  ];

  onNeedPanel(e) {
    // ADD PANELS
  }
}

Guide

• [v3.4+] Applying renderOnlyVisible option on ngx flicking (Performance)

📦 Packages

You can use all plugins just like native @egjs/flicking.

Check @egjs/flicking-plugins for readymade effects we're providing.

📖 More Options & Examples

Options / Demos

🙌 Contributing

See CONTRIBUTING.md

📝 Feedback

Please file an Issue with label "Angular".

Local development

Project setup

npm install

Compiles and hot-reloads demo

npm run start

Compiles and minifies for production

npm run build

Run your tests

npm run test

Lints and fixes files

npm run lint

📜 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.