@egjs/vue2-conveyer
TypeScript icon, indicating that this package has built-in type declarations

1.7.1 • Public • Published

Conveyer Logo
Vue 2 Conveyer

version npm weekly downloads npm bundle size (scoped) Github actions Coveralls github

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

If Vue is less than 2.7 version, install the composition-api together.

$ npm install @egjs/vue2-conveyer
$ npm install @vue/composition-api

For Vue 2.7 or higher, use Vue 3's vue-conveyer.

$ npm install @egjs/vue-conveyer

🏃 Quick Start

in the result of the useConveyer method

import Vue from "vue";
import VueCompositionAPI from '@vue/composition-api';

// @vue/composition-api is required to use vue2-conveyer for
Vue.use(VueCompositionAPI);
<template>
  <div class="App">
    <button id="prev" :disabled="isReachStart" @click="prev">PREV</button>
    <button id="next" :disabled="isReachEnd" @click="next">NEXT</button>
    <div class="items" ref="ref">
      <div class="item"><a href="#1">1</a></div>
      <div class="item"><a href="#2">2</a></div>
      <div class="item"><a href="#3">3</a></div>
      <div class="item"><a href="#4">4</a></div>
      <div class="item"><a href="#5">5</a></div>
      <div class="item"><a href="#6">6</a></div>
      <div class="item"><a href="#7">7</a></div>
      <div class="item"><a href="#8">8</a></div>
      <div class="item"><a href="#9">9</a></div>
      <div class="item"><a href="#10">10</a></div>
      <div class="item"><a href="#11">11</a></div>
      <div class="item"><a href="#12">12</a></div>
    </div>
  </div>
</template>

<script lang="ts">
import { defineComponent } from "@vue/composition-api";
import { useConveyer } from "@egjs/vue2-conveyer";

export default defineComponent({
  name: "App",
  setup() {
    const {
      ref,
      // reactive properties
      isReachStart,
      isReachEnd,
      // methods
      scrollIntoView,
      // events
      onBeginScroll,
      onFinishScroll,
    } = useConveyer({
      horizontal: false,
    });

    onBeginScroll(() => {
      console.log("begin scroll");
    });
    onFinishScroll(() => {
      console.log("finish scroll");
    });

    return {
      ref,
      isReachStart,
      isReachEnd,
      scrollIntoView,
    };
  },
  methods: {
    prev() {
      this.scrollIntoView("start", {
        align: "end",
        duration: 500,
      });
    },
    next() {
      this.scrollIntoView("end", {
        align: "start",
        duration: 500,
      });
    },
  },
});
</script>

🌐 Supported Browsers

IE Chrome Firefox Safari iOS Android
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/vue2-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.

      

Package Sidebar

Install

npm i @egjs/vue2-conveyer

Weekly Downloads

9

Version

1.7.1

License

MIT

Unpacked Size

16 kB

Total Files

8

Last publish

Collaborators

  • anuu0916
  • braixen
  • ajaxpf
  • jongmoon
  • sculove
  • happyhj
  • mixed
  • netil
  • younkue
  • woodneck