# @egjs/ngx-conveyer

> Angular Conveyer adds Drag gestures to your Native Scroll.

Latest version **1.8.1-alpha.0** (published 2025-09-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install @egjs/ngx-conveyer
pnpm add @egjs/ngx-conveyer
yarn add @egjs/ngx-conveyer
bun add @egjs/ngx-conveyer
```

## Health

**Score 40/100 (D)** — status: stable.

Positive: no vulnerabilities; high maintenance score.

Warnings: low downloads; no types; no esm support.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 1.8.1-alpha.0 |
| Published | 2025-09-17 |
| First published | 2022-02-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 32.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 126 |
| Author | NAVER Corp. |
| Maintainers | ajaxpf, jongmoon, sculove, happyhj, anuu0916, mixed, netil, younkue, woodneck, braixen, cjw783 |
| Keywords | angular, ngx, scroll, reactive, hooks, conveyer, image, video, list, drag |

## Links

- npm: https://www.npmjs.com/package/@egjs/ngx-conveyer
- Repository: https://github.com/naver/egjs-conveyer
- Issues: https://github.com/naver/egjs-conveyer/issues
- npm.io page: https://npm.io/package/@egjs/ngx-conveyer

## Dependencies (2)

- [@cfcs/angular](https://npm.io/package/@cfcs/angular.md) ^0.1.1
- [@egjs/conveyer](https://npm.io/package/@egjs/conveyer.md) ~1.8.1-alpha.0

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.8.1-alpha.0 (latest) — 2025-09-17
- 0.1.0 (beta) — 2022-02-21
- 1.8.0 — 2025-04-18
- 1.7.1 — 2023-09-27
- 1.7.0 — 2023-09-22
- 1.6.2 — 2023-08-25
- 1.6.1 — 2023-08-03
- 1.6.0 — 2023-08-03
- 1.5.1 — 2023-07-26
- 1.5.0 — 2023-06-22
- 1.4.9 — 2023-06-02
- 1.4.8 — 2023-01-12
- 1.4.7 — 2022-12-28
- 1.4.6 — 2022-12-02
- 1.4.5 — 2022-10-14
- … 13 more at https://npm.io/package/@egjs/ngx-conveyer/versions

## README

<h1 align="center" style="max-width: 100%;">
  <img width="256" alt="Conveyer Logo" src="https://naver.github.io/egjs-conveyer/img/logo.png" style="max-width: 100%;" /><br/>
  <a href="https://naver.github.io/egjs-conveyer/">Angular Conveyer</a>
</h1>

<p align="center" style="line-height: 2;">
  <a href="https://www.npmjs.com/package/@egjs/ngx-conveyer" target="_blank"><img src="https://img.shields.io/npm/v/@egjs/conveyer.svg?style=flat-square&color=007acc&label=version&logo=NPM" alt="version" /></a>
  <a href="https://www.npmjs.com/package/@egjs/ngx-conveyer" target="_blank"><img alt="npm weekly downloads" src="https://img.shields.io/npm/dw/@egjs/conveyer?logo=npm&style=flat-square&color=007acc" /></a>
  <a href="https://www.npmjs.com/package/@egjs/ngx-conveyer" target="_blank"><img alt="npm bundle size (scoped)" src="https://img.shields.io/bundlephobia/minzip/@egjs/ngx-conveyer.svg?style=flat-square&label=%F0%9F%92%BE%20gzipped&color=007acc" /></a>
  <a href="https://github.com/naver/egjs-conveyer/actions" target="_blank"><img alt="Github actions" src="https://img.shields.io/github/workflow/status/naver/egjs-conveyer/Run%20tests?style=flat-square" /></a>
  <a href="https://coveralls.io/github/naver/egjs-conveyer?branch=master&style=flat-square" target="_blank"><img alt="Coveralls github" src="https://img.shields.io/coveralls/github/naver/egjs-conveyer.svg?style=flat-square&label=%E2%9C%85%20coverage" /></a>
    <a href="https://github.com/naver/egjs-conveyer/blob/main/LICENSE" target="_blank"><img src="https://img.shields.io/static/v1?style=flat-square&label=%F0%9F%93%9C%20license&message=MIT&color=08CE5D" /></a>
    <img src="https://img.shields.io/static/v1.svg?label=&message=TypeScript&color=294E80&style=flat-square&logo=typescript" />
</p>
<h3 align="center">
  <a href="https://naver.github.io/egjs-conveyer/">Demo</a> / <a href="https://naver.github.io/egjs-conveyer/docs/api/Conveyer">Documentation</a> / <a href="https://naver.github.io/egjs/"><img height="20" src="https://naver.github.io/egjs/img/logo.svg"/> Other components</a>
</h3>

<p align="center">
  <b>Conveyer adds Drag gestures to your Native Scroll.</b><br />📱💻🖥
</p>

---

## ✨ Features

- You can use Native Scroll-like behavior through Drag.
- By adding easing features such as bounce, elasticity, and back, you can create smooth scrolling animations like Native Scroll.
- Supports Reactive Properties that can change state through properties that automatically detect changes instead of events.
- You can use custom scroll events like onBeginScroll, onFinishScroll, onReachStart, onLeaveStart,

## ⚙️ Installation

```bash
$ npm install @egjs/ngx-conveyer
# Or if you are using yarn
$ yarn add @egjs/ngx-conveyer
# Or if you are using pnpm
$ pnpm install @egjs/ngx-conveyer
```

## 🏃 Quick Start

### Module definition

```diff
+import { NgxConveyerModule } from '@egjs/ngx-conveyer';
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';

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

- You can use [reactive properties](https://naver.github.io/egjs-conveyer/docs/api/Conveyer#properties) and [methods](https://naver.github.io/egjs-conveyer/docs/api/Conveyer#methods).
- You can use [events](https://naver.github.io/egjs-conveyer/docs/api/Conveyer#events)

```html
<div class="container">
  <button id="prev" [disabled]="conveyer?.isReachStart" (click)="prev()">
    prev
  </button>
  <button id="next" [disabled]="conveyer?.isReachEnd" (click)="next()">
    next
  </button>
  <div
    class="items"
    ngxConveyer
    #conveyer="ngxConveyer"
    (beginScroll)="beginScroll()"
    (finishScroll)="finishScroll()"
  >
    <div class="item">1</div>
    <div class="item">2</div>
    <div class="item">3</div>
  </div>
</div>
```

```ts
import { Component, Input, AfterViewInit } from '@angular/core';
import { NgxConveyerDirective } from '@egjs/ngx-conveyer';

@Component({
  selector: 'app-root',
  templateUrl: './app.component.html',
})
export class AppComponent implements AfterViewInit {
  @ViewChild('conveyer') conveyer!: NgxConveyerDirective;

  prev() {
    this.conveyer.scrollIntoView('start', {
      align: 'end',
      duration: 500,
    });
  }

  next() {
    this.conveyer.scrollIntoView('end', {
      align: 'start',
      duration: 500,
    });
  }

  beginScroll() {
    console.log('begin scroll');
  }

  finishScroll() {
    console.log('finish scroll');
  }
}
```

## 🌐 Supported Browsers

| <img width="20" src="https://simpleicons.org/icons/internetexplorer.svg" alt="IE" /> | <img width="20" src="https://simpleicons.org/icons/googlechrome.svg" alt="Chrome" /> | <img width="20" src="https://simpleicons.org/icons/firefoxbrowser.svg" alt="Firefox" /> | <img width="20" src="https://simpleicons.org/icons/safari.svg" alt="Safari" /> | <img width="20" src="https://simpleicons.org/icons/apple.svg" alt="iOS" /> | <img width="20" src="https://simpleicons.org/icons/android.svg" alt="Android" /> |
| :----------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------: | :------------------------------------------------------------------------: | :------------------------------------------------------------------------------: |
|                     9+(With polyfill), 11+ for Angular & Svelte                      |                                        Latest                                        |                                         Latest                                          |                                     Latest                                     |                                     7+                                     |                                        4+                                        |

## 📼 Demos

Check our [Demos](https://naver.github.io/egjs-conveyer/).

## 📖 Documentation

See [Documentation](https://naver.github.io/egjs-conveyer/docs/api/Conveyer) page.

## 🙌 Contributing

See [CONTRIBUTING.md](https://github.com/naver/egjs-conveyer/blob/main/CONTRIBUTING.md).

## 📝 Feedback

Please file an [Issue](https://github.com/naver/egjs-conveyer/issues).

## 📜 License

@egjs/ngx-conveyer is released under the [MIT license](https://github.com/naver/egjs-conveyer/blob/main/LICENSE).

```
Copyright (c) 2022-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.
```

<p align="center">
  <a href="https://naver.github.io/egjs/"><img height="50" src="https://naver.github.io/egjs/img/logotype1_black.svg" /></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="https://github.com/naver"><img height="50" src="https://naver.github.io/OpenSourceGuide/book/assets/naver_logo.png" /></a>
</p>

---
_Source: https://npm.io/package/@egjs/ngx-conveyer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._