UNPKG

lexical-vue

Version:

An extensible Vue 3 web text-editor based on Lexical.

17 lines (16 loc) 1.91 kB
import type { BaseBinding, Binding, Provider, SyncCursorPositionsFn } from '@lexical/yjs'; import type { LexicalEditor } from 'lexical'; import type { MaybeRefOrGetter, Ref } from 'vue'; import type { Doc } from 'yjs'; import type { InitialEditorStateType } from '../types'; import { UndoManager } from 'yjs'; export declare function useYjsCollaboration(editor: LexicalEditor, id: MaybeRefOrGetter<string>, provider: Ref<Provider>, docMap: MaybeRefOrGetter<Map<string, Doc>>, name: MaybeRefOrGetter<string>, color: MaybeRefOrGetter<string>, shouldBootstrap: MaybeRefOrGetter<boolean>, binding: MaybeRefOrGetter<Binding>, doc: Ref<Doc | null>, cursorsContainerRef?: MaybeRefOrGetter<HTMLElement | null>, initialEditorState?: MaybeRefOrGetter<InitialEditorStateType>, awarenessData?: MaybeRefOrGetter<object>, syncCursorPositionsFn?: SyncCursorPositionsFn): import("vue").ComputedRef<import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any; }>>; export declare function useProvider(editor: LexicalEditor, provider: Ref<Provider>, name: MaybeRefOrGetter<string>, color: MaybeRefOrGetter<string>, isReloadingDoc: Ref<boolean>, awarenessData?: object, onBootstrap?: () => void): void; export declare function useYjsCursors(binding: MaybeRefOrGetter<BaseBinding>, cursorsContainerRef?: MaybeRefOrGetter<HTMLElement | null>): import("vue").ComputedRef<import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any; }>>; export declare function useYjsFocusTracking(editor: LexicalEditor, provider: Ref<Provider>, name: MaybeRefOrGetter<string>, color: MaybeRefOrGetter<string>, awarenessData?: object): void; export declare function useYjsHistory(editor: LexicalEditor, binding: MaybeRefOrGetter<Binding>): () => void; export declare function useYjsUndoManager(editor: LexicalEditor, undoManager: Ref<UndoManager>): () => void;