vue3-core/packages/runtime-core
Evan You ba9c2ae247
feat(compiler-sfc): enable reactive props destructure by default and deprecate withDefaults() (#7986)
2023-03-30 11:58:16 +08:00
..
__tests__ fix(compiler-sfc): fix function default value handling w/ props destructure 2023-03-29 22:21:27 +08:00
src feat(compiler-sfc): enable reactive props destructure by default and deprecate withDefaults() (#7986) 2023-03-30 11:58:16 +08:00
types feat(compiler-sfc): add defineOptions macro (#5738) 2023-03-28 10:43:51 +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.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.