naver/egjs-conveyer

Conveyer adds Drag gestures to your Native Scroll.

Conveyer

Demo / Documentation / Other components

Conveyer adds Drag gestures to your Native Scroll.
📱💻🖥

---

✨ 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

npm

$ npm install --save @egjs/conveyer

CDN

• unpkg: https://unpkg.com/@egjs/conveyer/dist/

🏃 Quick Start

HTML

<div class="items">
  <div class="item"></div>
  <div class="item"></div>
  <div class="item"></div>
  <div class="item"></div>
</div>

ES Modules

import Conveyer from "@egjs/conveyer";

const conveyer = new Conveyer(".items");

With CDN

<!-- Packaged with all dependencies -->
<!-- https://naver.github.io/egjs-conveyer/release/latest/dist/conveyer.min.js -->
<script src="https://unpkg.com/@egjs/conveyer/dist/conveyer.min.js"></script>
<script>
const conveyer = new Conveyer(".items");
</script>

How to use

HTML

<button class="prev">prev</button>
<button class="next">next</button>
<div class="items">
  <div class="item"></div>
  <div class="item"></div>
  <div class="item"></div>
  <div class="item"></div>
</div>

JS

import Conveyer from "@egjs/conveyer";

// Since events occur during initialization, set `autoInit` to false if you want to register events.
const conveyer = new Conveyer(".items", {
  autoInit: false,
});

const prev = document.querySelector(".prev");
const next = document.querySelector(".next");

prev.addEventListener("click", () => {
  // start to end
  conveyer.scrollIntoView("start", {
    align: "end",
    duration: 500,
    excludeStand: true,
  });
});
next.addEventListener("click", () => {
  // end to start
  conveyer.scrollIntoView("end", {
    align: "start",
    duration: 500,
    excludeStand: true,
  });
});
conveyer.subscribe("isReachStart", value => {
  prev.disabled = value;
});
conveyer.subscribe("isReachEnd", value => {
  next.disabled = value;
});

conveyer.init();

📦 Packages

Package	Version	Description
@egjs/conveyer		Conveyer adds Drag gestures to your Native Scroll.
@egjs/ngx-conveyer		Angular port of @egjs/conveyer
@egjs/react-conveyer		React port of @egjs/conveyer
@egjs/vue-conveyer		Vue.js@3 port of @egjs/conveyer
@egjs/vue2-conveyer		Vue.js@2 port of @egjs/conveyer
@egjs/svelte-conveyer		Svelte port of @egjs/conveyer

🌐 Supported Browsers

9+(With polyfill), 11+ for Angular & Svelte	Latest	Latest	Latest	7+	4+

📼 Demos

Check our Demos.

📖 Documentation

See Documentation page.

🙌 Contributing

See CONTRIBUTING.md.

📝 Feedback

Please file an Issue.

📜 License

@egjs/conveyer is released under the MIT 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.