夜猫子的知识栈 夜猫子的知识栈
首页
  • 前端文章

    • JavaScript
  • 学习笔记

    • 《JavaScript教程》
    • 《Web Api》
    • 《ES6教程》
    • 《Vue》
    • 《React》
    • 《TypeScript》
    • 《Git》
    • 《Uniapp》
    • 小程序笔记
    • 《Electron》
    • JS设计模式总结
  • 《前端架构》

    • 《微前端》
    • 《权限控制》
    • monorepo
  • 全栈项目

    • 任务管理日历
    • 无代码平台
    • 图书管理系统
  • HTML
  • CSS
  • Nodejs
  • Midway
  • Nest
  • MySql
  • 其他
  • 技术文档
  • GitHub技巧
  • 博客搭建
  • Ajax
  • Vite
  • Vitest
  • Nuxt
  • UI库文章
  • Docker
  • 学习
  • 面试
  • 心情杂货
  • 实用技巧
  • 友情链接
收藏
  • 分类
  • 标签
  • 归档
GitHub (opens new window)

夜猫子

前端练习生
首页
  • 前端文章

    • JavaScript
  • 学习笔记

    • 《JavaScript教程》
    • 《Web Api》
    • 《ES6教程》
    • 《Vue》
    • 《React》
    • 《TypeScript》
    • 《Git》
    • 《Uniapp》
    • 小程序笔记
    • 《Electron》
    • JS设计模式总结
  • 《前端架构》

    • 《微前端》
    • 《权限控制》
    • monorepo
  • 全栈项目

    • 任务管理日历
    • 无代码平台
    • 图书管理系统
  • HTML
  • CSS
  • Nodejs
  • Midway
  • Nest
  • MySql
  • 其他
  • 技术文档
  • GitHub技巧
  • 博客搭建
  • Ajax
  • Vite
  • Vitest
  • Nuxt
  • UI库文章
  • Docker
  • 学习
  • 面试
  • 心情杂货
  • 实用技巧
  • 友情链接
收藏
  • 分类
  • 标签
  • 归档
GitHub (opens new window)
  • 基础

  • 响应式

  • 组件

  • 过渡&动画

  • 可复用性

  • 工具

  • 规模化

  • 路由(核心)

  • 组合式

  • Vuex

  • Pinia

  • 其他

    • 手动渲染虚拟dom
    • 全局事件总线($bus)
    • 全局方法和属性 createAPP
    • Vue3-TS 中使用 Express
    • watch监听Props属性值失败原因
    • main.js推荐配置
    • 脚手架前期基础配置
    • 跨域之config.js配置
    • Vue中的防抖函数封装和使用
    • vue的数据更新
    • 操作本地缓存
    • api使用流程
    • ajax封装及api的获取和配置
    • vue解析n字符
    • TS获取ref绑定元素
    • 解决vue3中Props无法引入外部类型
    • vue2升vue3注意事项
  • Vue3 源码学习记录

  • 《Vue》笔记
  • 其他
夜猫子
2023-08-17

解决vue3中Props无法引入外部类型

下面这种情况可以成功编译的。

<script setup lang="ts">
interface IProps {/* 一些类型定义*/}
const props = defineProps<IProps>();
</script>
1
2
3
4

但如果将类型定义抽取出来则会报错编译失败。

<script setup lang="ts">
import {IProps} from './types'
const props = defineProps<IProps>();
</script>
1
2
3
4

因为Vue SFC组件仅编译组件所在文件,无法分析到外部引入的类型定义。

关于该问题的讨论可以参考:issue (opens new window)。

终于在element plus源码中找到一个不错的解决方案。

element plus没有使用类型声明的方式定义props,而是使用传统的运行时声明方式定义props:

import type { PropType, ExtractPropTypes } from 'vue';
export const fooProps = {
  status: {
    type: String as PropType<'on' | 'off'>,
    required: true,
  },
};
export type FooProps = ExtractPropTypes<typeof fooProps >;
1
2
3
4
5
6
7
8

说明:

  • status是字面量类型,需要使用 vue 提供的 PropType 支持
  • ExtractPropTypes 作用是将props的类型定义抽取出来供外部使用

至此成功地将 props 的类型抽取出来了,但仍有一个小问题。

status 的类型推导成可选的了,而我们需要是必选的,下面我们再修改一下:

import type { PropType, ExtractPropTypes } from 'vue';
export const fooProps = {
  status: {
    type: String as PropType<'on' | 'off'>,
    required: true,
    default: null,
  },
};
export type FooProps = ExtractPropTypes<typeof fooProps >;
1
2
3
4
5
6
7
8
9

至此status的类型推导变成必选的了。

总结

  • 类型声明方式定义 defineProps 目前仅支持将props类型定义到组件所在文件中
  • 运行时声明方式定义 defineProps 体验较好些,但需要配合 PropType 和 ExtractPropTypes 使用

如果不需要将props类型抽取出来,则两种方式都可以。

编辑 (opens new window)
上次更新: 2023/8/22 19:22:36
TS获取ref绑定元素
vue2升vue3注意事项

← TS获取ref绑定元素 vue2升vue3注意事项→

最近更新
01
IoC 解决了什么痛点问题?
03-10
02
如何调试 Nest 项目
03-10
03
Provider注入对象
03-10
更多文章>
Copyright © 2019-2025 Study | MIT License
  • 跟随系统
  • 浅色模式
  • 深色模式
  • 阅读模式