JSX+
该插件支持了一种 JSX 扩展语法 JSX+,它能帮助业务开发者更爽更快地书写 JSX。JSX+ 不是一种新的概念,它是 JSX 基础上的扩展指令概念。
为什么需要 JSX+
- JSX 虽然语法灵活,但是大量的花括号 + JS 语法导致了上下文切换和代码可读性的下降,JSX+ 的指令很好的解决了这个问题
- JSX 本质是 JS 表达式,在运行时阶段才可以计算出真实的 DOM 结构,JSX+ 引入了一部分静态模板特性可以满足编译优化
- 不新创造实体,指令在社区中是已经被广泛接受的概念,对开发者更友好,语法糖的表达更简单
- 统一一套 JSX+ 类似概念的语法规范,减少已存在和潜在的重复建设
安装使用
首先需要安装依赖:
$ npm i babel-runtime-jsx-plus --save
$ npm i @ice/pkg-plugin-jsx-plus --save-dev
然后把 jsx+ 插件加入到配置文件中:
build.config.mts
import { defineConfig } from '@ice/pkg';
export default defineConfig({
plugins: [
['@ice/pkg-plugin-jsx-plus'],
],
})
然后你就可以使用更强大的 JSX+ 语法了:
function ExampleComponent(props) {
const { isAdmin, dataSource } = props;
return (
<div>
<div x-if={isAdmin}>admin</div>
<div x-else>guest</div>
<div x-for={item in dataSource}>
<span>{item.name}</span>
</div>
</div>
);
}
指令语法
条件判断
<div x-if={condition}>Hello</div>
<div x-elseif={anotherCondition}>World</div>
<div x-else>NothingElse</div>
提示
x-elseif
可以多次出现,但是顺序必须是 x-if -> x-elseif -> x-else,且这些节点是兄弟节点关系,如顺序错误则指令被忽略。
循环列表
{/* Array or Plain Object*/}
<tag x-for={item in foo}>{item}</tag>
<tag x-for={(item, key) in foo}>{key}: {item}</tag>
说明:
- 若循环对象为数组,key 表示循环索引,其类型为 Number。
- 当
x-for
与x-if
同时作用在同一节点上时,循环优先级大于条件,即循环的item
和index
可以在子条件判断中使用。
单次渲染
仅在首次渲染时会触发 createElement
并将其引用缓存,重新渲染时直接复用缓存,用于提高不带绑定节点渲染效率和 Diff 性能。
<p x-memo>this paragragh {mesasge} content will not change.</p>
插槽指令
类似 WebComponents 的 slot 概念,并提供插槽作用域。
语法:
<tag x-slot:slotName="slotScope" />
示例:
// Example
<Waterfall>
<view x-slot:header>header</view>
<view x-slot:item="props">{props.index}: {props.item}</view>
<view x-slot:footer>footer</view>
</Waterfall>
<slot name="header" /> // 槽位
对比传统 JSX:
<Waterfall
renderHeader={() => (<view>header</view>)}
renderFooter={() => (<view>footer</view>)}
renderItem={(item, index) => (<view>{index}: {item}</view>}
/>
对比小程序:
<Waterfall>
<view slot="header">header</view>
<view slot="item" slot-scope="props">{props.index}: {props.item}</view>
<view slot="footer">footer</view>
</Waterfall>
Fragment 组件
提供空组件,不产生 UI,提供绑定 x-if
x-for
x-slot
指令。
<Fragment />
类名绑定
语法:
<div x-class={{ item: true, active: val }} />
参考实现:
<div className={classnames({ item: true, active: val})} />
classnames
方法能力参考同名 npm 包。
更多请参考 jsx-plus
插件选项
moduleName
- 类型:
'react' | 'rax'
- 默认值:
'react'
指定当前从哪个模块中导入 jsx.Fragment
组件,以在转换 JSX+ 语法的时候从对应的模块中引入组件。比如如果使用 rax
:
build.config.mts
import { defineConfig } from '@ice/pkg';
export default defineConfig({
plugins: [
['@ice/pkg-plugin-jsx-plus', { moduleName: 'rax' }],
],
})