@textbus/platform-browser 3.1.7 → 3.1.9

package/README.md

@@ -1,123 +1,123 @@
-Textbus PC 浏览器支持模块
-=====================
-
-Textbus 是一套用于构建富交互的富文本编辑框架。和大多数富文本编辑器不同的是，Textbus 以组件为核心，格式为辅助，并大幅简化了富文本编辑器开发中常见
-API，且提供了更高的抽象层，使 Textbus 不仅易于上手，同时还能驱动复杂的富文本应用。
-
-本项目为 Textbus PC 端浏览器中间层实现，提供了 Textbus PC 端所需要的编辑器基本支持能力。如光标、选区桥接、DOM 解析及渲染能力桥接等。
-
-如果你需要一个开箱即用的编辑器，请参考[官方文档](https://textbus.io)。
-
-## 安装
-
-```
-npm install @textbus/core @textbus/platform-browser
-```
-
-## 创建编辑器
-
-```ts
-import { Viewer, ViewOptions } from '@textbus/browser'
-
-import { rootComponent, rootComponentLoader } from './root.component'
-
-const config: ViewOptions = {
-  // ...配置项
-}
-
-const editor = new Viewer(rootComponent, rootComponentLoader, config)
-```
-
-其中 `rootComponent`，`rootComponentLoader` 实现请参考[官方文档](https://textbus.io/docs/guide)。
-
-### 配置项
-
-配置项接口如下：
-
-```ts
-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[]
-}
-```
-
-### 启动
-
-```ts
-const host = document.getElementById('editor')
-
-editor.mount(host).then(() => {
-  console.log('编辑器创建成功！')
-})
-```
-
-### 销毁编辑器
-
-```ts
-editor.destroy()
-```
-
-### 获取焦点
-
-```ts
-editor.focus()
-```
-
-### 取消焦点
-
-```ts
-editor.blur()
-```
-
-### 获取 HTML 内容
-
-```ts
-const content = editor.getContents().content
-```
-
-### 获取 JSON 内容
-
-```ts
-const json = editor.getJSON().content
-```
-
-### 替换内容
-
-```ts
-editor.replaceContent('<p>新内容！</p>')
-
-editor.replaceContent({
-  // 必须为 Textbus 导出的 JSON 格式
-})
-```
-
-### 清空编辑器
-
-```ts
-editor.replaceContent('')
-```
-
-### 官方文档
-
-更多文档请参考：[中文文档](https://textbus.io)
+Textbus PC 浏览器支持模块
+=====================
+
+Textbus 是一套用于构建富交互的富文本编辑框架。和大多数富文本编辑器不同的是，Textbus 以组件为核心，格式为辅助，并大幅简化了富文本编辑器开发中常见
+API，且提供了更高的抽象层，使 Textbus 不仅易于上手，同时还能驱动复杂的富文本应用。
+
+本项目为 Textbus PC 端浏览器中间层实现，提供了 Textbus PC 端所需要的编辑器基本支持能力。如光标、选区桥接、DOM 解析及渲染能力桥接等。
+
+如果你需要一个开箱即用的编辑器，请参考[官方文档](https://textbus.io)。
+
+## 安装
+
+```
+npm install @textbus/core @textbus/platform-browser
+```
+
+## 创建编辑器
+
+```ts
+import { Viewer, ViewOptions } from '@textbus/browser'
+
+import { rootComponent, rootComponentLoader } from './root.component'
+
+const config: ViewOptions = {
+  // ...配置项
+}
+
+const editor = new Viewer(rootComponent, rootComponentLoader, config)
+```
+
+其中 `rootComponent`，`rootComponentLoader` 实现请参考[官方文档](https://textbus.io/docs/guide)。
+
+### 配置项
+
+配置项接口如下：
+
+```ts
+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[]
+}
+```
+
+### 启动
+
+```ts
+const host = document.getElementById('editor')
+
+editor.mount(host).then(() => {
+  console.log('编辑器创建成功！')
+})
+```
+
+### 销毁编辑器
+
+```ts
+editor.destroy()
+```
+
+### 获取焦点
+
+```ts
+editor.focus()
+```
+
+### 取消焦点
+
+```ts
+editor.blur()
+```
+
+### 获取 HTML 内容
+
+```ts
+const content = editor.getContents().content
+```
+
+### 获取 JSON 内容
+
+```ts
+const json = editor.getJSON().content
+```
+
+### 替换内容
+
+```ts
+editor.replaceContent('<p>新内容！</p>')
+
+editor.replaceContent({
+  // 必须为 Textbus 导出的 JSON 格式
+})
+```
+
+### 清空编辑器
+
+```ts
+editor.replaceContent('')
+```
+
+### 官方文档
+
+更多文档请参考：[中文文档](https://textbus.io)

package/bundles/_utils/env.d.ts

@@ -1,5 +1,5 @@
-export declare const isWindows: () => boolean;
-export declare const isMac: () => boolean;
-export declare const isSafari: () => boolean;
-export declare const isFirefox: () => boolean;
-export declare const isMobileBrowser: () => boolean;
+export declare const isWindows: () => boolean;
+export declare const isMac: () => boolean;
+export declare const isSafari: () => boolean;
+export declare const isFirefox: () => boolean;
+export declare const isMobileBrowser: () => boolean;

package/bundles/_utils/uikit.d.ts

@@ -1,26 +1,26 @@
-/**
- * 选区焦点可视位置
- */
-export interface Rect {
-    left: number;
-    top: number;
-    width: number;
-    height: number;
-}
-export interface UIElementParams {
-    classes?: string[];
-    attrs?: {
-        [key: string]: any;
-    };
-    props?: {
-        [key: string]: any;
-    };
-    styles?: {
-        [key: string]: any;
-    };
-    children?: (Node | null)[];
-    on?: Record<string, (ev: Event) => void>;
-}
-export declare function createElement(tagName: string, options?: UIElementParams): HTMLElement;
-export declare function createTextNode(content: string): Text;
-export declare function getLayoutRectByRange(range: Range): Rect;
+/**
+ * 选区焦点可视位置
+ */
+export interface Rect {
+    left: number;
+    top: number;
+    width: number;
+    height: number;
+}
+export interface UIElementParams {
+    classes?: string[];
+    attrs?: {
+        [key: string]: any;
+    };
+    props?: {
+        [key: string]: any;
+    };
+    styles?: {
+        [key: string]: any;
+    };
+    children?: (Node | null)[];
+    on?: Record<string, (ev: Event) => void>;
+}
+export declare function createElement(tagName: string, options?: UIElementParams): HTMLElement;
+export declare function createTextNode(content: string): Text;
+export declare function getLayoutRectByRange(range: Range): Rect;

package/bundles/collaborate/collaborate-cursor.d.ts

@@ -1,45 +1,45 @@
-import { Injector } from '@tanbo/di';
-import { Selection, SelectionPaths, AbstractSelection, Scheduler } from '@textbus/core';
-import { SelectionBridge } from '../core/selection-bridge';
-import { Rect } from '../_utils/uikit';
-export interface RemoteSelection {
-    id: string;
-    color: string;
-    username: string;
-    paths: SelectionPaths;
-}
-export interface SelectionRect extends Rect {
-    color: string;
-    username: string;
-    id: string;
-}
-export interface RemoteSelectionCursor {
-    cursor: HTMLElement;
-    anchor: HTMLElement;
-    userTip: HTMLElement;
-}
-export declare abstract class CollaborateSelectionAwarenessDelegate {
-    abstract getRects(abstractSelection: AbstractSelection, nativeRange: Range): false | Rect[];
-}
-export declare class CollaborateCursor {
-    private injector;
-    private nativeSelection;
-    private scheduler;
-    private selection;
-    private awarenessDelegate?;
-    private host;
-    private canvasContainer;
-    private canvas;
-    private context;
-    private tooltips;
-    private onRectsChange;
-    private subscription;
-    private currentSelection;
-    private container;
-    constructor(injector: Injector, nativeSelection: SelectionBridge, scheduler: Scheduler, selection: Selection, awarenessDelegate?: CollaborateSelectionAwarenessDelegate | undefined);
-    refresh(): void;
-    destroy(): void;
-    draw(paths: RemoteSelection[]): void;
-    protected drawUserCursor(rects: SelectionRect[]): void;
-    private getUserCursor;
-}
+import { Injector } from '@tanbo/di';
+import { Selection, SelectionPaths, AbstractSelection, Scheduler } from '@textbus/core';
+import { SelectionBridge } from '../core/selection-bridge';
+import { Rect } from '../_utils/uikit';
+export interface RemoteSelection {
+    id: string;
+    color: string;
+    username: string;
+    paths: SelectionPaths;
+}
+export interface SelectionRect extends Rect {
+    color: string;
+    username: string;
+    id: string;
+}
+export interface RemoteSelectionCursor {
+    cursor: HTMLElement;
+    anchor: HTMLElement;
+    userTip: HTMLElement;
+}
+export declare abstract class CollaborateSelectionAwarenessDelegate {
+    abstract getRects(abstractSelection: AbstractSelection, nativeRange: Range): false | Rect[];
+}
+export declare class CollaborateCursor {
+    private injector;
+    private nativeSelection;
+    private scheduler;
+    private selection;
+    private awarenessDelegate?;
+    private host;
+    private canvasContainer;
+    private canvas;
+    private context;
+    private tooltips;
+    private onRectsChange;
+    private subscription;
+    private currentSelection;
+    private container;
+    constructor(injector: Injector, nativeSelection: SelectionBridge, scheduler: Scheduler, selection: Selection, awarenessDelegate?: CollaborateSelectionAwarenessDelegate | undefined);
+    refresh(): void;
+    destroy(): void;
+    draw(paths: RemoteSelection[]): void;
+    protected drawUserCursor(rects: SelectionRect[]): void;
+    private getUserCursor;
+}

package/bundles/core/_api.d.ts

@@ -1,6 +1,6 @@
-export * from './dom-renderer';
-export * from './injection-tokens';
-export * from './magic-input';
-export * from './native-input';
-export * from './selection-bridge';
-export * from './types';
+export * from './dom-renderer';
+export * from './injection-tokens';
+export * from './magic-input';
+export * from './native-input';
+export * from './selection-bridge';
+export * from './types';

package/bundles/core/dom-renderer.d.ts

@@ -1,53 +1,53 @@
-import { NativeNode, NativeRenderer } from '@textbus/core';
-/**
- * Textbus PC 端浏览器渲染能力实现
- */
-export declare class DomRenderer implements NativeRenderer {
-    isSVG: RegExp;
-    xlinkNameSpace: string;
-    possibleXlinkNames: {
-        xlinkActuate: string;
-        xlinkactuate: string;
-        'xlink:actuate': string;
-        xlinkArcrole: string;
-        xlinkarcrole: string;
-        'xlink:arcrole': string;
-        xlinkHref: string;
-        xlinkhref: string;
-        'xlink:href': string;
-        xlinkRole: string;
-        xlinkrole: string;
-        'xlink:role': string;
-        xlinkShow: string;
-        xlinkshow: string;
-        'xlink:show': string;
-        xlinkTitle: string;
-        xlinktitle: string;
-        'xlink:title': string;
-        xlinkType: string;
-        xlinktype: string;
-        'xlink:type': string;
-    };
-    booleanProps: Record<string, string[]>;
-    valueProps: Record<string, string[]>;
-    listen<T = any>(node: NativeNode, type: string, callback: (ev: T) => any): void;
-    unListen(node: NativeNode, type: string, callback: (ev: any) => any): void;
-    createTextNode(textContent: string): NativeNode;
-    createElement(name: string): NativeNode;
-    appendChild(parent: NativeNode, newChild: NativeNode): void;
-    remove(node: NativeNode): void;
-    insertBefore(newNode: NativeNode, ref: NativeNode): void;
-    getChildByIndex(parent: NativeNode, index: number): NativeNode | null;
-    addClass(target: NativeNode, name: string): void;
-    removeClass(target: NativeNode, name: string): void;
-    setStyle(target: NativeNode, key: string, value: any): void;
-    syncTextContent(target: NativeNode, content: string): void;
-    removeStyle(target: NativeNode, key: string): void;
-    setAttribute(target: NativeNode, key: string, value: string): void;
-    removeAttribute(target: NativeNode, key: string): void;
-    setXlinkAttribute(target: NativeNode, key: string, value: string): void;
-    removeXlinkAttribute(target: NativeNode, key: string): void;
-    replace(newChild: NativeNode, oldChild: NativeNode): void;
-    copy(): void;
-    static replaceEmpty(s: string): string;
-}
+import { NativeNode, NativeRenderer } from '@textbus/core';
+/**
+ * Textbus PC 端浏览器渲染能力实现
+ */
+export declare class DomRenderer implements NativeRenderer {
+    isSVG: RegExp;
+    xlinkNameSpace: string;
+    possibleXlinkNames: {
+        xlinkActuate: string;
+        xlinkactuate: string;
+        'xlink:actuate': string;
+        xlinkArcrole: string;
+        xlinkarcrole: string;
+        'xlink:arcrole': string;
+        xlinkHref: string;
+        xlinkhref: string;
+        'xlink:href': string;
+        xlinkRole: string;
+        xlinkrole: string;
+        'xlink:role': string;
+        xlinkShow: string;
+        xlinkshow: string;
+        'xlink:show': string;
+        xlinkTitle: string;
+        xlinktitle: string;
+        'xlink:title': string;
+        xlinkType: string;
+        xlinktype: string;
+        'xlink:type': string;
+    };
+    booleanProps: Record<string, string[]>;
+    valueProps: Record<string, string[]>;
+    listen<T = any>(node: NativeNode, type: string, callback: (ev: T) => any): void;
+    unListen(node: NativeNode, type: string, callback: (ev: any) => any): void;
+    createTextNode(textContent: string): NativeNode;
+    createElement(name: string): NativeNode;
+    appendChild(parent: NativeNode, newChild: NativeNode): void;
+    remove(node: NativeNode): void;
+    insertBefore(newNode: NativeNode, ref: NativeNode): void;
+    getChildByIndex(parent: NativeNode, index: number): NativeNode | null;
+    addClass(target: NativeNode, name: string): void;
+    removeClass(target: NativeNode, name: string): void;
+    setStyle(target: NativeNode, key: string, value: any): void;
+    syncTextContent(target: NativeNode, content: string): void;
+    removeStyle(target: NativeNode, key: string): void;
+    setAttribute(target: NativeNode, key: string, value: string): void;
+    removeAttribute(target: NativeNode, key: string): void;
+    setXlinkAttribute(target: NativeNode, key: string, value: string): void;
+    removeXlinkAttribute(target: NativeNode, key: string): void;
+    replace(newChild: NativeNode, oldChild: NativeNode): void;
+    copy(): void;
+    static replaceEmpty(s: string): string;
+}

package/bundles/core/injection-tokens.d.ts

@@ -1,18 +1,18 @@
-import { InjectionToken } from '@tanbo/di';
-import { ViewOptions } from './types';
-/**
- * 编辑器可选项依赖注入 token
- */
-export declare const EDITOR_OPTIONS: InjectionToken<ViewOptions>;
-/**
- * 编辑器容器依赖注入 token
- */
-export declare const VIEW_CONTAINER: InjectionToken<HTMLElement>;
-/**
- * 编辑器容器依赖注入 token
- */
-export declare const VIEW_DOCUMENT: InjectionToken<HTMLElement>;
-/**
- * 编辑器容器遮罩层 token
- */
-export declare const VIEW_MASK: InjectionToken<HTMLElement>;
+import { InjectionToken } from '@tanbo/di';
+import { ViewOptions } from './types';
+/**
+ * 编辑器可选项依赖注入 token
+ */
+export declare const EDITOR_OPTIONS: InjectionToken<ViewOptions>;
+/**
+ * 编辑器容器依赖注入 token
+ */
+export declare const VIEW_CONTAINER: InjectionToken<HTMLElement>;
+/**
+ * 编辑器容器依赖注入 token
+ */
+export declare const VIEW_DOCUMENT: InjectionToken<HTMLElement>;
+/**
+ * 编辑器容器遮罩层 token
+ */
+export declare const VIEW_MASK: InjectionToken<HTMLElement>;