0.4.5 • Published 12 days ago

dt-react-monaco-editor v0.4.5

Weekly downloads
2
License
MIT
Repository
github
Last release
12 days ago

:house: 简述

基于开源 monaco-editor,根据业务使用场景进行二次封装,极大的降低了使用成本,使编辑器部分代码可控性更高。

功能

  • 除了 monaco-editor 自带的 language 外,还支持多种自定义的 language,如下表
language描述关键字自动补全语法错误提示语法高亮
dtsql通用的 sql languageyes ✅yes ✅yes ✅
dtflinkflink sql languageyes ✅yes ✅yes ✅
dtPython2python2 languageyes ✅yes ✅yes ✅
dtPython3python3 languageyes ✅yes ✅yes ✅
dtGreenplumgreenplum sql languageyes ✅no ❌yes ✅
  • 支持通过 props 传递的方式自定义自动补全项需要高亮的关键字

:eyes: 在线预览

https://DTStack.github.io/dt-react-monaco-editor/

:zap: 安装

使用 npm

npm i dt-react-monaco-editor --save

使用 yarn

yarn dt-react-monaco-editor --save

使用 pnpm

pnpm install dt-react-monaco-editor --save

:book: 如何使用

安装 monaco-editor-webpack-plugin

pnpm install monaco-editor-webpack-plugin

如果使用 monaco-editor-webpack-plugin 打包,那么还需要安装

pnpm install monaco-editor

webpack 配置部分

const monacoEditorWebpackPlugin = require('monaco-editor-webpack-plugin')
module.exports = {
    module: {
        rules: [
            // 打包 dt-react-monaco-editor 自定义语言的 worker 文件
            {
                test: /\.worker.[jt]s$/,
                include: (input: string) => {
                    return input.includes('dt-react-monaco-editor/lib/languages')
                }
                loader: 'worker-loader',
            },
        ]
    },
    plugins: [
        // 打包 monaco-editor 自带的 worker 文件并且自动注入 monaco 所需的环境变量
        new monacoEditorWebpackPlugin({
            features: [...],
            languages: [...],
        }),
    ]
}

monaco-editor-webpack-plugin 详细配置请看官方文档 monaco-editor-webpack-plugin

使用示例

    import { Editor } from 'dt-react-monaco-editor'
    <Editor
        value='select * from table_name'
        language="dtsql"
        options={{ readOnly: false }}
    />

依赖版本对照表

dt-react-monaco-editormonaco-editormonaco-editor-webpack-pluginwebpack
<=0.1.40.13.11.4.0<=4.x
>=0.3.00.30.16.0.05.x

:wrench: 本地开发

clone & install dependencies

git clone 
pnpm install

启动本地服务器

pnpm storybook

静态服务部署构建

pnpm build-storybook

:blue_book: 相关资料

0.4.5

12 days ago

1.0.4

20 days ago

1.0.3

4 months ago

0.4.5-beta.1

4 months ago

1.0.2

6 months ago

0.4.5-beta.0

5 months ago

1.0.1

10 months ago

1.0.0

10 months ago

1.0.0-beta.2

11 months ago

1.0.0-beta.1

11 months ago

0.3.6

11 months ago

0.4.4

11 months ago

1.0.0-alpha.0

11 months ago

1.0.0-beta.0

11 months ago

0.4.3

12 months ago

0.4.3-beta.1

1 year ago

0.4.3-beta.0

1 year ago

0.4.0-alpha.1

2 years ago

0.4.2-beta.0

1 year ago

0.3.0

2 years ago

0.4.0-beta.0

2 years ago

0.4.0-beta.1

1 year ago

0.3.5

2 years ago

0.4.1

1 year ago

0.3.2

2 years ago

0.3.1

2 years ago

0.4.0

2 years ago

0.3.4

2 years ago

0.4.2

1 year ago

0.3.3

2 years ago

0.2.1

2 years ago

0.2.0

2 years ago

0.1.4

2 years ago

0.1.3

2 years ago

0.1.2

3 years ago

0.1.1

3 years ago