Demo 插件介绍

• Demo 插件介绍
  • 1. 概要说明
    • 1.1 地址
    • 1.2 插件描述
    • 1.3 重要依赖
    • 1.4 插件安装
  • 2. 包说明
    • 2.1 属性说明
    • 2.2 事件说明
    • 2.3 实例暴露说明
  • 3. 示例
    • 3.1 全局注册使用
    • 3.2 模板组件使用

1. 概要说明

1.1 地址

https://gitee.com/duqingbing/ts-v3-package/tree/ts-v3-demo

1.2 插件描述

vite + ts + vue3 + element-plus 封装的 Demo 插件

1.3 重要依赖

• 无

1.4 插件安装

# yarn 安装
yarn add @qingbing/ts-v3-demo

# npm 安装
npm i @qingbing/ts-v3-demo

2. 包说明

2.1 属性说明

| 属性名 | 类型 | 是否必需 | 默认值 | 意义 | | :------ | :----- | :------- | :------------- | :------- | | message | String | 否 | "Hello plugin" | 显示消息 |

2.2 事件说明

| 事件名 | 类型 | 意义 | | :------- | :--------- | :------- | | onChange | () => void | 修改事件 | | onUpdate | () => void | 更新事件 |

2.3 实例暴露说明

| 属性名 | 类型 | | :----- | :--- | | - | 无 |

3. 示例

3.1 全局注册使用

• 一旦注册， Demo 作为组件全局通用
• 使用方法参考 3.2 模板组件使用, 去掉组件导入的语句即可

// main.ts
import { DemoPlugin } from '@qingbing/ts-v3-demo'
app.use(DemoPlugin, {
  name: 'Demo',
  options: {}
})

3.2 模板组件使用

<template>
    <div>
        <Demo />
        <Demo @on-update="handleUpdate" @on-change="handleChange" message="This is test demo" />
    </div>
</template>

<script lang="ts" setup>
import type { Ref } from 'vue'
import { Demo } from '@qingbing/ts-v3-demo' // 如果注册成了全局组件，这句将不再需要

const handleChange = () => {
    console.log("change 事件");
}

const handleUpdate = (msg: Ref<string>) => {
    msg.value = "内部消息被外部改变了；点击时间: " + new Date() + "。"
}
</script>