Luckysheet README

The project's README from github.com/dream-num/Luckysheet. As one markdown file: README.md.

logo

Join the chat at https://gitter.im/mengshukeji/Luckysheet follow on Twitter

English| 简体中文

Luckysheet is no longer maintained. It is recommended to use the upgraded version of Univer for production environment deployment. The new version solves problems such as large data loading, chart styles, pivot tables, formula calculations, etc., and has made many optimization designs, added import, export, printing, collaboration and other functions, improved table performance, and has a professional technical team to provide technical support.

Follow the #1454 issue for more details.

Introduction

🚀Luckysheet is an online spreadsheet like excel that is powerful, simple to configure, and completely open source.

Source Code Documentation Demo Forum
Github Online Documentation Online Demo / Cooperative editing demo Chinese Forum
Gitee Mirror Gitee Online Documentation Gitee Online Demo Google Group

Demo

Plugins

For advanced features like import, export, and printing, please use Univer

Ecosystem

Project Description
Luckysheet Vue Luckysheet and Luckyexcel in a vue cli3 project
Luckysheet Vue3 Luckysheet and Luckyexcel in a vue3 project with vite
Luckysheet React Luckysheet in a React project
Luckyexcel Node Use Luckyexcel in koa2
Luckysheet Server Java backend Luckysheet Server
Luckysheet Server Starter LuckysheetServer docker deployment startup template

Features

For a more detailed feature list, please refer to: Features

📖 Resources

📜 Changelog

Detailed changes for each release are documented in the CHANGELOG.md.

❗️ Issues

Please make sure to read the Issue Reporting Checklist before opening an issue. Issues not conforming to the guidelines may be closed immediately.

✅ TODO

Managed with GitHub Projects

💪Contribution

Please make sure to read the Contributing Guide before making a pull request.

Usage

First step

Introduce dependencies through CDN

<link rel='stylesheet' href='https://cdn.jsdelivr.net/npm/luckysheet@latest/dist/plugins/css/pluginsCss.css' />
<link rel='stylesheet' href='https://cdn.jsdelivr.net/npm/luckysheet@latest/dist/plugins/plugins.css' />
<link rel='stylesheet' href='https://cdn.jsdelivr.net/npm/luckysheet@latest/dist/css/luckysheet.css' />
<link rel='stylesheet' href='https://cdn.jsdelivr.net/npm/luckysheet@latest/dist/assets/iconfont/iconfont.css' />
<script src="https://cdn.jsdelivr.net/npm/luckysheet@latest/dist/plugins/js/plugin.js"></script>
<script src="https://cdn.jsdelivr.net/npm/luckysheet@latest/dist/luckysheet.umd.js"></script>

Second step

Specify a table container

<div id="luckysheet" style="margin:0px;padding:0px;position:absolute;width:100%;height:100%;left: 0px;top: 0px;"></div>

Third step

Create a table

<script>
    $(function () {
        //Configuration item
        var options = {
            container: 'luckysheet' //luckysheet is the container id
        }
        luckysheet.create(options)
    })
</script>

Development

Requirements

Node.js Version >= 6

Installation

npm install
npm install gulp -g

Development

npm run dev

Package

npm run build

Partner project

Communication

Chinese community

Sponsor

Luckysheet is an MIT-licensed open source project with its ongoing development made possible entirely by the support of these awesome backers. If you'd like to join them, please consider:

PayPal WeChat Alipay
Paypal Me

What's the difference between Patreon and OpenCollective?

Funds donated via Patreon go directly to support mengshukeji's work on Luckysheet. Funds donated via OpenCollective are managed with transparent expenses and will be used for compensating work and expenses for core team members or sponsoring community events. Your name/logo will receive proper recognition and exposure by donating on either platform.

Sponsors List

(Sort by time)

Authors and acknowledgment

Active Core Team Members

Community Partners

License

MIT

Copyright (c) 2020-present, mengshukeji

Luckysheet (dream-num/Luckysheet)

Searching Database…

16.6K ·GitHub
archived
这是什么?Luckysheet 是一个完全开源的在线表格,类似 Excel——功能强大、可配置的 Excel 风格表格,支持公式、图表和数据透视表,直接在浏览器里运行。
它是像 Google Sheets 那样的托管服务,还是我加到自己应用里的一个组件?它是一个 JavaScript 库:你在网页里加载它的文件,指向一个容器元素,它就会在那里渲染出表格。如果要自己搭建协作功能,生态中还有一个独立的 Java 版 Luckysheet Server,并提供了 Docker 启动模板。
怎么把它加到网页里?README 里讲了三步:通过 CDN 引入依赖,指定一个表格容器元素,然后创建表格并指向它。在动手写代码之前,你可以先用在线演示看看效果。
运行它需要装什么?使用者只需要一个浏览器——这个库是从 CDN 加载的纯前端 JavaScript。如果要参与开发 Luckysheet 本身,则需要 Node.js 6 或更高版本,并使用基于 gulp 的开发和构建脚本。
它还在积极维护吗?不在了——项目已经归档,README 明确说明不再维护。生产环境建议使用升级后的后继项目 Univer,它改进了大数据加载、图表样式、数据透视表和公式计算,并增加了导入、导出、打印和协作功能。
它在表格里具体能做什么?Excel 的基本功能大多都有:样式和条件格式、合并单元格、查找替换、冻结、撤销和重做、筛选和排序,还有内置公式、远程公式和自定义公式。增强功能还包括数据透视表、图表、批注、协同编辑、图片、矩阵计算和截图。
支持实时协作吗?支持,协同编辑列在它的增强功能里,也有在线协同编辑演示。如果要自己部署,生态中还有基于 Java 的 Luckysheet Server,以及 LuckysheetServer 的 Docker 部署启动模板。
能导入和导出 Excel 文件吗?Excel 导入导出列在增强功能里,但 README 现在建议导入、导出和打印这类高级功能改用 Univer。如果想在 Luckysheet 之外获得 xlsx 支持,生态中提供了 Luckyexcel 项目,并打包进了 Vue、Vue3 和 React 的封装中。
它能配合 React 或 Vue 使用吗?可以——README 的生态部分列出了 Vue(CLI 3)、Vue 3 配 Vite 和 React 的封装,还有 Node 下配合 koa2 使用的 Luckyexcel。另外还有一个 Java 后端服务器和用于部署的 Docker 启动模板。
Creator
dream-num
Size
27.5 MB
Stars
16.6K
Updated
CommitAug 19
Age
6y
Commits · 90 Days