History

Evan You 3ad9dc4880 release: v3.2.8		2021-09-02 14:46:30 -04:00
..
__tests__	build(deps-dev): bump typescript from 4.3.5 to 4.4.2 (#4482 )	2021-09-02 09:53:57 -04:00
src	build(deps-dev): bump typescript from 4.3.5 to 4.4.2 (#4482 )	2021-09-02 09:53:57 -04:00
types	feat(experimental): expose ref macro types using separate d.ts file	2021-08-23 20:35:12 -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.2.8	2021-09-02 14:46:30 -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.