docs: add information about the optimize option

closes #48
This commit is contained in:
Haoqun Jiang 2025-02-09 02:36:21 +08:00
parent f84b81afac
commit 02f5fec0a0
No known key found for this signature in database
GPG Key ID: BC1665FD8DE94CD5
2 changed files with 6 additions and 2 deletions

View File

@ -41,7 +41,9 @@ Type: `boolean`
Default: `false`
是否开启优化. 如果你对 Vue 3 不太熟悉,不建议打开
开启此选项后JSX 插件会尝试使用 [`PatchFlags`](https://cn.vuejs.org/guide/extras/rendering-mechanism#patch-flags) 和 [`SlotFlags`](https://github.com/vuejs/core/blob/v3.5.13/packages/runtime-core/src/componentSlots.ts#L69-L77) 来优化运行时代码从而提升渲染性能。需要注意的是JSX 的灵活性远高于模板语法,这使得编译优化的可能性相对有限,其优化效果会比 Vue 官方模板编译器更为有限。
优化后的代码会选择性地跳过一些重渲染操作以提高性能。因此,建议在开启此选项后对应用进行完整的测试,确保所有功能都能正常工作。
#### isCustomElement

View File

@ -41,7 +41,9 @@ Type: `boolean`
Default: `false`
enable optimization or not. It's not recommended to enable it If you are not familiar with Vue 3.
When enabled, this plugin generates optimized runtime code using [`PatchFlags`](https://vuejs.org/guide/extras/rendering-mechanism#patch-flags) and [`SlotFlags`](https://github.com/vuejs/core/blob/v3.5.13/packages/runtime-core/src/componentSlots.ts#L69-L77) to improve rendering performance. However, due to JSX's dynamic nature, the optimizations are not as comprehensive as those in Vue's official template compiler.
Since the optimized code may skip certain re-renders to improve performance, we strongly recommend thorough testing of your application after enabling this option to ensure everything works as expected.
#### isCustomElement