ComponentEmits 读取组件的 defineEmits 类型,渲染事件名、参数签名与说明。
用法
| Event | Type |
|---|---|
change | [value: string](event: "change", value: string): void值变化时触发 |
delete | [](event: "delete"): void删除时触发 |
:component-emits{slug="TestApi"}
省略 slug 时按当前路由的最后一段查找组件。
编写事件说明
使用具名元组语法声明事件,并在每个事件上写 JSDoc。layer 在构建期从源码中解析这些注释,补全 vue-component-meta 无法读取的事件说明:
components/TestApi.vue
<script setup lang="ts">
defineEmits<{
/**
* 值变化时触发
* @see https://vuejs.org/guide/components/events.html
*/
change: [value: string]
/**
* 删除时触发
*/
delete: []
}>()
</script>
API
Props
| Prop | Default | Type |
|---|---|---|
slug | 路由路径的最后一段 | string获取组件事件的 slug 标识 |
Changelog
No recent changes