Installation

npm install --save @jledentu/vue-finder

vue-finder can be used as a module in both CommonJS and ES module environments. When in non-modular environment, vue-finder will register all the components to vue by itself.

ES6

import { Finder } from '@jledentu/vue-finder';

export default {
  ...
  components: {
    Finder
  },
  ...
};

CommonJS

//
// You can register a component manually
//
var Vue = require('vue');
var VueFinder = require('@jledentu/vue-finder');

var YourComponent = Vue.extend({
  ...
  components: {
    'vue-finder': VueFinder.Finder
  },
  ...
});

Browser

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

After that, you can use it in your templates:

<vue-finder></vue-finder>

Changelog

See the GitHub release history.

Contributing

Pull requests are welcome! For major changes, please open an issue first to discuss what you would like to change.

Development scripts

• yarn build to build the library
• yarn test to run the unit tests
• yarn storybook to run the Storybook in watch mode
• yarn docs:dev to run the Vuepress documentation in watch mode

License

MIT