History

Evan You 597ada36ed test: tests for v-bind transform		2019-09-24 22:03:28 -04:00
..
__tests__	test: add tests for rendererChildren (#52 )	2019-09-20 18:17:35 -04:00
src	test: tests for v-bind transform	2019-09-24 22:03:28 -04: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
jsx.d.ts	types: bump TS version + type test for createComponent	2019-05-30 22:09:48 +08:00
package.json	build: use api-extractor for type rollup	2019-09-03 12:16:22 -04:00
README.md	types: use stricter HostNode typings	2019-09-06 16:58:32 -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({
  pathcProp,
  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.