Have ideas to improve npm?Join in the discussion! »

    vue-swimlane

    0.4.4 • Public • Published

    vue-swimlane

    All Contributors

    A Text Swimlane plugin for Vue.js to display a list of words as an animated text Swimlane.

    NPM

    Demo

    Demo and Playground

    How to use

    Install using npm

    npm install vue-swimlane --save

    Plug in your main.js or where required

    import Vue from 'vue'
    import VueSwimlane from 'vue-swimlane'
     
    Vue.use(VueSwimlane)

    use CDN

    <script src="https://unpkg.com/vue-swimlane/dist/vue-swimlane.min.js"></script>

    Markup

    <vue-swimlane :words="['Some', 'Keywords', 'Array']"></vue-swimlane>

    Options

    Following options can be passed as props.

    • words - string[] - required: Array of tags or words to be used on display.
    • continous - bool (Default: false): If true, list continues forward, repeating the list. (Bugged, animation not working)
    • circular - bool (Default: false): If true, list starts from the top after completion.
    • pauseOnHover - bool (Default: false): If true, animation will pause on mouse hover.
    • rows - int (Default: 1): Number of rows always visible at a time.
    • scale - float (Default: 1): Font size scaling relative to 16px.
    • transitionDuration - float in ms (Default: 500): Animation duration for rows.
    • transitionDelay - float in ms (Default: 250): Delays between each animation duration.
    • transition - string (Default: ease-out): css transition name.

    Contributors ✨

    Thanks goes to these wonderful people (emoji key):

    Jake
    Jake

    💻 📖

    This project follows the all-contributors specification. Contributions of any kind welcome!

    Install

    npm i vue-swimlane

    DownloadsWeekly Downloads

    81

    Version

    0.4.4

    License

    MIT

    Unpacked Size

    61.7 kB

    Total Files

    11

    Last publish

    Collaborators

    • avatar