History

GU Yiling 9b160b9405 fix(types): declared prop keys should always exist in `props` argument (#3726 )		2021-05-12 17:47:31 -04:00
..
__tests__	fix(hydration): fix update before async component is hydrated (#3563 )	2021-05-07 18:42:58 -04:00
src	fix(types): declared prop keys should always exist in `props` argument (#3726 )	2021-05-12 17:47:31 -04:00
types	fix(types): augment ref unwrap bail types in appropriate packages	2020-05-01 16:14:30 -04:00
LICENSE	…
README.md	…
api-extractor.json	refactor(types): mark internal API exports and exclude from d.ts	2020-04-30 17:04:35 -04:00
index.js	…
package.json	release: v3.1.0-beta.3	2021-05-12 17:37:04 -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 } 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.