README
v-typewriter
A Vue component for typewriting dom
https://v-typewriter.netlify.com
npm install --save v-typewriter
Import
// 1. main.js Entry; use as a plugin
import Vue from "vue";
import VTypewriter from "v-typewriter";
Vue.use(VTypewriter);
<!--2. .vue import-->
<script>
import VTypewriter from "v-typewriter";
export default {
name: "app",
components: {
VTypewriter
}
};
</script>
Usage
<v-typewriter :interval="100" loop rollback>
<!--insert any dom to be typewrote-->
<h1>v-typewriter</h1>
<span>We can type!</span>
</v-typewriter>
arguments
name | type | default | desc |
---|---|---|---|
rollback | Boolean | false | rollback when typed |
loop | Boolean | false | loop when typed |
delay | Number | 0 | delay before typing |
interval | Number | 100 | typing interval between each letter |
cursor | String | "_" | typing cursor |
align | String | "left" | typing text align(left/right/center) |
Project setup
Our example is in App.vue. To try our components now, git clone and use
npm run serve
and open your browser at "http://localhost:8080/" to view some examples in App.vue.
You can also review it online at our website