0.0.4 • Published 2 months ago

tdesign-tiptap-test v0.0.4

Weekly downloads
-
License
MIT
Repository
github
Last release
2 months ago

一款基于 tiptap,使用 tdesign 风格的 Vue3 富文本编辑器

说明

Demo

https://demo.tnloy.cc/tdesign-tiptap

安装

下载插件

npm i tdesign-tiptap
# 或者
pnpm i tdesign-tiptap

安装插件

局部引入

<template>
  <t-tiptap v-model="content" :extensions="extensions" />
</template>

<script lang="ts" setup>
// 导入组件与样式
import { TTiptap } from "tdesign-tiptap";
import "tdesign-tiptap/lib/style.css";
</script>

使用

<template>
  <t-tiptap v-model="content" :extensions="extensions" />
</template>

<script setup>
import { ref } from 'vue';
import {
  TTiptap,
  // 扩展
  Bold,
  Italic,
  Strike,
  Underline,
} from "tdesign-tiptap";

// 声明 extensions
// 声明的顺序决定菜单栏和气泡菜单的顺序
const extensions = [
  // 默认在菜单栏中显示
  Bold, 
  // 在菜单栏与气泡菜单中显示
  Italic.configure({ bubble: true }),
  // 在菜单栏中隐藏
  Strike.configure({ bar:false }), 
  // 在气泡菜单中显示,在菜单栏中隐藏
  Underline.configure({ bubble: true, bar: false }), 
];

// 编辑器的内容
const content = ref(`
  <p>我是文本内容</p>
`);
</script>

扩展

扩展列表

目前支持的扩展

  • Heading
  • HeadingGroup (自定义扩展,将 Heading 合并为下拉菜单)
  • Divider (自定义扩展,菜单栏或气泡菜单中的分割符)
  • Blockquote
  • Code
  • CodeBlockLowlight
  • BulletList
  • OrderedList
  • Bold
  • Italic
  • Strike
  • Underline
  • Link
  • TextAlign
  • HorizontalRule
  • Color
  • Highlight
  • Image
  • 其他扩展开发中...

扩展属性

bar

说明:是否显示在菜单栏中

类型: boolean

默认值:true

bubble

说明:是否显示在气泡菜单中

类型: boolean

默认值:false