luckysheet增加插件版本
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 11KB

1 year ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307
  1. <div align="center">
  2. ![logo](/docs/.vuepress/public/img/logo_text.png)
  3. [![Join the chat at https://gitter.im/mengshukeji/Luckysheet](https://badges.gitter.im/mengshukeji/Luckysheet.svg)](https://gitter.im/mengshukeji/Luckysheet?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
  4. <a href="https://twitter.com/intent/follow?screen_name=luckysheet">
  5. <img src="https://img.shields.io/twitter/follow/luckysheet?style=social&logo=twitter"
  6. alt="follow on Twitter"></a>
  7. </div>
  8. # Luckysheet 3.x has been renamed to [Univer](https://github.com/dream-num/univer)
  9. English| [简体中文](./README-zh.md)
  10. ## Introduction
  11. 🚀Luckysheet is an online spreadsheet like excel that is powerful, simple to configure, and completely open source.
  12. ## Links
  13. | Source Code | Documentation | Demo | Plugins Demo | Forum |
  14. | ------ | -------- | ------ | ------ | ------ |
  15. | [Github](https://github.com/mengshukeji/Luckysheet)| [Online Documentation](https://dream-num.github.io/LuckysheetDocs/) | [Online Demo](https://dream-num.github.io/LuckysheetDemo) / [Cooperative editing demo](http://luckysheet.lashuju.com/demo/) | [Import Excel Demo](https://dream-num.github.io/LuckyexcelDemo/) | [Chinese Forum](https://support.qq.com/product/288322) |
  16. | [Gitee Mirror](https://gitee.com/mengshukeji/Luckysheet)| [Gitee Online Documentation](https://mengshukeji.gitee.io/LuckysheetDocs/) | [Gitee Online Demo](https://mengshukeji.gitee.io/luckysheetdemo/) | [Gitee Import Excel Demo](https://mengshukeji.gitee.io/luckyexceldemo/) | [Google Group](https://groups.google.com/g/luckysheet) |
  17. ![Demo](/docs/.vuepress/public/img/LuckysheetDemo.gif)
  18. ## Plugins
  19. - [Luckyexcel](https://github.com/mengshukeji/Luckyexcel): Excel import and export library
  20. - [chartMix](https://github.com/mengshukeji/chartMix): Chart plugin
  21. ## Ecosystem
  22. | Project | Description |
  23. |---------|-------------|
  24. | [Luckysheet Vue] | Luckysheet and Luckyexcel in a vue cli3 project |
  25. | [Luckysheet Vue3] | Luckysheet and Luckyexcel in a vue3 project with vite|
  26. | [Luckysheet React] | Luckysheet in a React project |
  27. | [Luckyexcel Node] | Use Luckyexcel in koa2 |
  28. | [Luckysheet Server] | Java backend Luckysheet Server |
  29. | [Luckysheet Server Starter] | LuckysheetServer docker deployment startup template |
  30. [Luckysheet Vue]: https://github.com/mengshukeji/luckysheet-vue
  31. [Luckysheet Vue3]: https://github.com/hjwforever/luckysheet-vue3-vite
  32. [Luckysheet React]: https://github.com/mengshukeji/luckysheet-react
  33. [Luckyexcel Node]: https://github.com/mengshukeji/Luckyexcel-node
  34. [Luckysheet Server]: https://github.com/mengshukeji/LuckysheetServer
  35. [Luckysheet Server Starter]: https://github.com/mengshukeji/LuckysheetServerStarter
  36. ## Features
  37. - **Formatting**: style, conditional formatting, text alignment and rotation, text truncation, overflow, automatic line wrapping, multiple data types, cell segmentation style
  38. - **Cells**: drag and drop, fill handle, multiple selection, find and replace, location, merge cells, data verification
  39. - **Row & column**: hide, insert, delete rows or columns, freeze, and split text
  40. - **Operation**: undo, redo, copy, paste, cut, hot key, format painter, drag and drop selection
  41. - **Formulas & Functions**: Built-in, remote and custom formulas
  42. - **Tables**: filter, sort
  43. - **Enhanced functions**: Pivot tables, charts, comments, cooperative editing, insert picture, matrix calculations, screenshots, copying to other formats, EXCEL import and export, etc.
  44. For a more detailed feature list, please refer to: [Features](https://dream-num.github.io/LuckysheetDocs/guide/#features)
  45. ## 📖 Resources
  46. - Priority reading for new users: [User Guide](https://github.com/mengshukeji/Luckysheet/wiki/User-Guide)
  47. - For the tutorials, learning materials and supporting solutions provided by the community, please refer to: [Tutorials and Resources](https://dream-num.github.io/LuckysheetDocs/guide/resource.html)
  48. ## 📜 Changelog
  49. Detailed changes for each release are documented in the [CHANGELOG.md](CHANGELOG.md).
  50. ## ❗️ Issues
  51. Please make sure to read the [Issue Reporting Checklist](https://dream-num.github.io/LuckysheetDocs/guide/contribute.html#how-to-submit-issues) before opening an issue. Issues not conforming to the guidelines may be closed immediately.
  52. ## ✅ TODO
  53. Managed with [GitHub Projects](https://github.com/mengshukeji/Luckysheet/projects/1)
  54. ## 💪Contribution
  55. Please make sure to read the[ Contributing Guide](https://dream-num.github.io/LuckysheetDocs/guide/contribute.html) before making a pull request.
  56. ## Usage
  57. ### First step
  58. Introduce dependencies through CDN
  59. ```
  60. <link rel='stylesheet' href='https://cdn.jsdelivr.net/npm/luckysheet@latest/dist/plugins/css/pluginsCss.css' />
  61. <link rel='stylesheet' href='https://cdn.jsdelivr.net/npm/luckysheet@latest/dist/plugins/plugins.css' />
  62. <link rel='stylesheet' href='https://cdn.jsdelivr.net/npm/luckysheet@latest/dist/css/luckysheet.css' />
  63. <link rel='stylesheet' href='https://cdn.jsdelivr.net/npm/luckysheet@latest/dist/assets/iconfont/iconfont.css' />
  64. <script src="https://cdn.jsdelivr.net/npm/luckysheet@latest/dist/plugins/js/plugin.js"></script>
  65. <script src="https://cdn.jsdelivr.net/npm/luckysheet@latest/dist/luckysheet.umd.js"></script>
  66. ```
  67. ### Second step
  68. Specify a table container
  69. ```
  70. <div id="luckysheet" style="margin:0px;padding:0px;position:absolute;width:100%;height:100%;left: 0px;top: 0px;"></div>
  71. ```
  72. ### Third step
  73. Create a table
  74. ```
  75. <script>
  76. $(function () {
  77. //Configuration item
  78. var options = {
  79. container: 'luckysheet' //luckysheet is the container id
  80. }
  81. luckysheet.create(options)
  82. })
  83. </script>
  84. ```
  85. ## Development
  86. ### Requirements
  87. [Node.js](https://nodejs.org/en/) Version >= 6
  88. ### Installation
  89. ```
  90. npm install
  91. npm install gulp -g
  92. ```
  93. ### Development
  94. ```
  95. npm run dev
  96. ```
  97. ### Package
  98. ```
  99. npm run build
  100. ```
  101. ## Partner project
  102. - [luban-h5](https://github.com/ly525/luban-h5)
  103. - [h5-Dooring](https://github.com/MrXujiang/h5-Dooring)
  104. - [Furion](https://gitee.com/monksoul/Furion)
  105. - [AFFiNE.PRO](https://github.com/toeverything/AFFiNE)
  106. ## Communication
  107. - [WebSite](http://lucky.lashuju.com/index.html)
  108. - [Github Discussions](https://github.com/mengshukeji/Luckysheet/discussions)
  109. - [Gitter](https://gitter.im/mengshukeji/Luckysheet)
  110. [Chinese community](./README-zh.md)
  111. ## Sponsor
  112. Luckysheet is an MIT-licensed open source project with its ongoing development made possible entirely by the support of these awesome [backers](https://dream-num.github.io/LuckysheetDocs/about/sponsor.html#sponsors-list). If you'd like to join them, please consider:
  113. - [Become a backer or sponsor on Patreon](https://www.patreon.com/mengshukeji).
  114. - [Become a backer or sponsor on Open Collective](https://opencollective.com/luckysheet).
  115. - One-time donation via PayPal, WeChat or Alipay
  116. | PayPal | WeChat | Alipay |
  117. |---|---|---|
  118. | [Paypal Me](https://www.paypal.me/wbfsa) | <img src="https://cdn.jsdelivr.net/gh/mengshukeji/LuckyResources@master/assets/img/wechat/wechat.jpg" width="140" />| <img src="https://cdn.jsdelivr.net/gh/mengshukeji/LuckyResources@master/assets/img/wechat/alipay.jpg" width="130" /> |
  119. ### What's the difference between Patreon and OpenCollective?
  120. 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.
  121. ## Sponsors List
  122. (Sort by time)
  123. - *涛 ¥ 200
  124. - popo ¥ 1
  125. - 孔垂善 ¥ 5
  126. - Shawn文 ¥ 99
  127. - 幸运的小路易 ¥ 1
  128. - 冯启俊 ¥ 88
  129. - mxb ¥ 10
  130. - 祭阳 ¥ 20
  131. - *勇 ¥ 30
  132. - 虚我 ¥ 200
  133. - 甜党 ¥ 50
  134. - Alphabet(Google)-gcf ¥ 1
  135. - **平 ¥ 100
  136. - **东 ¥ 10
  137. - debugger ¥ 20
  138. - 烦了烦 ¥ 10
  139. - 文顶顶 ¥ 200
  140. - yangxshn ¥ 10
  141. - 爱乐 ¥ 100
  142. - 小李飞刀刀 ¥ 66
  143. - 张铭 ¥ 200
  144. - 曹治军 ¥ 1
  145. - *特 ¥ 10
  146. - **权 ¥ 9.9
  147. - **sdmq ¥ 20
  148. - *旭 ¥ 10
  149. - Quentin ¥ 20
  150. - 周宇凡 ¥ 100
  151. - *超 ¥ 10
  152. - 维宁 ¥ 100
  153. - hyy ¥ 20
  154. - 雨亭寒江月 ¥ 50
  155. - **功 ¥ 10
  156. - **光 ¥ 20
  157. - terrywan ¥ 100
  158. - 王晓洪 ¥ 10
  159. - Sun ¥ 10
  160. - 忧绣 ¥ 100
  161. - Jasonx ¥ 10
  162. - 国勇 ¥ 66.6
  163. - 郎志 ¥ 100
  164. - 匿名 ¥ 1
  165. - ni ¥ 100
  166. - 苏 ¥ 50
  167. - Mads_chan ¥ 1
  168. - LK ¥ 100
  169. - 智连方舟 李汪石 ¥ 168
  170. - **发 ¥ 260
  171. - *超 ¥ 10
  172. - *勇 ¥ 10
  173. - *腾 ¥ 15
  174. - 名字好难起 ¥ 20
  175. - 大山 ¥ 1
  176. - waiting ¥ 1000
  177. - **宇 ¥ 10.00
  178. - 刘小帅的哥哥 ¥ 20.00
  179. - 宁静致远 ¥ 10.00
  180. - Eleven ¥ 1.00
  181. - **帆 ¥ 188
  182. - henry ¥ 100
  183. - .波罗 ¥ 50
  184. - 花落有家 ¥ 50
  185. - 踏遍南水北山 ¥ 1
  186. - LC ¥ 5
  187. - **明 ¥ 8.80
  188. - *军 ¥ 20
  189. - 张彪 ¥ 50
  190. - 企业文档云@肖敏 ¥ 10
  191. - 匿名 ¥ 50
  192. - 逍遥行 ¥ 10
  193. - z.wasaki ¥ 50
  194. - Make Children ¥ 20
  195. - Foam ¥ 20
  196. - 奥特曼( o|o)ノ三 ¥ 50
  197. - **凯 ¥ 10
  198. - **兵 ¥ 20
  199. - **川 ¥ 1
  200. - 二万 ¥ 50
  201. - 蔚然成林 ¥ 10
  202. - 邹杰 ¥ 10
  203. - 张永强 ¥ 50
  204. - 鱼得水 ¥ 50
  205. - Ccther ¥ 1
  206. - Eric Cheng ¥ 10
  207. - 佚名 ¥ 1
  208. - 花叶 ¥ 50
  209. - GT ¥ 20
  210. - 菜菜心 ¥ 10
  211. - fisher ¥ 1
  212. - JC ¥ 5
  213. - 佚名 ¥ 20
  214. - 独孤一剑 ¥ 50
  215. - mxt ¥ 20
  216. - 一叶迷山 ¥ 100
  217. - Jeff ¥ 100
  218. - 八千多条狗🐶 ¥ 100
  219. - 晓峰 ¥ 10
  220. - 戒 ¥ 1
  221. - 浪里个浪 ¥ 1
  222. - 回调函数 ¥ 50
  223. - 赖瓜子 ¥ 5
  224. - Milo•J ¥ 20
  225. - 可道云 ¥ 200
  226. - *程 ¥ 10
  227. - 来一杯卡布酸奶 ¥ 5
  228. - 刘久胜 ¥ 100
  229. - 快意江湖 ¥ 50
  230. - *新 ¥ 9.9
  231. - **龙 ¥ 100
  232. ## Authors and acknowledgment
  233. ### Active Core Team Members
  234. - [@wbfsa](https://github.com/wbfsa)
  235. - [@eiji-th](https://github.com/eiji-th)
  236. - [@fly-95](https://github.com/fly-95)
  237. - [@tonytonychopper123](https://github.com/tonytonychopper123)
  238. - [@Dushusir](https://github.com/Dushusir)
  239. - [@iamxuchen800117](https://github.com/iamxuchen800117)
  240. - [@wpxp123456](https://github.com/wpxp123456)
  241. - [@c19c19i](https://weibo.com/u/3884623955)
  242. - [@zhangchen915](https://github.com/zhangchen915)
  243. - [@jerry-f](https://github.com/jerry-f)
  244. - [@flowerField](https://github.com/flowerField)
  245. ### Community Partners
  246. - [@yiwasheng](https://github.com/yiwasheng)
  247. - [@danielcai1987](https://github.com/danielcai1987)
  248. - [@qq6690876](https://github.com/qq6690876)
  249. - [@javahuang](https://github.com/javahuang)
  250. - [@TimerGang](https://github.com/TimerGang)
  251. - [@gsw945](https://github.com/gsw945)
  252. - [@swen-xiong](https://github.com/swen-xiong)
  253. - [@lzmch](https://github.com/lzmch)
  254. - [@kdevilpf](https://github.com/kdevilpf)
  255. - [@WJWM0316](https://github.com/WJWM0316)
  256. ## License
  257. [MIT](http://opensource.org/licenses/MIT)
  258. Copyright (c) 2020-present, mengshukeji