nice-monaco-tree
v1.0.7
Published
不依赖任何框架的、漂亮的monaco-tree
Downloads
19
Readme
nice-monaco-tree
基于monaco-tree简单二次修改而来的、不依赖任何框架的 monaco-tree 组件,主要改动:
- 移除对React的依赖,新仓库不依赖任何框架,可在任何页面直接引用;
- 样式微调,解决与其他页面融合时常见的样式冲突问题;
- 优化onClick等方法的传参,支持带入filePath和fileIcon;
- 透出封装好的一些实用方法,诸如选中文件、自动递归展开所有文件夹等;
使用方法:
import NiceMonacoTree from 'nice-monaco-tree';
const monacoTree = NiceMonacoTree.init(document.getElementById('root'), {
fileList: ['package.json', 'README.md', 'src/test.js', 'src/index.js'],
onClick: (file) => {
console.log(file);
},
onDoubleClick: file => {
console.log(222, file);
},
});
monacoTree.setSelection('public/js/ui.js'); // 选中某个文件
monacoTree.getSelection(); // 获取当前选中的文件
monacoTree.expandAll(); // 递归展开所有文件夹
monacoTree.expandFolder('public/js'); // 展开某个文件夹
monacoTree.collapseAll(); // 递归收起所有文件夹
monacoTree.collapseFolder('public/js'); // 收起某个文件夹
monacoTree.getTree(); // 获取底层tree实例,上面挂载了很多方法和事件
开发
npm i
npm run dev
npm run build
npm publish
monaco-tree
以下为原仓库 https://github.com/BlueMagnificent/monaco-tree 的自述文件:
A fairly successful attempt in extracting the tree view element hidden in Monaco Editor and making a React component of it.
It supports click events on tree nodes, context menu and also drag-n-drop ( you might want to open your browser console to see some logs).
Credits to WebAssemblyStudio whose implementation approach was very helpful ( as well as some freely lifted codes :smiling_imp: )
CodeSandbox
For a quick preview here is a codesandbox of it
Check It Out
Download the repository or clone it with git. Then
npm install
after which
npm start
Next visit localhost:7070 on your browser.
Caveat
This project is more of an expriment to extract out and use the tree component in Monaco Editor. It is, for now, a Proof-Of-Concept.
Second. Monaco Editor is "the code editor that powers" vscode, however it contains a tree component.
Despite the fact that this project is mainly based on the tree component, I honestly have no idea why it was bundled together with Monaco.
Unfortunately, internal APIs have been changing between versions of Monaco and I can't guarantee that the tree conponent will always behave the same.
To that end, the version of Monaco used in this project (0.20.0) is the version I can clearly confirm makes this project work as expected.
License
Monaco Tree is MIT Licensed