如何将VanillaJS编写的InCHlib开源库集成到React项目中使用
纯VanillaJS版本InCHlib库集成React项目实操步骤
1. 前置静态依赖配置
这个库原生依赖3个需按固定顺序加载的脚本,没有打包成可直接import的npm包,最稳妥的引入方式是通过项目public目录托管静态资源:
- 把
jquery-2.0.3.min.js、kinetic-v5.1.0.min.js、inchlib-1.2.0.js三个文件统一放到React项目的public/libs/路径下 - 打开
public/index.html,在<head>标签内按依赖先后顺序引入脚本,绝对不能调换顺序:
<script src="%PUBLIC_URL%/libs/jquery-2.0.3.min.js"></script> <script src="%PUBLIC_URL%/libs/kinetic-v5.1.0.min.js"></script> <script src="%PUBLIC_URL%/libs/inchlib-1.2.0.js"></script>
- 把需要加载的示例数据文件
microarrays.json放到public根目录下,保证调用read_data_from_file("/microarrays.json")时能正常访问到资源。
2. 改造React组件完成初始化
因为React是虚拟DOM渲染机制,原生的$(document).ready时机并不能保证组件对应的真实DOM已经渲染完成,需要依托类组件的生命周期钩子完成库的初始化,完全适配你提供的现有App组件结构,改造后的代码如下:
import React, { Component } from 'react'; import './App.css'; export default class App extends Component { // 创建ref存储InCHlib需要挂载的真实DOM节点,避免全局id冲突 inchlibMountRef = React.createRef(); // 存储InCHlib实例,方便组件卸载时做清理 inchlibInstance = null; // 组件真实DOM挂载完成后初始化库,这个时机和原生页面的$(document).ready效果完全一致 componentDidMount() { // 从全局window对象上读取已经引入的InCHlib构造函数 const InCHlib = window.InCHlib; // 初始化实例,target直接传ref拿到的DOM节点,不需要强制绑定页面id this.inchlibInstance = new InCHlib({ "target": this.inchlibMountRef.current, "width": 800, "height": 1200, "column_metadata_colors": "RdLrBu", "heatmap_colors": "RdBkGr", "max_percentile": 90, "middle_percentile": 60, "min_percentile": 10, "heatmap_font_color": "white", text: 'biojs' }); // 加载数据、渲染画布、绑定事件的逻辑和原生写法完全一致 this.inchlibInstance.read_data_from_file("/microarrays.json"); this.inchlibInstance.draw(); this.inchlibInstance.onAll((name) => { console.log(name + " event triggered"); }); } // 组件卸载时清理实例,避免内存泄漏 componentWillUnmount() { if (this.inchlibInstance) { this.inchlibInstance = null; // 清空容器内残留的画布DOM if (this.inchlibMountRef.current) { this.inchlibMountRef.current.innerHTML = ''; } } } render() { return ( <div> {/* 复用原原生页面的外层布局样式 */} <div className="heatmaps" style={{ margin: 'auto', display: 'flex', alignItems: 'center', marginLeft: '25%' }}> {/* 把ref绑定到库需要挂载的div上 */} <div ref={this.inchlibMountRef}></div> </div> <div></div> </div> ) } }
3. 常见踩坑提示
- 绝对不能把库初始化逻辑放到
render函数里执行,render阶段真实DOM还没生成,会出现找不到挂载节点的报错 - 脚本引入顺序不能调换,一旦把jQuery放到InCHlib后面引入,会直接出现
$ is not defined的全局报错 - 不要在组件外层手动写
$(document).ready包裹初始化逻辑,反而会打乱React自身的渲染节奏,直接用componentDidMount钩子的时机是最可靠的
内容的提问来源于stack exchange,提问作者John Doe
相关产品推荐
相关产品推荐

