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, указать элемент-контейнер для таблицы, затем создать таблицу с привязкой к нему. Онлайн-демо позволяет посмотреть результат ещё до того, как вы что-то напишете.
Что нужно установить, чтобы это работало?Конечным пользователям нужен только браузер — библиотека это клиентский JavaScript, загружаемый с CDN. Сама разработка Luckysheet требует Node.js 6 или новее со скриптами разработки и сборки на основе gulp.
Проект ещё развивается?Нет — проект заархивирован, и в README прямо сказано, что он больше не поддерживается. Для продакшена там рекомендуют обновлённого преемника Univer, в котором исправлены загрузка больших данных, стили диаграмм, сводные таблицы и вычисление формул, а также добавлены импорт, экспорт, печать и совместная работа.
Что он умеет внутри самой таблицы?Почти все базовые возможности Excel: стили и условное форматирование, объединение ячеек, поиск и замена, закрепление областей, отмена и повтор действий, фильтрация и сортировка, плюс встроенные, удалённые и пользовательские формулы. Расширенные функции добавляют сводные таблицы, диаграммы, комментарии, совместное редактирование, картинки, матричные вычисления и снимки экрана.
Есть ли совместная работа в реальном времени?Да, совместное редактирование входит в список расширенных функций, и есть онлайн-демо совместного редактирования. Для развёртывания на своём сервере в экосистеме есть Java-сервер Luckysheet Server и стартовый шаблон LuckysheetServer для Docker.
Он умеет импортировать и экспортировать файлы Excel?Импорт и экспорт Excel входят в список расширенных функций, но в README теперь говорится, что для продвинутых возможностей вроде импорта, экспорта и печати стоит использовать Univer. Для работы с xlsx вместе с Luckysheet в экосистеме есть проект Luckyexcel, включённый в обёртки для Vue, Vue3 и React.
Он работает с React или Vue?Да — в разделе экосистемы README перечислены обёртки для Vue (CLI 3), Vue 3 с Vite и React, а также Luckyexcel в Node под koa2. Есть ещё Java-сервер на бэкенде и стартовый шаблон для Docker, чтобы его развернуть.
Creator
dream-num
Size
27.5 MB
Stars
16.6K
Updated
CommitAug 19
Age
6y
Commits · 90 Days