百科狗-知识改变命运!
--

JSX - TypeScript 模块类型

乐乐1年前 (2023-11-21)阅读数 24#技术干货
文章标签类型

JSX

JSX 是一种嵌入式的类似 XML 的语法。它可以被转换成合法的 JavaScript,尽管转换的语义是依据不同的实现而定的。JSX 因 React 框架而流行,但也存在其它的实现。TypeScript 支持内嵌,类型检查以及将 JSX 直接编译为 JavaScript。


基本用法

想要使用 JSX 必须做两件事:

  1. 给文件一个.tsx扩展名
  2. 启用jsx选项

TypeScript 具有三种 JSX 模式:

  • preserve:在preserve模式下生成代码中会保留 JSX 以供后续的转换操作使用(比如:Babel)。另外,输出文件会带有.jsx扩展名。
  • reactreact模式会生成React.createElement,在使用前不需要再进行转换操作了,输出文件的扩展名为.js。
  • react-nativereact-native相当于preserve,它也保留了所有的 JSX,但是输出文件的扩展名是.js。

这些模式只在代码生成阶段起作用,类型检查并不受影响。

模式输入输出输出文件扩展名
preserve
.jsx
react
React.createElement("div").js
react-native
.js

你可以通过在命令行里使用--jsx标记或tsconfig.json里的选项来指定模式。

注意:当输出目标为react JSX时,你可以使用--jsxFactory指定 JSX 工厂函数(默认值为React.createElement


as 操作符

回想一下怎么写类型断言:

var foo = bar;

这里断言bar变量是foo类型的。因为 TypeScript 也使用尖括号来表示类型断言,在结合 JSX 的语法后将带来解析上的困难。因此,TypeScript 在.tsx文件里禁用了使用尖括号的类型断言。

由于不能够在.tsx文件里使用上述语法,因此我们应该使用另一个类型断言操作符:as。上面的例子可以很容易地使用as操作符改写:

var foo = bar as foo;

as操作符在.ts和.tsx里都可用,并且与尖括号类型断言行为是等价的。


类型检查

为了理解 JSX 的类型检查,你必须首先理解固有元素与基于值的元素之间的区别。假设有这样一个 JSX 表达式expr可能引用环境自带的某些东西(比如,在 DOM 环境里的divspan)或者是你自定义的组件。这是非常重要的,原因有如下两点:

  1. 对于 React,固有元素会生成字符串(React.createElement("div")),然而由你自定义的组件却不会生成(React.createElement(MyComponent))。
  2. 传入 JSX 元素里的属性类型的查找方式不同。内在元素属性本身就支持,然而自定义的组件会自己去指定它们具有哪个属性。

TypeScript 使用与 React 相同的规范来区别它们。固有元素总是以一个小写字母开头,基于值的元素总是以一个大写字母开头。


固有元素

固有元素使用特殊的接口JSX.IntrinsicElements来查找。默认地,如果这个接口没有指定,会全部通过,不对固有元素进行类型检查。然而,如果这个接口存在,那么固有元素的名字需要在JSX.IntrinsicElements接口的属性里查找。例如:

declare namespace JSX {
    interface IntrinsicElements {
        foo: any
    }
}

; // 正确
; // 错误

在上例中,没有问题,但是会报错,因为它没在JSX.IntrinsicElements里指定。

注意:你也可以在JSX.IntrinsicElements上指定一个用来捕获所有字符串索引:

declare namespace JSX {
    interface IntrinsicElements {
        [elemName: string]: any;
    }
}


基于值的元素

基于值的元素会简单的在它所在的作用域里按标识符查找。

import MyComponent from "./myComponent";

; // 正确
; // 错误

有两种方式可以定义基于值的元素:

  1. 函数组件(FC)
  2. 类组件

由于这两种基于值的元素在 JSX 表达式里无法区分,因此 TypeScript 首先会尝试将表达式做为函数组件进行解析。如果解析成功,那么 TypeScript 就完成了表达式到其声明的解析操作。如果按照函数组件解析失败,那么 TypeScript 会继续尝试以类组件的形式进行解析。如果依旧失败,那么将输出一个错误。


函数组件

正如其名,组件被定义成 JavaScript 函数,它的第一个参数是props对象。TypeScript 会强制它的返回值可以赋值给JSX.Element

interface FooProp {
  name: string;
  X: number;
  Y: number;
}

declare function AnotherComponent(prop: {name: string});
function ComponentFoo(prop: FooProp) {
  return ;
}

const Button = (prop: {value: string}, context: { color: string }) => 

由于函数组件是简单的JavaScript函数,所以我们还可以利用函数重载。

interface ClickableProps {
  children: JSX.Element[] | JSX.Element
}

interface HomeProps extends ClickableProps {
  home: JSX.Element;
}

interface SideProps extends ClickableProps {
  side: JSX.Element | string;
}

function MainButton(prop: HomeProps): JSX.Element;
function MainButton(prop: SideProps): JSX.Element {
  ...
}
注意:函数组件之前叫做无状态函数组件(SFC)。由于在当前 React 版本里,函数组件不再被当作是无状态的,因此类型SFC和它的别名StatelessComponent被废弃了。


类组件

我们可以定义类组件的类型。然而,我们首先最好弄懂两个新的术语:元素类的类型和元素实例的类型。

现在有,元素类的类型为Expr的类型。所以在上面的例子里,如果MyComponent是 ES6 的类,那么类类型就是类的构造函数和静态部分。如果MyComponent是个工厂函数,类类型为这个函数。

一旦建立起了类类型,实例类型由类构造器或调用签名(如果存在的话)的返回值的联合构成。再次说明,在ES6类的情况下,实例类型为这个类的实例的类型,并且如果是工厂函数,实例类型为这个函数返回值类型。

class MyComponent {
  render() {}
}

// 使用构造签名
var myComponent = new MyComponent();

// 元素类的类型 => MyComponent
// 元素实例的类型 => { render: () => void }

function MyFactoryFunction() {
  return {
    render: () => {
    }
  }
}

// 使用调用签名
var myComponent = MyFactoryFunction();

// 元素类的类型 => MyFactoryFunction
// 元素实例的类型 => { render: () => void }

元素实例的类型很有趣,因为它必须赋值给JSX.ElementClass或抛出一个错误。默认的JSX.ElementClass{},但是它可以被扩展用来限制 JSX 的类型以符合相应的接口。

declare namespace JSX {
  interface ElementClass {
    render: any;
  }
}

class MyComponent {
  render() {}
}
function MyFactoryFunction() {
  return { render: () => {} }
}

; // 正确
; // 正确

class NotAValidComponent {}
function NotAValidFactoryFunction() {
  return {};
}

; // 错误
; // 错误


属性类型检查

属性类型检查的第一步是确定元素属性类型。这在固有元素和基于值的元素之间稍有不同。

对于固有元素,这是JSX.IntrinsicElements属性的类型。

declare namespace JSX {
  interface IntrinsicElements {
    foo: { bar?: boolean }
  }
}

// `foo`的元素属性类型为`{bar?: boolean}`
;

对于基于值的元素,就稍微复杂些。它取决于先前确定的在元素实例类型上的某个属性的类型。至于该使用哪个属性来确定类型取决于JSX.ElementAttributesProperty。它应该使用单一的属性来定义。这个属性名之后会被使用。TypeScript 2.8,如果未指定JSX.ElementAttributesProperty,那么将使用类元素构造函数或函数组件调用的第一个参数的类型。

declare namespace JSX {
  interface ElementAttributesProperty {
    props; // 指定用来使用的属性名
  }
}

class MyComponent {
  // 在元素实例类型上指定属性
  props: {
    foo?: string;
  }
}

// `MyComponent`的元素属性类型为`{foo?: string}` 

元素属性类型用于的 JSX 里进行属性的类型检查。支持可选属性和必须属性。

declare namespace JSX {
  interface IntrinsicElements {
    foo: { requiredProp: string; optionalProp?: number }
  }
}

; // 正确
; // 正确
; // 错误, 缺少 requiredProp
; // 错误, requiredProp 应该是字符串
; // 错误, unknownProp 不存在
; // 正确, `some-unknown-prop`不是个合法的标识符
注意:如果一个属性名不是个合法的JS标识符(像data-*属性),并且它没出现在元素属性类型里时不会当做一个错误。

另外,JSX 还会使用JSX.IntrinsicAttributes接口来指定额外的属性,这些额外的属性通常不会被组件的 props 或 arguments 使用-比如 React 里的key。还有,JSX.IntrinsicClassAttributes泛型类型也可以用来为类组件(非函数组件)指定相同种类的额外属性。这里的泛型参数表示类实例类型。在React里,它用来允许Ref类型上的ref属性。通常来讲,这些接口上的所有属性都是可选的,除非你想要用户在每个 JSX 标签上都提供一些属性。

延展操作符也可以使用:

var props = { requiredProp: 'bar' };
; // 正确

var badProps = {};
; // 错误


子孙类型检查

从 TypeScript 2.3 开始,我们引入了children类型检查。children是元素属性类型的一个特殊属性(property),子JSXExpression将会被插入到属性里。与使用JSX.ElementAttributesProperty来决定props名类似,我们可以利用JSX.ElementChildrenAttribute来决定children名。JSX.ElementChildrenAttribute应该被声明在单一的属性(property)里。

declare namespace JSX {
  interface ElementChildrenAttribute {
    children: {};  // specify children name to use
  }
}

如不特殊指定子孙的类型,我们将使用 React typings 里的默认类型。

Hello

;

Hello

World
; const CustomComp = (props) =>
{props.children}
Hello World
{"This is just a JS expression..." + 1000}
interface PropsType {
  children: JSX.Element
  name: string
}

class Component extends React.Component {
  render() {
    return ( 

{this.props.children}

) } } // OK

Hello World

// Error: children is of type JSX.Element not array of JSX.Element

Hello World

Hello World

// Error: children is of type JSX.Element not array of JSX.Element or string.

Hello

World


JSX 结果类型

默认地 JSX 表达式结果的类型为any。你可以自定义这个类型,通过指定JSX.Element接口。然而,不能够从接口里检索元素,属性或JSX的子元素的类型信息。它是一个黑盒。


嵌入的表达式

JSX允许你使用{}标签来内嵌表达式。

var a = 
{['foo', 'bar'].map(i => {i / 2})}

上面的代码产生一个错误,因为你不能用数字来除以一个字符串。输出如下,若你使用了preserve选项:

var a = 
{['foo', 'bar'].map(function (i) { return {i / 2}; })}


React整合

要想一起使用 JSX 和 React,你应该使用 React 类型定义。这些类型声明定义了 JSX 合适命名空间来使用 React。

/// 

interface Props {
  foo: string;
}

class MyComponent extends React.Component {
  render() {
    return {this.props.foo} }
}

; // 正确
; // 错误


工厂函数

jsx: react编译选项使用的工厂函数是可以配置的。可以使用jsxFactory命令行选项,或内联的.jsx注释指令在每个文件上设置。比如,给createElement设置jsxFactory

会使用createElement("div")来生成,而不是React.createElement("div")

注释指令可以像下面这样使用(在TypeScript 2.8里):

import preact = require("preact");
/* @jsx preact.h */
const x = 
;

生成:

const preact = require("preact");
const x = preact.h("div", null);

JSX - TypeScript 模块类型

工厂函数的选择同样会影响JSX命名空间的查找(类型检查)。如果工厂函数使用React.createElement定义(默认),编译器会先检查React.JSX,之后才检查全局的JSX。如果工厂函数定义为h,那么在检查全局的JSX之前先检查h.JSX

鹏仔微信 15129739599 鹏仔QQ344225443 鹏仔前端 pjxi.com 共享博客 sharedbk.com

免责声明:我们致力于保护作者版权,注重分享,当前被刊用文章因无法核实真实出处,未能及时与作者取得联系,或有版权异议的,请联系管理员,我们会立即处理! 部分文章是来自自研大数据AI进行生成,内容摘自(百度百科,百度知道,头条百科,中国民法典,刑法,牛津词典,新华词典,汉语词典,国家院校,科普平台)等数据,内容仅供学习参考,不准确地方联系删除处理!邮箱:344225443@qq.com)

图片声明:本站部分配图来自网络。本站只作为美观性配图使用,无任何非法侵犯第三方意图,一切解释权归图片著作权方,本站不承担任何责任。如有恶意碰瓷者,必当奉陪到底严惩不贷!

内容声明:本文中引用的各种信息及资料(包括但不限于文字、数据、图表及超链接等)均来源于该信息及资料的相关主体(包括但不限于公司、媒体、协会等机构)的官方网站或公开发表的信息。部分内容参考包括:(百度百科,百度知道,头条百科,中国民法典,刑法,牛津词典,新华词典,汉语词典,国家院校,科普平台)等数据,内容仅供参考使用,不准确地方联系删除处理!本站为非盈利性质站点,本着为中国教育事业出一份力,发布内容不收取任何费用也不接任何广告!)