History

Evan You 27e1e38641 release: v3.3.0-alpha.5		2023-03-26 16:52:46 +08:00
..
__tests__	fix(build): avoid const enum conflicts	2023-02-06 09:44:12 +08:00
src	fix(types): ensure defineProps with generics return correct types	2023-03-26 15:58:04 +08:00
types	build: remove api-extractor	2023-02-03 15:57:00 +08:00
LICENSE	…
README.md	chore: remove yarn reference	2022-11-14 19:03:51 +08:00
index.js	…
package.json	release: v3.3.0-alpha.5	2023-03-26 16:52:46 +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.