vue-highlight

A Vue.js Plugin

Table of contents

• Installation
• Usage
• Example

Installation

npm install --save vue-highlight

Default import

Install all the components:

import Vue from 'vue'
import VueHighlight from 'vue-highlight'

Vue.use(VueHighlight)

Use specific components:

import Vue from 'vue'
import { Test } from 'vue-highlight'

Vue.component('test', Test)

⚠️ A css file is included when importing the package. You may have to setup your bundler to embed the css in your page.

Distribution import

Install all the components:

import 'vue-highlight/dist/vue-highlight.css'
import VueHighlight from 'vue-highlight/dist/vue-highlight.common'

Vue.use(VueHighlight)

Use specific components:

import 'vue-highlight/dist/vue-highlight.css'
import { Test } from 'vue-highlight/dist/vue-highlight.common'

Vue.component('test', Test)

⚠️ You may have to setup your bundler to embed the css file in your page.

Browser

<link rel="stylesheet" href="vue-highlight/dist/vue-highlight.css"/>

<script src="vue.js"></script>
<script src="vue-highlight/dist/vue-highlight.browser.js"></script>

The plugin should be auto-installed. If not, you can install it manually with the instructions below.

Install all the components:

Vue.use(VueHighlight)

Use specific components:

Vue.component('test', VueHighlight.Test)

Source import

Install all the components:

import Vue from 'vue'
import VueHighlight from 'vue-highlight/src'

Vue.use(VueHighlight)

Use specific components:

import Vue from 'vue'
import { Test } from 'vue-highlight/src'

Vue.component('test', Test)

⚠️ You need to configure your bundler to compile .vue files. More info in the official documentation.

Usage

TODO

Example

TODO

Plugin Development

Installation

The first time you create or clone your plugin, you need to install the default dependencies:

npm install

Watch and compile

This will run webpack in watching mode and output the compiled files in the dist folder.

npm run dev

Use it in another project

While developping, you can follow the install instructions of your plugin and link it into the project that uses it.

In the plugin folder:

npm link

In the other project folder:

npm link vue-highlight

This will install it in the dependencies as a symlink, so that it gets any modifications made to the plugin.

Publish to npm

You may have to login to npm before, with npm adduser. The plugin will be built in production mode before getting published on npm.

npm publish

Manual build

This will build the plugin into the dist folder in production mode.

npm run build

License

MIT