History

Evan You 52cc7e8231 refactor(directives): remove binding.instance BREAKING CHANGE: custom directive bindings no longer expose instance This is a rarely used property that creates extra complexity in ensuring it points to the correct instance. From a design perspective, a custom directive should be scoped to the element and data it is bound to and should not have access to the entire instance in the first place.		2020-02-25 19:35:48 -05:00
..
__tests__	refactor(directives): remove binding.instance	2020-02-25 19:35:48 -05:00
src	refactor(directives): remove binding.instance	2020-02-25 19:35:48 -05:00
LICENSE	chore: license	2019-10-28 11:15:17 -04:00
README.md	chore: update readme	2019-12-09 14:06:31 -05:00
api-extractor.json	build: use api-extractor for type rollup	2019-09-03 12:16:22 -04:00
index.js	refactor: rename packages	2018-10-26 15:44:50 -04:00
package.json	release: v3.0.0-alpha.6	2020-02-22 08:25:32 +01:00

README.md

@vue/runtime-core

This package is published only for typing and building custom renderers. It is NOT meant to be used in applications.

For full exposed APIs, see src/index.ts. You can also run yarn build runtime-core --types from repo root, which will generate an API report at temp/runtime-core.api.md.

Building a Custom Renderer

import { createRenderer } from '@vue/runtime-core'

const { render, createApp } = createRenderer({
  patchProp,
  insert,
  remove,
  createElement,
  // ...
})

// `render` is the low-level API
// `createApp` returns an app instance with configurable context shared
// by the entire app tree.
export { render, createApp }

export * from '@vue/runtime-core'

See @vue/runtime-dom for how a DOM-targeting renderer is implemented.