JSPM

@textbus/core

2.0.0-alpha.20
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 272
  • Score
    100M100P100Q109702F
  • License GPL-3.0-only

TextBus is a rich text editor and framework that is highly customizable and extensible to achieve rich wysiwyg effects.

Package Exports

  • @textbus/core
  • @textbus/core/bundles/public-api.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@textbus/core) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

TextBus 富文本编辑器

TextBus 是一套用于构建富交互的富文本编辑框架。和大多数富文本编辑器不同的是,TextBus 以组件为核心,格式为辅助,并大幅简化了富文本编辑器开发中常见 API,且提供了更高的抽象层,使 TextBus 不仅易于上手,同时还能驱动复杂的富文本应用。

本项目为 TextBus 核心实现,提供了跨平台富文本编辑器的基础架构,包括组件、格式、内容及编辑功能等。

本项目并不能直接创建一个富文本编辑器,还需要实现具体平台的桥接接口才可以真正搭建一个富文本编辑器。幸运的是,TextBus 目前开发了 Browser 模块和 Editor 模块,如果你是 PC 端的用户。可以直接使用以上两个模块启动一个所见即所得的编辑器。

文档

更多文档请参考:中文文档

安装

TextBus 可能通过两种方式引入到你的项目中。

通过 npm 安装

npm install @textbus/core @textbus/browser @textbus/editor

在 DOM 中准备好一个空的标签

<div id="editor"></div>

创建编辑器实例

import '@textbus/editor/bundles/textbus.min.css';
import { createEditor } from '@textbus/editor';

const editor = createEditor(document.getElementById('editor'))

通过 script 标签引入

<!DOCTYPE html>
<html>
<head>
  <link rel="stylesheet" href="/path/textbus.min.css">
  <script src="/path/textbus.min.js"></script>
  <title>TextBus 示例</title>
</head>
<body>
<div id="editor"></div>
<script>
  var editor = textbus.createEditor(document.getElementById('editor'))
</script>
</body>
</html>