# dslate

**Repository Path**: rojerchen/dslate

## Basic Information

- **Project Name**: dslate
- **Description**: 一个Ant Design风格的富文本编辑器 - An Ant Design style rich editor based on Slate
- **Primary Language**: TypeScript
- **License**: MIT
- **Default Branch**: v2
- **Homepage**: http://rojerchen.gitee.io/dslate/
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 1
- **Created**: 2022-01-13
- **Last Updated**: 2024-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 简介

DSlate 是一个基于 [Slate](https://github.com/ianstormtaylor/slate) 构建的 [Ant Design](https://github.com/ant-design/ant-design/) | [Semi Design](https://github.com/DouyinFE/semi-design) 风格的富文本编辑器。你可以通过插件的方式轻松自定义节点、工具等元素。

> 欢迎一起构建 DSlate

## 文档

要了解更多信息，请参阅以下 DSlate 文档部分：

- [快速开始](https://rojer95.github.io/dslate/getting-started)
- [插件开发](https://rojer95.github.io/dslate/getting-started/plugin)
- [国际化](https://rojer95.github.io/dslate/getting-started/locale)
- [自定义文件上传](https://rojer95.github.io/dslate/getting-started/upload)
- [Antd 风格](https://rojer95.github.io/dslate/getting-started/antd)
- [Semi 风格](https://rojer95.github.io/dslate/getting-started/semi)

## 开箱即用

| 组件                                                       | 说明                                                 |
| ---------------------------------------------------------- | ---------------------------------------------------- |
| [@dslate/antd](https://www.npmjs.com/package/@dslate/antd) | 整合了 Antd 风格开箱即用的编辑器组件（Antd5.0 以上） |
| [@dslate/semi](https://www.npmjs.com/package/@dslate/semi) | 整合了 Semi 风格开箱即用的编辑器组件                 |

## 组件

DSlate 提供了如下组件：

| 组件                                                                         | 说明              |
| ---------------------------------------------------------------------------- | ----------------- |
| [ConfigProvider](https://rojer95.github.io/dslate/components/config)         | 全局配置组件      |
| [Toolbar.Button](https://rojer95.github.io/dslate/components/toolbar-button) | 工具栏-按钮组件   |
| [Toolbar.Select](https://rojer95.github.io/dslate/components/toolbar-select) | 工具栏-选择框组件 |
| [Toolbar.Modal](https://rojer95.github.io/dslate/components/toolbar-modal)   | 工具栏-模态框组件 |
| [Input](https://rojer95.github.io/dslate/components/input)                   | 弹出层组件        |
| [Popover](https://rojer95.github.io/dslate/components/popover)               | 弹出层组件        |

## LICENSE

MIT