vue-wordart

The nostalgic WordArt we know just in vue

Generated using vue-cli-template-library.

Installation

npm install vue-wordart

or

yarn add vue-wordart

vue-wordart can be used as a module in both CommonJS and ES modular environments.

When in non-modular environment, vue-wordart will register all the components to vue by itself.

ES6

//
// You can register a component manually
//
import { VueWordArt } from 'vue-wordart';
 
export default {
  ...
  components: {
    VueWordArt
  },
  ...
};
 
//
// or register the whole module with vue
//
import VueWordArt from 'vue-wordart';
 
// Install this library
Vue.use(VueWordArt);

CommonJS

//
// You can register a component manually
//
var Vue = require('vue');
var VueWordArt = require('vue-wordart');
 
var YourComponent = Vue.extend({
  ...
  components: {
    'vue-word-art': VueWordArt
  },
  ...
});
 
//
// or register the whole module with vue
//
var Vue = require('vue');
var VueWordArt = require('vue-wordart');
 
// Install this library
Vue.use(VueWordArt);

Browser

<script src="path/to/vue/vue.min.js"></script>
<script src="path/to/vue-wordart/dist/vue-wordart.min.js"></script>
<!-- Components are registered globally -->

After that, you can use it in your templates:

<!-- Using children component -->
<vue-wordart theme="tilt" font-size="30px">
  The quick brown fox jumps over the lazy dog
</vue-wordart>
 
<!-- Using component props -->
<vue-wordart
  theme="tilt"
  font-size="30px"
  text="The quick brown fox jumps over the lazy dog"
/>

Changelog

See the GitHub release history.

Contributing

See CONTRIBUTING.md.