Skip to content

Standalone VueSandbox wrapper for live-testing Vue components.

License

Notifications You must be signed in to change notification settings

mknxdev/vue-sandbox-wrapper

Repository files navigation

VueSandbox-wrapper

This package is a Vue-based port of the VueSandbox's live-testing system. It is only usable as an importable Vue component (UMD module), and is designed to be integrated into an existing Vue.js codebase.

If you're looking for the complete installable utility, please follow instructions here.


Compatibility

Prerequisites

You'll need the following packages to be installed on your project.

  • Vue v2.6.8 or greater (Vue3 is not currently supported)

Note that Vue.js is not included in order to limit the output bundle size, so you'll need to provide your own Vue constructor when using VS-wrapper (see the API Reference for detail).

Browsers

Here are the minimum browser versions required for this package to work.

Desktop

Chrome Firefox Safari IE Edge Opera
18 14 6.1 No support 12 15

Smartphone/Tablet

iOS Safari Opera Mini Opera Mobile Android Browser Chrome Android Firefox Android UC Browser Samsung QQ Browser Baidu KaiOS
7 No support 59 4.4 88 83 12.12 4 10.4 7.12 2.5

Installation

Through npm or yarn:

npm i vue-sandbox-wrapper --save
yarn add vue-sandbox-wrapper

Usage

As this package is bundled following the UMD format, it can be integrated to your project in several ways.

Module Builder

import { VSComponentWrapper } from 'vue-sandbox-wrapper'
import 'vue-sandbox-wrapper/dist/vue-sandbox-wrapper.css'

HTML <script> tags

<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/vue-sandbox-wrapper@1.0.0-beta.6/dist/vue-sandbox-wrapper.js"></script>
<link type="text/css" src="https://cdn.jsdelivr.net/npm/vue-sandbox-wrapper@1.0.0-beta.6/dist/vue-sandbox-wrapper.css">

API Reference

Components

> VSComponentWrapper

This is the main component used for live-testing, allowing live-edit of component's props.
Displays a user-editable area alongside a viewport containing the component's render.

Props

Name Type Required Default Description
vue function Yes - The Vue constructor.
compiledObject object Yes - The compiled version of the component.

Note: The "compiled" component refers to the JavaScript object (e.g. programmatic version) built from the corresponding Vue SFC file, using bundlers like webpack or Rollup (more infos here).

Licensing

Released under the MIT license.

Contribute

Soon...

About

Standalone VueSandbox wrapper for live-testing Vue components.

Resources

License

Stars

Watchers

Forks

Packages

No packages published