Nonlinear Performance Magnification

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

    4.3.0 • Public • Published

    Flicking Logo
    Vue @egjs/vue3-flicking

    npm bundle size (scoped) GitHub commit activity npm downloads per month GitHub contributors GitHub

    Vue.js Vue@3 wrapper of @egjs/flicking

    Demo / Documentation / Other components

    ⚠️ If you're looking for Flicking for Vue 2, check out @egjs/vue-flicking

    ⚙️ Installation

    npm install --save @egjs/vue3-flicking

    Changes from @egjs/flicking

    • All camelCased event names became kebab-case
      • e.g., moveEnd => move-end
    • You can't use methods that manipulates DOM directly
      • e.g., append(), prepend(), insert(), remove()

    🏃 Quick Start

    Global registration

    import VueFlicking from "@egjs/vue3-flicking";
    import "@egjs/vue3-flicking/dist/flicking.css";
    // Or, if you have to support IE9
    import "@egjs/vue3-flicking/dist/flicking-inline.css";
    
    Vue.use(VueFlicking);

    Local registration

    import Flicking from "@egjs/vue3-flicking";
    
    export default {
      components: {
        Flicking: Flicking,
      }
    }

    And in the <style> tag

    @import url("node_modules/@egjs/vue3-flicking/dist/flicking.css");
    // Or, if you have to support IE9
    @import url("node_modules/@egjs/vue3-flicking/dist/flicking-inline.css");

    Usage

    <template>
      <flicking
        :options="{ circular: true, moveType: 'freeScroll' }"
        :viewportTag="'div'"
        :cameraTag="'div'"
        :plugins="plugins"
        @need-panel="e => {
          // ADD PANELS
        }"
      >
        <div>CONTENTS OF PANEL 0</div>
        <div>CONTENTS OF PANEL 1</div>
        <div>CONTENTS OF PANEL 2</div>
      </flicking>
    </template>
    <script>
    import { Vue } from "vue-class-component";
    import { Fade, AutoPlay } from "@egjs/flicking-plugins";
    
    export default class DemoClass extends Vue {
      plugins = [new Fade(), new AutoPlay(2000, "NEXT")];
    }
    </script>

    📦 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 "Vue".

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

          

    Keywords

    none

    Install

    npm i @egjs/vue3-flicking

    DownloadsWeekly Downloads

    105

    Version

    4.3.0

    License

    MIT

    Unpacked Size

    99.8 kB

    Total Files

    25

    Last publish

    Collaborators

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