vue2 组件库之vetur提示

当我们开发完自定义UI组件库后,在项目中使用时,想要达到以下提示效果,组件提示与属性提示,有什么解决方案呢:

 事实上,这是vetur的功能,原文如下:

Component Data | Vetur

If a package listed in dependencies has a vetur key in its package.json, then Vetur will try to read the tags / attributes specified by that key.

{
  "vetur": {
    "tags": "dist/vetur/tags.json",
    "attributes": "dist/vetur/attributes.json"
  }
}

By bundling the tags / attributes definitions together with the framework library, you ensure that users will always get the matching tags / attributes with the specific version of your library they are using.

我的步骤如下:

1、package.json

"vetur": {
    "tags": "./vetur/tags.json",
    "attributes": "./vetur/attributes.json"
  }

2、tags.json

{
  "Card": {
    // description放在首位,否则无法识别
    "description": "这是一个全新的筛选框架组件",
    // "slotTip", "emitTip" 扩展slot与emit,这两个不在props中。
    "attributes": ["type","slotTip", "emitTip"]
  }
}

3、attributes.json

{
  "type": {"description": "类型"},
  "slotTip": {"description": "包含以下slot:title、content"},
  "emitTip": {"description": "包含以下Events:query(説明:插槽searchInput的@keyup.enter.native的事件)"}
}

 发布npm,项目更新私库(有时需要重启vscode)之后,便可以了。

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

韩小浪~~

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值