用React实现支持在线协同的Excel表格

原文地址

表格是最重要的存储和计算数据的格式之一,也是在线协同办公中一个关键组成部分。
本文介绍如何在10行代码内,使用React创建一个功能丰富的Excel表格。

快速上手

首先,开始先建一个空的React项目create-react-app
(如果你已经有了一个React项目,可以跳过这一步)

npx create-react-app my-spreadsheet

如果你用yarn的话

yarn create react-app my-spreadsheet

之后,进入my-spreadsheet目录中,安装表格库

 # using npm
npm install @fortune-sheet/react
 # or using yarn
yarn add @fortune-sheet/react

src/App.js替换为以下内容

import { Workbook } from "@fortune-sheet/react";
import "@fortune-sheet/react/dist/index.css"

function App() {
  return <Workbook data={[{ name: "Sheet1" }]} />
}

export default App

并且,在src/index.css中增加一下代码

html, body, #root {
  height: 100%;
} 

至此,所有准备工作做完了,可以直接启动项目了!使用以下命令

# using npm
npm start
 # or using yarn
yarn start

可以尽情玩转并尝试各种功能了~

本地运行效果演示

关于表格库

本文中的表格库FortuneSheet是一个用原生React实现的表格组件,将来还会支持Vue,它是完全开源的,没有任何使用限制。
Github地址: https://github.com/ruilisi/fortune-sheet
在线体验Demo:https://ruilisi.github.io/fortune-sheet-demo/
协同版Demo:https://xiemala.com/s/mkAyPu
官方文档:FortuneSheet Document (ruilisi.github.io)

优化点

本组件源于另一个开源项目Luckysheet,它使用jQuery实现,但在团队的使用过程中,发现其在设计层面的诸多问题,同时项目臃肿,难以维护,导致修改Bug和二次开发非常困难。团队思考再三,毅然决定扎入这数十万行代码的项目中,从中创建出一个全新的,设计合理,易于维护的表格组件,并同样完全开源。

FortuneSheet在Luckysheet的基础上做了很多优化,其中解决的核心痛点:

  1. 使用 Typescript 编写
  2. 项目库可以使用 import / require 导入了
  3. 同页面支持多个实例
  4. 去掉了 jQuery 的依赖, 用原生 React / Vue + immer 来管理Dom和状态。

其余优化包括:

  1. 重新设计了协同模块。
  2. 剥离出公式模块,用一个修改过的 handsontable/formula-parser 来处理公式计算。
  3. 优化dom结构。
  4. 用SVG代替iconfont的图标,因为iconfont的图标对其他开发者而言很不方便改动。
  5. 容器外面不创建可见的页面元素。
  6. 避免在window对象上存储数据。

特色功能介绍

协同编辑

“协同”是在线表格最为核心的功能。传统表格软件和网页组件相比,最大的区别就是对协同编辑的支持和协同编辑的体验。因此,我们在开发FortuneSheet时,非常重视这一功能,在项目开始之初的架构阶段就思考好了具体的方案,并在版本更新迭代中优先加入。同时,提供了一个简单的后端demo来实现数据交互、存储。


协同编辑效果演示

支持多实例

多实例支持

API的Demo展示

一个优秀的开源项目,详细的文档是必不可少的。我们在每一次版本更新时,都会相应地去更新Readme和API文档。为了方便其他Developer更舒适地使用组件和贡献代码,我们在给出详细的API文档之外,还在Online Demo 中暴露出了API,并做了简单的演示,极大程度地方便开发者定制和接入功能。

API Demo

通过测试保证质量

由于新上线的功能复杂度越来越高,参与开发的成员越来越多,在这样庞大体量的项目中,Quality Assurance(质量控制)就成了必不可少的一环。本项目的质量控制流程包括严格的Pull Request代码评审、CICD和针对功能的Jest覆盖。
截至撰写时,已经有了22个test suites和99个test,并且还在持续增加、补充当中。越复杂的功能,越需要严格的测试覆盖。例如我们的核心功能—协同编辑,开发者就写了多达十六个测试(jest)来保障其正确性。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,240评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,328评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,182评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,121评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,135评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,093评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,013评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,854评论 0 273
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,295评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,513评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,678评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,398评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,989评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,636评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,801评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,657评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,558评论 2 352

推荐阅读更多精彩内容