History

Evan You 7859e4bce3 feat(transition): CSS transition for runtime-dom		2019-11-22 15:35:41 -05:00
..
__tests__	test(runtime-core): add tests for scheduler (#462 )	2019-11-16 16:32:06 -05:00
src	feat(transition): CSS transition for runtime-dom	2019-11-22 15:35:41 -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
LICENSE	chore: license	2019-10-28 11:15:17 -04:00
package.json	build: use api-extractor for type rollup	2019-09-03 12:16:22 -04:00
README.md	chore: fix typo (#339 )	2019-10-21 10:04:34 -04: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, createAppAPI } 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.