# ekt-editor

> ```shell npm i ekt-editor ```

Latest version **1.4.4** (published 2024-03-01) · 0 weekly downloads

## Install

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

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.4.4 |
| Published | 2024-03-01 |
| First published | 2024-02-19 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 26 |
| Unpacked size | 1.5 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | xinghe607 |
| Keywords | ekt-editor, vue-editor, vue3-editor, vue3, vue, ekt, editor, 富文本, 富文本编辑器, vueeditor, vue3editor, element, element-plus |

## Links

- npm: https://www.npmjs.com/package/ekt-editor
- npm.io page: https://npm.io/package/ekt-editor

## Dependencies (26)

- [vue](https://npm.io/package/vue.md) ^3.4.15
- [update](https://npm.io/package/update.md) ^0.7.4
- [@tiptap/pm](https://npm.io/package/@tiptap/pm.md) ^2.2.1
- [element-plus](https://npm.io/package/element-plus.md) ^2.5.5
- [@tiptap/vue-3](https://npm.io/package/@tiptap/vue-3.md) ^2.2.1
- [vite-svg-loader](https://npm.io/package/vite-svg-loader.md) ^5.1.0
- [@tiptap/starter-kit](https://npm.io/package/@tiptap/starter-kit.md) ^2.2.1
- [@tiptap/extension-text](https://npm.io/package/@tiptap/extension-text.md) ^2.2.1
- [@vitejs/plugin-vue-jsx](https://npm.io/package/@vitejs/plugin-vue-jsx.md) ^3.1.0
- [@element-plus/icons-vue](https://npm.io/package/@element-plus/icons-vue.md) ^2.3.1
- [@tiptap/extension-color](https://npm.io/package/@tiptap/extension-color.md) ^2.2.1
- [@tiptap/extension-image](https://npm.io/package/@tiptap/extension-image.md) ^2.2.2
- [@tiptap/extension-table](https://npm.io/package/@tiptap/extension-table.md) ^2.2.2
- [@tiptap/extension-heading](https://npm.io/package/@tiptap/extension-heading.md) ^2.2.1
- [@tiptap/extension-highlight](https://npm.io/package/@tiptap/extension-highlight.md) ^2.2.1
- [@tiptap/extension-list-item](https://npm.io/package/@tiptap/extension-list-item.md) ^2.2.1
- [@tiptap/extension-table-row](https://npm.io/package/@tiptap/extension-table-row.md) ^2.2.2
- [@tiptap/extension-underline](https://npm.io/package/@tiptap/extension-underline.md) ^2.2.1
- [@tiptap/extension-dropcursor](https://npm.io/package/@tiptap/extension-dropcursor.md) ^2.2.1
- [@tiptap/extension-table-cell](https://npm.io/package/@tiptap/extension-table-cell.md) ^2.2.2
- [@tiptap/extension-text-align](https://npm.io/package/@tiptap/extension-text-align.md) ^2.2.1
- [@tiptap/extension-text-style](https://npm.io/package/@tiptap/extension-text-style.md) ^2.2.1
- [@tiptap/extension-bullet-list](https://npm.io/package/@tiptap/extension-bullet-list.md) ^2.2.1
- [@tiptap/extension-ordered-list](https://npm.io/package/@tiptap/extension-ordered-list.md) ^2.2.1
- [@tiptap/extension-table-header](https://npm.io/package/@tiptap/extension-table-header.md) ^2.2.2
- [@tiptap/extension-character-count](https://npm.io/package/@tiptap/extension-character-count.md) ^2.2.1

## Alternatives

- [ext-list](https://npm.io/package/ext-list.md) — 6.3M weekly downloads
- [@lexical/selection](https://npm.io/package/@lexical/selection.md) — 3.8M weekly downloads
- [@lexical/text](https://npm.io/package/@lexical/text.md) — 3.6M weekly downloads
- [@lexical/clipboard](https://npm.io/package/@lexical/clipboard.md) — 3.0M weekly downloads
- [@tiptap/extension-mention](https://npm.io/package/@tiptap/extension-mention.md) — 3.0M weekly downloads

## Recent versions

- 1.4.4 (latest) — 2024-03-01
- 1.4.3 — 2024-02-29
- 1.4.2 — 2024-02-27
- 1.4.1 — 2024-02-27
- 1.4.0 — 2024-02-27
- 1.3.0 — 2024-02-23
- 1.2.0 — 2024-02-23
- 1.1.0 — 2024-02-19

## README

### NPM

```shell
npm i ekt-editor
```

### main.js

``` js
import { createApp } from 'vue'
import App from './App.vue'
import VueEditor from 'ekt-editor'
import 'ekt-editor/lib/index.css'

const app = createApp(App)
app.use(VueEditor).mount('#app')

```

### component

``` js
import { Editor } from 'ekt-editor'
```

### 组件使用方法

``` js
<template>
    <Editor v-model:content="content"></Editor>
</template>
<script lang="ts" setup>
  import { Editor } from 'ekt-editor'
  import { ref } from 'vue'
  const content = ref('')
</script>
```

### 组件属性

|       属性        |  类型   | 是否必填 |                                                                                                                                                                 说明                                                                                                                                                                  |
| :---------------: | :-----: | :------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|      content      | string  |   true   |                                                                                                                                                              编辑器内容                                                                                                                                                               |
|    min-height     | string  |  false   |                                                                                                                                                            编辑器最小高度                                                                                                                                                             |
|    min-height     | string  |  false   |                                                                                                                                                            编辑器最大高度                                                                                                                                                             |
| excludeEditorMenu |  array  |  false   |                                      不显示的菜单项，可选值: `bold` `italic` `underline` `strikethrough` `heading` `textStyle` `highlight` `blockquote` `codeBlock` `image` `left` `center` `right` `header` `justify` `bulletList` `orderedList` `horizontalRule` `table` `print` `undo` `redo`                                      |
|    editorMenu     |  array  |  false   | 自定义菜单选项,可选值：`bold` `italic` `underline` `strikethrough` `heading` `textStyle` `highlight` `blockquote` `codeBlock` `image` `left` `center` `right` `header` `justify` `bulletList` `orderedList` `horizontalRule` `table` `print` `undo` `redo` </br><span style="color:red">注：当excludeEditorMenu和editorMenu同时存在时，excludeEditorMenu优先级更高</span> |
|    editorWords    | boolean |  false   |                                                                                                                                                           是否显示字数统计                                                                                                                                                            |
|  editorImageUrl   | string  |  false   |                                                                                                                                                             图片上传地址                                                                                                                                                              |

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