ARTICLE DETAIL

资讯详情

深耕郑州网站建设与运营推广的一线实战洞察。

@svgr/babel-plugin-add-jsx-attribute 完全指南:为 SVG 转换产物注入 JSX 属性

@svgr/babel-plugin-add-jsx-attribute 完全指南:为 SVG 转换产物注入 JSX 属性 前端开发工具【免费下载链接】svgrTransform SVGs into React components 项目地址https://gitcode.com/gh_mirrors/sv/svgr点击查看免费下载本指南以 SVGR 仓库中svgr/babel-plugin-add-jsx-attribute插件的官方文档为主体结合其 TypeScript 源码与测试用例系统讲解该 Babel 插件的安装方式、配置结构、属性注入规则与底层实现原理。读完本文你将能够独立为任意 JSX 元素批量添加静态或动态属性并在 SVGR 的svgProps、ref、expandProps等高层配置中理解该插件的实际作用。插件定位SVGR 属性注入的最小 Babel 单元svgr/babel-plugin-add-jsx-attribute是 SVGR 生态中的一个独立 Babel 插件核心能力只有一个向指定的 JSX 元素上添加或替换属性。它不关心 SVG 如何解析、JSX 如何生成只负责在 Babel 遍历 AST 时对匹配的元素节点执行属性注入是典型的单一职责式 Babel 插件设计。它的价值在于可组合性一方面可以被任何 Babel 工程直接引用另一方面SVGR 的svgr/babel-preset正是通过把svgProps、ref、titleProp、descProp、expandProps等高层选项翻译成该插件的attributes数组来工作的详见下文集成章节。从 babel-preset 源码 可以看到addJSXAttribute以{ elements: [svg, Svg], attributes: toAddAttributes }的形式被挂载到 preset 的插件列表中。安装该插件发布在 npm 上使用包管理器安装为开发依赖npm install --save-dev svgr/babel-plugin-add-jsx-attribute安装前提见 package.jsonpeerDependenciesbabel/core^7.0.0-0因为插件运行在 Babel 转换管线中enginesNode.js 14插件遵循 MIT 协议。快速上手最小配置示例在项目根目录的.babelrc或babel.config.json中注册插件。官方 README 给出的完整示例{ plugins: [ [ svgr/babel-plugin-add-jsx-attribute, { elements: [svg], attributes: [ { name: width, value: 200, spread: false, literal: false, position: end } ] } ] ] }这段配置的语义是遍历所有名为svg的 JSX 开标签元素在其属性列表末尾追加一个普通属性width200。实际转换效果等价于// 转换前 svg / // 转换后 svg width200 /其中每个字段都可以省略——源码 index.ts 为value、spread、literal、position提供了默认值分别是null、false、false、end。配置参数详解插件对外暴露的选项结构定义在 index.ts选项类型必填说明elementsstring[]是要注入属性的 JSX 元素名白名单例如[svg]只有命中的元素才会被处理attributesAttribute[]是要注入的属性描述数组可一次注入多个属性按数组顺序依次处理单个Attribute的字段如下字段类型默认值说明namestring无必填属性名。普通模式下生成jsxIdentifierspread模式下作为展开的标识符名valueboolean \| number \| string \| nullnull属性值。不同数据类型会生成不同的 AST 节点见下文取值规则spreadbooleanfalse为true时生成展开属性如{...props}此时value、literal被忽略literalbooleanfalse为true时把字符串值当作一段 JS 表达式源码解析而不是字符串字面量positionstart \| endend新属性插入位置start插入到属性列表开头end追加到末尾value 取值规则四种数据类型的 AST 生成逻辑getAttributeValue函数index.ts按value的类型分派生成不同的 Babel AST 节点测试用例 index.test.ts 给出了可验证的转换结果布尔值value: true→ 生成表达式容器包裹的布尔字面量输出disabled{true}数值value: 200→ 生成numericLiteral输出disabled{200}字符串非 literalvalue: true→ 生成stringLiteral输出disabledtrue注意与布尔值的区别带引号是字符串属性字符串literal: true使用babel/core的template.ast(value)将字符串当作 JS 表达式源码解析输出表达式容器。例如{ name: ref, value: ref, literal: true }生成ref{ref}value: ref ? ref : null则生成ref{ref ? ref : null}这一能力特别适合注入依赖变量或三元表达式的动态属性value: null默认生成不带值的布尔属性如div disabled /。spread: true时走getAttribute的另一分支index.ts生成jsxSpreadAttribute(t.identifier(name))即展开属性{...name}。position 与插入位置unshiftContainer / pushContainerposition字段在源码中对应一个查表映射index.tsconst positionMethod { start: unshiftContainer, end: pushContainer, } as conststart调用 Babel 节点容器的unshiftContainer方法把属性插入到最前面end调用pushContainer追加到末尾。测试用例验证了两个方向的展开属性// spread: true, position: start div {...props} foospan //div // spread: true, position: end divspan foobar {...props} //div同名属性替换不是简单追加一个容易被忽略但很实用的行为当目标元素上已存在同名属性时插件会替换而不是重复添加。源码中的isEqualAttributeindex.ts区分两种匹配展开模式下匹配同名的JSXSpreadAttribute比较argument是否为同标识符普通模式下匹配同名的JSXAttribute比较属性名。匹配成功后调用attribute.replaceWith(newAttribute)完成替换index.ts若列表中不存在同名属性才执行插入。测试用例 index.test.ts 展示了替换效果div disabled /在注入{ name: disabled, value: false }后变为div disabled{false} /。这意味着你可以把该插件当作属性归一化工具强制统一某些属性的值。在 SVGR 工作流中的实际集成1. 作为 preset 的底层引擎svgr/babel-preset会把多个高层选项翻译成该插件的attributes数组babel-preset 源码svgProps对象键值对经propsToAttributes转换为属性数组值若以{开头、}结尾则剥掉花括号并把literal置为trueindex.ts例如{ focusable: {true} }最终注入focusable{true}ref注入{ name: ref, value: ref, literal: true }即ref{ref}titleProp注入aria-labelledby{titleId}literal: truedescProp注入aria-describedby{descId}literal: trueexpandProps注入{ name: props, spread: true, position: start | end }将position直接透传给插件。因此当你在.svgrrc或 CLI 中使用--svg-propsoptions.mdx时最终都是经由本插件落到 JSX 输出上的。2. 作为 plugin-jsx 的自定义转换svgr/plugin-jsx允许通过jsx.babelConfig扩展 Babel 转换管线官方示例plugin-jsx README展示了如何组合使用属性类插件// .svgrrc.js module.exports { jsx: { babelConfig: { plugins: [ [ svgr/babel-plugin-add-jsx-attribute, { elements: [svg], attributes: [{ name: data-testid, value: icon }], }, ], ], }, }, }这样可以在不修改 preset 默认行为的前提下为转换出的svg根元素补充测试钩子或自定义属性。测试验证与行为边界插件的全部行为都由 index.test.ts 中的快照测试锁定覆盖了五类场景简单属性div disabled /带值属性布尔、字符串、数值三种类型的输出差异literal 属性ref{ref}与ref{ref ? ref : null}展开属性start/end两种位置同名属性替换。测试通过babel/core的transform配合babel/plugin-syntax-jsx运行configFile: false确保不读取项目 Babel 配置隔离了外部干扰。如需在自己的项目中验证可按同样的方式配置 Babel 后编写对应转换用例。小结svgr/babel-plugin-add-jsx-attribute虽然 README 篇幅不长却承担着 SVGR 体系中所有向 JSX 注入属性的任务。掌握它的elements/attributes配置、value四类取值语义、spread展开、position插入方向以及同名替换机制既能独立驾驭这一 Babel 插件也能透彻理解 SVGR 高层选项svgProps、ref、expandProps等背后的实现路径。相关源码与测试均位于仓库 packages/babel-plugin-add-jsx-attribute 目录下可作为继续深入 Babel 插件开发的参考起点。赞分享前端开发工具【免费下载链接】svgrTransform SVGs into React components 项目地址https://gitcode.com/gh_mirrors/sv/svgr点击查看免费下载相关推荐BBDown构建专业级B站视频下载工作流的技术指南BBDown构建专业级B站视频下载工作流的技术指南 Bilibili视频下载、命令行工具、高清视频处理、批量下载、开源下载器 在当今数字内容消费时代高效管理前端开发工具svgr/babel-plugin-replace-jsx-attribute-value 深度指南批量替换 JSX 属性值的最佳实践svgr/babel plugin replace jsx attribute value 深度指南批量替换 JSX 属性值的最佳实践 导读 svgr/b前端开发工具svgr/babel-plugin-remove-jsx-attribute从 JSX 中精准移除冗余属性的 Babel 插件svgr/babel plugin remove jsx attribute从 JSX 中精准移除冗余属性的 Babel 插件 导读 svgr/babel前端开发工具上一篇1分钟生成专业个人站self.so开源构建器全攻略2025下一篇HeliBoard隐私优先、高度自定义的开源键盘创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
返回列表