davidroyer / vue-plugin-starter

vue-plugin-starter

Notes

new tests

Releasing pre-release: release-it major --preRelease=beta

Results In: 2.0.0-beta.0

Then after that, you don't need to include the type of update (such as major used here).

release-it --preRelease=beta

Results In: 2.0.0-beta.0

MAKING IT WORK

For release-it

• Needed to run the following after obtaining the token via Github:

export GITHUB_TOKEN="123123123"

• Needed this line for jest.config.js to make it work and not throw import errors:

transformIgnorePatterns: ["<rootDir>/node_modules/"];

Usage

<VEditor :text="hello"></VEditor>

import { VEditor } from "vue-plugin-starter";

export default {
  components: {
    VEditor
  }
};

API

v-editor

An Amazing Editor Component

• author - David Royer
• license - MIT
• VEditor

slots

• default

• label Use this slot to set the checkbox label

props

• msg String (optional)

  Test prop for unit tests

• model Array (optional)

  The checkbox model

• disabled Boolean (optional)

  Initial checkbox state

• enabled Boolean (optional) default: true

  Initial checkbox value

• label String (optional) default: 'Unamed checkbox'

  The checkbox label

• object Object (optional) default: null

• bool-false Boolean (optional) default: false

data

• initialValue

  The initial component value. Used to detect changes and restore the initial value.

initial value: 'The initial value!'

• currentValue

initial value: 'And the current value!'

computed properties

• id

  The component identifier. Generated using the initialValue data.

  dependencies: initialValue

• changed

  dependencies: currentValue, initialValue

• withNoDependencies

events

• loaded

  Emitted when the component has been loaded

• enabled

  Emitted the event enabled when loaded Multilign

methods

• check()

  Check if the input is checked

• prop()

• enable(value)

  Enable the checkbox

Installation

npm install vue-plugin-starter

Project setup

yarn install

Compiles and hot-reloads for development

yarn run serve

Compiles and minifies for production

yarn run build

Lints and fixes files

yarn run lint

Run your unit tests

yarn run test:unit

Update the API section of README.md with generated documentation

yarn run doc:build

Run style guide dev server

yarn run styleguide

Generate a static HTML style guide

yarn run styleguide:build