2.6.3 • Published 1 year ago

@textbus/browser v2.6.3

Weekly downloads
-
License
GPL-3.0-only
Repository
github
Last release
1 year ago

Textbus PC 浏览器支持模块

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

本项目为 Textbus PC 端浏览器中间层实现,提供了 Textbus PC 端所需要的编辑器基本支持能力。如光标、选区桥接、DOM 解析及渲染能力桥接等。

如果你需要一个开箱即用的编辑器,请参考官方文档

安装

npm install @textbus/core @textbus/browser

创建编辑器

import { Viewer, ViewOptions } from '@textbus/browser'

import { rootComponent, rootComponentLoader } from './root.component'

const config: ViewOptions = {
  // ...配置项
}

const editor = new Viewer(rootComponent, rootComponentLoader, config)

其中 rootComponentrootComponentLoader 实现请参考官方文档

配置项

配置项接口如下:

export interface ViewModule extends Module {
  componentLoaders?: ComponentLoader[]
  formatLoaders?: FormatLoader[]
}

/**
 * Textbus PC 端配置接口
 */
export interface ViewOptions extends TextbusConfig {
  imports?: ViewModule[]
  /** 自动获取焦点 */
  autoFocus?: boolean
  /** 编辑区最小高度 */
  minHeight?: string
  /** 组件加载器 */
  componentLoaders?: ComponentLoader[]
  /** 格式加载器 */
  formatLoaders?: FormatLoader[]
  /** 默认内容 */
  content?: string | ComponentLiteral
  /** 文档默认样式表 */
  styleSheets?: string[]
  /** 配置文档编辑状态下用到的样式 */
  editingStyleSheets?: string[]
}

启动

const host = document.getElementById('editor')

editor.mount(host).then(() => {
  console.log('编辑器创建成功!')
})

销毁编辑器

editor.destroy()

获取焦点

editor.focus()

取消焦点

editor.blur()

获取 HTML 内容

const content = editor.getContents().content

获取 JSON 内容

const json = editor.getJSON().content

替换内容

editor.replaceContent('<p>新内容!</p>')

editor.replaceContent({
  // 必须为 Textbus 导出的 JSON 格式
})

清空编辑器

editor.replaceContent('')

官方文档

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

2.6.1

1 year ago

2.6.0

1 year ago

2.6.3

1 year ago

2.6.2

1 year ago

2.5.14

1 year ago

2.5.12

1 year ago

2.5.13

1 year ago

3.0.0-alpha.7

1 year ago

3.0.0-alpha.6

1 year ago

3.0.0-alpha.9

1 year ago

3.0.0-alpha.8

1 year ago

2.4.1

1 year ago

3.0.0-alpha.1

1 year ago

2.4.0

1 year ago

3.0.0-alpha.3

1 year ago

2.4.3

1 year ago

2.4.2

1 year ago

3.0.0-alpha.5

1 year ago

2.4.5

1 year ago

3.0.0-alpha.4

1 year ago

2.4.4

1 year ago

2.3.0-alpha.0

1 year ago

2.5.5

1 year ago

2.5.8

1 year ago

2.5.7

1 year ago

2.5.9

1 year ago

2.3.0

1 year ago

2.3.1

1 year ago

3.0.0-alpha.14

1 year ago

3.0.0-alpha.13

1 year ago

2.2.0

1 year ago

3.0.0-alpha.16

1 year ago

3.0.0-alpha.15

1 year ago

3.0.0-alpha.18

1 year ago

3.0.0-alpha.17

1 year ago

3.0.0-alpha.19

1 year ago

3.0.0-alpha.10

1 year ago

3.0.0-alpha.12

1 year ago

3.0.0-alpha.11

1 year ago

3.0.0-alpah.2

1 year ago

2.5.10

1 year ago

2.5.11

1 year ago

2.5.0

1 year ago

2.5.2

1 year ago

2.5.4

1 year ago

2.5.3

1 year ago

2.0.3

2 years ago

3.0.0-alpha.0

2 years ago

2.1.5-alpha.0

2 years ago

2.1.2

2 years ago

2.1.4

2 years ago

2.1.3

2 years ago

2.1.6

2 years ago

2.1.5

2 years ago

2.2.0-alpha.0

2 years ago

2.1.0

2 years ago

2.0.2

2 years ago

2.0.1

2 years ago

2.0.0

2 years ago

2.0.0-beta.61

2 years ago

2.0.0-beta.60

2 years ago

2.0.0-beta.51

2 years ago

2.0.0-beta.50

2 years ago

2.0.0-beta.55

2 years ago

2.0.0-beta.54

2 years ago

2.0.0-beta.53

2 years ago

2.0.0-beta.52

2 years ago

2.0.0-beta.59

2 years ago

2.0.0-beta.58

2 years ago

2.0.0-beta.57

2 years ago

2.0.0-beta.56

2 years ago

2.0.0-beta.40

2 years ago

2.0.0-beta.44

2 years ago

2.0.0-beta.43

2 years ago

2.0.0-beta.42

2 years ago

2.0.0-beta.41

2 years ago

2.0.0-beta.48

2 years ago

2.0.0-beta.47

2 years ago

2.0.0-beta.46

2 years ago

2.0.0-beta.49

2 years ago

2.0.0-beta.37

2 years ago

2.0.0-beta.36

2 years ago

2.0.0-beta.35

2 years ago

2.0.0-beta.34

2 years ago

2.0.0-beta.39

2 years ago

2.0.0-beta.38

2 years ago

2.0.0-beta.22

2 years ago

2.0.0-beta.21

2 years ago

2.0.0-beta.20

2 years ago

2.0.0-beta.26

2 years ago

2.0.0-beta.25

2 years ago

2.0.0-beta.24

2 years ago

2.0.0-beta.23

2 years ago

2.0.0-beta.27

2 years ago

2.0.0-beta.11

2 years ago

2.0.0-beta.10

2 years ago

2.0.0-beta.15

2 years ago

2.0.0-beta.14

2 years ago

2.0.0-beta.13

2 years ago

2.0.0-beta.12

2 years ago

2.0.0-beta.18

2 years ago

2.0.0-beta.17

2 years ago

2.0.0-beta.16

2 years ago

2.0.0-beta.9

2 years ago

2.0.0-beta.8

2 years ago

2.0.0-beta.2

2 years ago

2.0.0-beta.1

2 years ago

2.0.0-beta.0

2 years ago

2.0.0-beta.6

2 years ago

2.0.0-beta.5

2 years ago

2.0.0-beta.4

2 years ago

2.0.0-alpha.79

2 years ago

2.0.0-beta.3

2 years ago

2.0.0-alpha.78

2 years ago

2.0.0-beta.33

2 years ago

2.0.0-beta.32

2 years ago

2.0.0-alpha.55

2 years ago

2.0.0-alpha.56

2 years ago

2.0.0-alpha.77

2 years ago

2.0.0-alpha.75

2 years ago

2.0.0-alpha.74

2 years ago

2.0.0-alpha.73

2 years ago

2.0.0-alpha.72

2 years ago

2.0.0-alpha.71

2 years ago

2.0.0-alpha.64

2 years ago

2.0.0-alpha.63

2 years ago

2.0.0-alpha.62

2 years ago

2.0.0-alpha.61

2 years ago

2.0.0-alpha.69

2 years ago

2.0.0-alpha.68

2 years ago

2.0.0-alpha.67

2 years ago

2.0.0-alpha.54

2 years ago

2.0.0-alpha.53

2 years ago

2.0.0-alpha.50

2 years ago

2.0.0-alpha.49

2 years ago

2.0.0-alpha.48

2 years ago

2.0.0-alpha.47

2 years ago

2.0.0-alpha.33

2 years ago

2.0.0-alpha.32

2 years ago

2.0.0-alpha.31

2 years ago

2.0.0-alpha.30

2 years ago

2.0.0-alpha.39

2 years ago

2.0.0-alpha.38

2 years ago

2.0.0-alpha.37

2 years ago

2.0.0-alpha.36

2 years ago

2.0.0-alpha.35

2 years ago

2.0.0-alpha.34

2 years ago

2.0.0-alpha.44

2 years ago

2.0.0-alpha.43

2 years ago

2.0.0-alpha.42

2 years ago

2.0.0-alpha.41

2 years ago

2.0.0-alpha.40

2 years ago

2.0.0-alpha.29

2 years ago

2.0.0-alpha.28

2 years ago

2.0.0-alpha.27

2 years ago

2.0.0-alpha.7

2 years ago

2.0.0-alpha.8

2 years ago

2.0.0-alpha.3

2 years ago

2.0.0-alpha.10

2 years ago

2.0.0-alpha.4

2 years ago

2.0.0-alpha.6

2 years ago

2.0.0-alpha.19

2 years ago

2.0.0-alpha.18

2 years ago

2.0.0-alpha.17

2 years ago

2.0.0-alpha.16

2 years ago

2.0.0-alpha.15

2 years ago

2.0.0-alpha.14

2 years ago

2.0.0-alpha.13

2 years ago

2.0.0-alpha.12

2 years ago

2.0.0-alpha.22

2 years ago

2.0.0-alpha.21

2 years ago

2.0.0-alpha.20

2 years ago

2.0.0-alpha.26

2 years ago

2.0.0-alpha.25

2 years ago

2.0.0-alpha.24

2 years ago

2.0.0-alpha.23

2 years ago

2.0.0-alpha.1

2 years ago

2.0.0-alpha.0

2 years ago