History

Evan You 78b86150b8 release: v3.3.0-alpha.4		2023-02-06 14:10:56 +08:00
..
__tests__	fix(build): avoid const enum conflicts	2023-02-06 09:44:12 +08:00
src	build: adjust dts test setup	2023-02-03 17:10:31 +08:00
types	build: remove api-extractor	2023-02-03 15:57:00 +08:00
LICENSE	chore: license	2019-10-28 11:15:17 -04:00
README.md	chore: remove yarn reference	2022-11-14 19:03:51 +08:00
index.js	refactor: rename packages	2018-10-26 15:44:50 -04:00
package.json	release: v3.3.0-alpha.4	2023-02-06 14:10:56 +08: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 pnpm 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.