History

Evan You b40fcbc4c6 fix(types): augment ref unwrap bail types in appropriate packages Packages can now augment the ref unwrap bail types in their own `d.ts`. Also updated the build script to auto concat any files in a package's `types` directory to the final generated `d.ts`. - `@vue/reactivity` should no longer require `libs: ["DOM"]` in tsconfig - Properly bail on `VNode` and `ComponentPublicInstance` in runtime-core		2020-05-01 16:14:30 -04:00
..
__tests__	refactor(types): mark more internal APIs	2020-05-01 10:37:40 -04:00
src	fix(types): augment ref unwrap bail types in appropriate packages	2020-05-01 16:14:30 -04:00
types	fix(types): augment ref unwrap bail types in appropriate packages	2020-05-01 16:14:30 -04:00
api-extractor.json	refactor(types): mark internal API exports and exclude from d.ts	2020-04-30 17:04:35 -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	release: v3.0.0-beta.5	2020-04-30 16:20:25 -04:00
README.md	chore: update readme	2019-12-09 14:06:31 -05: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.