Git Product home page Git Product logo

mura-vue's Introduction

mura-vue

npm npm vue2

Vue Components for Mura CMS

Table of contents

Installation

npm install --save mura-vue

Default import

Install all the components:

import Vue from 'vue'
import MuraVue from 'mura-vue'

Vue.use(MuraVue)

Use specific components:

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

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 'mura-vue/dist/mura-vue.css'
import MuraVue from 'mura-vue/dist/mura-vue.common'

Vue.use(MuraVue)

Use specific components:

import 'mura-vue/dist/mura-vue.css'
import { Test } from 'mura-vue/dist/mura-vue.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="mura-vue/dist/mura-vue.css"/>

<script src="vue.js"></script>
<script src="mura-vue/dist/mura-vue.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(MuraVue)

Use specific components:

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

Source import

Install all the components:

import Vue from 'vue'
import MuraVue from 'mura-vue/src'

Vue.use(MuraVue)

Use specific components:

import Vue from 'vue'
import { Test } from 'mura-vue/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 mura-vue

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

mura-vue's People

Contributors

rwatts3 avatar

Stargazers

 avatar

Watchers

 avatar  avatar

mura-vue's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.