Security News
The Dark Side of Open Source
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
vue3-marquee
Advanced tools
Readme
A simple marquee component with ZERO dependencies for Vue 3. This component was originally developed for internal use but I figured this could be useful to someone else as well. This component is modeled after a React marquee component I found called React Fast Marquee. To keep a smooth animation running, clones of the content can be created for seamless transitions with no flickering or empty spaces in between content.
View the live demos here: https://vue3-marquee.vercel.app/examples
If you are using version 3.x of vue3-marquee
you should upgrade to version 4.x. You can do this by running the Installation and Usage command below. This add better support for Typescript. There is also a change with the dist/style.css
import (it's been removed) so take a look at the new documentation for instructions on how to migrate to this package.
If you are using npm:
npm install vue3-marquee@latest --save
If you are using yarn:
yarn add vue3-marquee@latest
The most common use case is to register the component globally.
// main.js
import { createApp } from 'vue'
import Vue3Marquee from 'vue3-marquee'
createApp(App).use(Vue3Marquee).mount('#app')
If you need to use a custom component name, you can pass it as an option to the plugin:
app.use(Vue3Marquee, { name: 'MarqueeAnimation' }) // use in template <MarqueeAnimation />
name
string (default: 'Vue3Marquee') - set custom component nameAlternatively you can also import the component locally.
import { Vue3Marquee } from 'vue3-marquee'
export default {
components: {
Vue3Marquee,
},
}
You can then use the component in your template
<template>
<Vue3Marquee>
<img height="200" width="300" src="...img" />
<img height="200" width="300" src="...img" />
<img height="200" width="300" src="...img" />
</Vue3Marquee>
</template>
<script>
import { Vue3Marquee } from 'vue3-marquee'
export default {
components: {
Vue3Marquee,
},
}
</script>
If you are using npm:
npm install vue3-marquee@latest --save
If you are using yarn:
yarn add vue3-marquee@latest
plugins
at the root of your project.Vue3Marquee.client.ts
inside the plugins directory.Vue3Marquee.client.ts
file.import Vue3Marquee from 'vue3-marquee'
export default defineNuxtPlugin((nuxtApp) => {
nuxtApp.vueApp.use(Vue3Marquee, { name: 'Vue3Marquee' })
})
This should register as a global component that you can call anywhere in your app under the <Vue3Marquee>
tag.
More detailed explanations are provided in the documentation.
Prop | Type | Default Value | Description |
---|---|---|---|
direction | String of either 'normal' or 'reverse' | "normal" | The direction for the content to move in |
duration | Number | 20 | The time taken for the marquee content to move the width of the container (in seconds) |
delay | Number | 0 | A delay before the animation starts (in seconds) |
loop | Number | 0 | The number of instances that the marquee animation should run (0 is infinite) |
gradient | Boolean | false | Whether to show a gradient overlay |
gradientColor | Array of 3 RGB values | [255, 255, 255] | The RGB colors for the color of the gradient |
gradientLength | String | 200px | Length of portion of the container edges that should be taken by the gradient overlay |
pause | Boolean | false | A reactive prop to pause the marquee |
pauseOnHover | Boolean | false | Whether to pause the marquee on hover |
pauseOnClick | Boolean | false | Whether to pause the marquee when you hold the right click button |
clone | Boolean | false | Whether to clone the content if you want no empty spaces in the animation |
vertical | Boolean | false | Whether to make the marquee vertical |
animateOnOverflow | Boolean | false | Whether to animate the marquee if the content overflows the container |
A few events are emitted from the component. Look at the Demos for examples.
pauseOnHover
or pauseOnClick
enabled. It will notify if the animation pauses.pauseOnHover
or pauseOnClick
enabled. It will notify if the animation resumes.animateOnOverflow
enabled. It will notify if the content overflows the container.animateOnOverflow
enabled. It will notify if the content no longer overflows the container. (useful if you need to add a class to the container when the content overflows)pause
propFAQs
A simple marquee component with ZERO dependencies for Vue 3
The npm package vue3-marquee receives a total of 5,940 weekly downloads. As such, vue3-marquee popularity was classified as popular.
We found that vue3-marquee demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
Research
Security News
The Socket Research team found this npm package includes code for collecting sensitive developer information, including your operating system username, Git username, and Git email.
Security News
OpenJS is warning of social engineering takeovers targeting open source projects after receiving a credible attempt on the foundation.