• Stars
    star
    466
  • Rank 94,105 (Top 2 %)
  • Language
    JavaScript
  • License
    MIT License
  • Created about 9 years ago
  • Updated almost 2 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

🌶️ Hot reload API for Vue components

vue-hot-reload-api

Note: [email protected] only works with [email protected]

Hot reload API for Vue components. This is what vue-loader and vueify use under the hood.

Usage

You will only be using this if you are writing some build toolchain based on Vue components. For normal application usage, just use vue-loader or vueify.

// define a component as an options object
const myComponentOptions = {
  data () { ... },
  created () { ... },
  render () { ... }
}

// assuming Webpack's HMR API.
// https://webpack.js.org/guides/hot-module-replacement/
if (module.hot) {
  const api = require('vue-hot-reload-api')
  const Vue = require('vue')

  // make the API aware of the Vue that you are using.
  // also checks compatibility.
  api.install(Vue)

  // compatibility can be checked via api.compatible after installation
  if (!api.compatible) {
    throw new Error('vue-hot-reload-api is not compatible with the version of Vue you are using.')
  }

  // indicate this module can be hot-reloaded
  module.hot.accept()

  if (!module.hot.data) {
    // for each component option object to be hot-reloaded,
    // you need to create a record for it with a unique id.
    // do this once on startup.
    api.createRecord('very-unique-id', myComponentOptions)
  } else {
    // if a component has only its template or render function changed,
    // you can force a re-render for all its active instances without
    // destroying/re-creating them. This keeps all current app state intact.
    api.rerender('very-unique-id', myComponentOptions)

    // --- OR ---

    // if a component has non-template/render options changed,
    // it needs to be fully reloaded. This will destroy and re-create all its
    // active instances (and their children).
    api.reload('very-unique-id', myComponentOptions)
  }
}

License

MIT

More Repositories

1

vue

This is the repo for Vue 2. For Vue 3, go to https://github.com/vuejs/core
TypeScript
207,650
star
2

awesome-vue

🎉 A curated list of awesome things related to Vue.js
71,970
star
3

core

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript
46,527
star
4

vue-cli

🛠️ webpack-based tooling for Vue.js Development
JavaScript
29,761
star
5

vuex

🗃️ Centralized State Management for Vue.js.
JavaScript
28,416
star
6

devtools-v6

⚙️ Browser devtools extension for debugging Vue.js applications.
TypeScript
24,600
star
7

vuepress

📝 Minimalistic Vue-powered static site generator
JavaScript
22,558
star
8

vue-router

🚦 The official router for Vue 2
JavaScript
18,993
star
9

pinia

🍍 Intuitive, type safe, light and flexible Store for Vue using the composition api with DevTools support
TypeScript
13,016
star
10

vitepress

Vite & Vue powered static site generator.
TypeScript
12,445
star
11

vue-hackernews-2.0

HackerNews clone built with Vue 2.0, vue-router & vuex, with server-side rendering
JavaScript
10,957
star
12

petite-vue

6kb subset of Vue optimized for progressive enhancement
TypeScript
9,026
star
13

apollo

🚀 Apollo/GraphQL integration for VueJS
TypeScript
6,013
star
14

language-tools

⚡ High-performance Vue language tooling based-on Volar.js
TypeScript
5,830
star
15

vue-class-component

ES / TypeScript decorator for class-style Vue components.
TypeScript
5,806
star
16

vetur

Vue tooling for VS Code.
TypeScript
5,739
star
17

v2.vuejs.org

📄 Documentation for Vue 2
JavaScript
5,036
star
18

vue-loader

📦 Webpack loader for Vue.js components
TypeScript
4,986
star
19

rfcs

RFCs for substantial changes / feature additions to Vue core
4,862
star
20

eslint-plugin-vue

Official ESLint plugin for Vue.js
JavaScript
4,458
star
21

composition-api

Composition API plugin for Vue 2
TypeScript
4,193
star
22

router

🚦 The official router for Vue.js
TypeScript
3,914
star
23

vuefire

🔥 Firebase bindings for Vue.js
TypeScript
3,857
star
24

create-vue

🛠️ The recommended way to start a Vite-powered Vue project
Vue
3,667
star
25

vue-test-utils

Component Test Utils for Vue 2
JavaScript
3,566
star
26

vue-rx

👁️ RxJS integration for Vue.js.
JavaScript
3,349
star
27

docs

📄 Documentation for Vue 3
Vue
2,933
star
28

vue-touch

Hammer.js wrapper for Vue.js
JavaScript
2,723
star
29

vuex-router-sync

Effortlessly keep vue-router and vuex store in sync.
JavaScript
2,515
star
30

vue-hackernews

HackerNews clone with Vue.js
Vue
2,510
star
31

vue-vapor

Vue Vapor is a variant of Vue that offers rendering without the Virtual DOM.
TypeScript
1,909
star
32

v2.cn.vuejs.org

🇨🇳 Chinese translation for v2.vuejs.org
JavaScript
1,865
star
33

babel-plugin-transform-vue-jsx

babel plugin for vue 2.0 jsx
JavaScript
1,846
star
34

babel-plugin-jsx

JSX for Vue 3
TypeScript
1,713
star
35

vue-syntax-highlight

💡 Sublime Text syntax highlighting for single-file Vue components
1,485
star
36

jsx-vue2

monorepo for Babel / Vue JSX related packages
JavaScript
1,468
star
37

devtools-next

The next iteration of Vue DevTools
TypeScript
1,336
star
38

ui

💻 UI components for official Vue organization apps
Vue
1,329
star
39

vue-docs-zh-cn

该项目已不再维护,有劳通过 Vue 官网查阅最新的文档
1,324
star
40

vueify

Browserify transform for single-file Vue components
JavaScript
1,168
star
41

vue-web-component-wrapper

(Vue 2 only) Wrap a Vue component as a web component / custom element.
JavaScript
1,047
star
42

test-utils

Vue Test Utils for Vue 3
TypeScript
1,038
star
43

docs-next-zh-cn

🇨🇳 Chinese translation for v3.vuejs.org
Vue
951
star
44

repl

Vue SFC REPL as a Vue 3 component
TypeScript
925
star
45

roadmap

🗺️ Roadmap for the Vue.js project (archive)
846
star
46

rollup-plugin-vue

Roll .vue files
TypeScript
843
star
47

vue-jest

Jest Vue transformer
JavaScript
748
star
48

vue-migration-helper

CLI tool to aid in migration from Vue 1.x to 2.0
JavaScript
594
star
49

vue-dev-server

A POC dev server that allows you to import `*.vue` files via native ES modules imports.
TypeScript
573
star
50

vue2-ssr-docs

Vue.js Server-Side Rendering Guide (for Vue 2)
563
star
51

vue-animated-list

A Vue.js plugin for easily animating `v-for` rendered lists.
JavaScript
462
star
52

vue-eslint-parser

The ESLint custom parser for `.vue` files.
TypeScript
444
star
53

vue-next-webpack-preview

JavaScript
424
star
54

vue-async-data

Async data loading plugin
JavaScript
417
star
55

vue-component-compiler

Compile a single file Vue component into a CommonJS module.
TypeScript
343
star
56

vue-cli-plugin-vue-next

A Vue CLI plugin for trying out vue-next (experimental)
JavaScript
339
star
57

blog

📝 The official Vue.js blog
Vue
331
star
58

eslint-config-vue

JavaScript
327
star
59

component-compiler-utils

Lower level utilities for compiling Vue single file components
TypeScript
321
star
60

tsconfig

Base tsconfig for Vue 3 projects.
301
star
61

vue-test-utils-jest-example

Example project using Jest + vue-test-utils together
JavaScript
296
star
62

vue-template-explorer

Vue template compilation explorer
Vue
267
star
63

vue-codemod

Vue.js codemod scripts
TypeScript
261
star
64

events

Source code for the new Vue.js Events page
Vue
250
star
65

jp.vuejs.org

🇯🇵 Japanese translation for vuejs.org
JavaScript
244
star
66

theme

VitePress theme for vuejs.org.
Vue
236
star
67

v3-migration-guide

Vue 2 -> Vue 3 migration guide
JavaScript
218
star
68

vue-element

register a custom element with Vue.js.
JavaScript
209
star
69

vue-curated

🖼️ The curated Vue packages list
178
star
70

Discussion

Vue.js discussion
167
star
71

vuex-observable

Consume Vuex actions as Observables using RxJS 5
JavaScript
155
star
72

vue-issue-helper

Vue
145
star
73

composition-api-converter

Automatically migrate components to the Function API
JavaScript
145
star
74

art

🎨 Artworks
127
star
75

babel-preset-vue-app

Babel preset for Vue app.
JavaScript
124
star
76

eslint-config-typescript

eslint-config-typescript for vue projects
JavaScript
115
star
77

vue-router-demos

Live demos for vue-router
Vue
107
star
78

eslint-plugin-vue-libs

Eslint plugin for Vue internal development
JavaScript
106
star
79

laravel-elixir-vue-2

Laravel Elixir Vue 2.0 support plugin
JavaScript
105
star
80

vue-test-utils-mocha-webpack-example

Example project using mocha-webpack and vue-test-utils
JavaScript
104
star
81

composition-api-rfc

Vuepress render for the Composition API RFC
JavaScript
104
star
82

ecosystem-ci

Vue Ecosystem CI
TypeScript
92
star
83

babel-preset-vue

Babel preset for transforming Vue JSX.
JavaScript
88
star
84

vue-test-utils-getting-started

Demo project for `vue-test-utils`
JavaScript
81
star
85

vue-webpack-meteor-example

Example using Vue with Meteor, while leveraging the normal Webpack + NPM workflow for your front-end.
Vue
78
star
86

eslint-config-airbnb

ESLint Shareable Configs for Airbnb JavaScript Style Guide in Vue.js Projects
JavaScript
71
star
87

vue-requests

Need a Vue.js module or looking for ideas?
69
star
88

news.vuejs.org

Vue.js News Portal
Vue
67
star
89

vue-curated-client

Official curation list client
Vue
65
star
90

eslint-config-prettier

eslint-config-prettier for vue-cli
JavaScript
65
star
91

vue-test-utils-typescript-example

Example project using TypeScript, Jest + vue-test-utils together
Vue
61
star
92

vue-template-es2015-compiler

Support a subset of handy ES2015 features in Vue 2.0 templates.
JavaScript
61
star
93

create-vue-templates

Snapshots of the generated templates of `npm create vue@latest`
Vue
44
star
94

create-eslint-config

Utility to setup ESLint in Vue.js projects.
JavaScript
43
star
95

eslint-config-standard

ESLint Shareable Configs for JavaScript Standard Style in Vue.js Projects
JavaScript
40
star
96

vue-ssr-html-stream

Transform stream to simplify Vue SSR streaming
HTML
39
star
97

it.vuejs.org

Italian translation for vuejs.org 🇮🇹
JavaScript
35
star
98

systemjs-plugin-vue

SystemJS plugin for Vue single file components
JavaScript
34
star
99

test-utils-docs

Docs for vue-test-utils-next
JavaScript
33
star
100

vue-curated-server

JavaScript
31
star