# ciqtek-editor

> **类的主要功能为：提供快速创建自定义代码提示与鼠标悬浮提示**

Latest version **0.0.3** (published 2021-10-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install ciqtek-editor
pnpm add ciqtek-editor
yarn add ciqtek-editor
bun add ciqtek-editor
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2021-10-15 |
| First published | 2021-10-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 17.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | 国仪量子（合肥）技术有限公司 |
| Maintainers | zhuyue314 |
| Keywords | code, editor, monaco-editor |

## Links

- npm: https://www.npmjs.com/package/ciqtek-editor
- Repository: https://github.com/ciqtek/awg-editor
- Homepage: https://github.com/ciqtek/awg-editor#readme
- Issues: https://github.com/ciqtek/awg-editor/issues
- npm.io page: https://npm.io/package/ciqtek-editor

## Dependencies (1)

- [monaco-editor](https://npm.io/package/monaco-editor.md) ^0.29.1

## Alternatives

- [flatbuffers](https://npm.io/package/flatbuffers.md) — 6.0M weekly downloads
- [jwt-simple](https://npm.io/package/jwt-simple.md) — 259.5K weekly downloads
- [@exodus/patch-broken-hermes-typed-arrays](https://npm.io/package/@exodus/patch-broken-hermes-typed-arrays.md) — 28.5K weekly downloads
- [@native-to-anchor/buffer-layout](https://npm.io/package/@native-to-anchor/buffer-layout.md) — 12.2K weekly downloads
- [binary-parser-encoder](https://npm.io/package/binary-parser-encoder.md) — 5.3K weekly downloads

## Recent versions

- 0.0.3 (latest) — 2021-10-15
- 0.0.2 — 2021-10-15
- 0.0.1 — 2021-10-15

## README

### 基于monaco-editor简单的二次封装
**类的主要功能为：提供快速创建自定义代码提示与鼠标悬浮提示**
<br/>

#### Api:


api | 描述 | 参数 | 返回值
---|---| ---| ---
getInstance | 类的静态方法，用来获取实例，不要使用new方法去创建实例，使用getInstance保持单例调 | |AwgEditor
initSuggestions | 实例方法用来创建代码补全提示 |params :string[]\|SuggestionsParams[] 代码补全提示参数 | void
initHover | 实例方法用来创建鼠标悬浮提示 | params: HoverParams]\|HoverParams[]   hover提示参数，formate:boolean 是否开启简单的格式化提示，默认值true| void
dispose | 实例方法用来销毁上一次创建的提示，用于存在多次调用提示的情况 | | void

#### type：
```
SuggestionsParams：{
    
    label:string 用户输入配置字符
    text:string 补全内容
    detail:string 提示描述
    kind:'KeyWord' | 'Function '| 'Snippet' 提示类型
}

HoverParams： {
    type：string 提示类型,默认method
    value：string 提示内容
    key：悬浮关键词
}
```


#### 使用：

```javascript
import { MonacoCodeEditor } from './editorTools/CodeEditor'
const dom = document.querySelector('#container')
const editor = MonacoCodeEditor.getInstance()
editor.initSuggestions(funName) // 创建代码补全提示
editor.initHover(hoverHints) // 创建鼠标悬浮提示
editor.initCodeEditor(dom) // 初始化编辑器
```

注：在vue中不建议在组件mounted创建提示，这样可以避免多次创建提示

---
_Source: https://npm.io/package/ciqtek-editor · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._