如何在Ruby on Rails项目中安装使用@bigheads/core包?
Ruby on Rails 项目安装@bigheads/core的实操步骤
前置操作:安装npm包
在项目根目录执行官方给出的安装命令:
yarn add @bigheads/core
分场景适配引入逻辑
Rails项目根据前端技术栈的不同,引入组件的操作略有区别,匹配你对应的项目场景操作即可:
场景1:使用jsbundling-rails(基于esbuild/rollup的构建式前端栈)
这是最贴合官方通用指引的场景,可直接在app/javascript目录下的JSX文件中引入组件,示例文件路径可选择app/javascript/components/BigHeadExample.jsx,代码内容如下:
import { BigHead } from '@bigheads/core' const BigHeadExample = () => ( <BigHead accessory="shades" body="chest" circleColor="blue" clothing="tankTop" clothingColor="black" eyebrows="angry" eyes="wink" facialHair="mediumBeard" graphic="vue" hair="short" hairColor="black" hat="none" hatColor="green" lashes={false} lipColor="purple" mask={true} faceMask={true} mouth="open" skinTone="brown" /> ) export default BigHeadExample
注意:官方示例里的布尔值参数不要加引号,否则会被识别为字符串传参,导致组件渲染异常。
后续如果要在Rails视图中挂载该组件,通过Rails对应的React挂载逻辑,把组件渲染到指定的DOM节点上即可。
场景2:使用importmap-rails(无构建的原生ESM方案)
该场景无需通过构建工具打包,需要在config/importmap.rb中添加@bigheads/core的模块映射规则,之后即可在JS文件中使用和上方一致的import语法引入组件,注意要确保项目已配置ESM兼容的polyfill,适配老旧浏览器。
场景3:旧版项目使用Webpacker
执行完yarn安装命令后,无需额外修改配置,重启本地开发服务,即可直接在packs对应的JSX文件中引入组件,Webpacker会自动处理依赖编译。
常见排错提示
- 如果启动开发服务时报“模块找不到”的错误,先检查yarn安装是否完成、
node_modules目录是否正常生成,同时确认项目已安装@bigheads/core所需的peer依赖(React、ReactDOM) - 如果JSX语法报错,检查对应构建工具的Babel配置,是否已开启React语法识别规则
内容的提问来源于stack exchange,提问作者João Victor Valentim
相关产品推荐
相关产品推荐

