UNPKG

@portabletext/editor

Version:

Portable Text Editor made in React

192 lines 5.44 kB
import { F as BlockOffset, Ft as KeyedSegment, It as Path, Nt as BlockPath, Pt as ChildPath, X as EditorContext, ot as EditorSelection, st as EditorSelectionPoint } from "../_chunks-dts/behavior.types.action.js"; import * as _portabletext_schema9 from "@portabletext/schema"; import { PortableTextBlock, PortableTextTextBlock, isSpan, isTextBlock } from "@portabletext/schema"; /** * @public */ declare function blockOffsetToSpanSelectionPoint({ context, blockOffset, direction }: { context: Pick<EditorContext, 'schema' | 'value'>; blockOffset: BlockOffset; direction: 'forward' | 'backward'; }): { path: ChildPath; offset: number; } | undefined; /** * @public */ declare function spanSelectionPointToBlockOffset({ context, selectionPoint }: { context: Pick<EditorContext, 'schema' | 'value'>; selectionPoint: EditorSelectionPoint; }): BlockOffset | undefined; /** * @public */ declare function blockOffsetToBlockSelectionPoint({ context, blockOffset }: { context: Pick<EditorContext, 'value'>; blockOffset: BlockOffset; }): EditorSelectionPoint | undefined; /** * @public */ declare function blockOffsetToSelectionPoint({ context, blockOffset, direction }: { context: Pick<EditorContext, 'schema' | 'value'>; blockOffset: BlockOffset; direction: 'forward' | 'backward'; }): EditorSelectionPoint | undefined; /** * @public */ declare function blockOffsetsToSelection({ context, offsets, backward }: { context: Pick<EditorContext, 'schema' | 'value'>; offsets: { anchor: BlockOffset; focus: BlockOffset; }; backward?: boolean; }): EditorSelection; /** * @public */ declare function childSelectionPointToBlockOffset({ context, selectionPoint }: { context: Pick<EditorContext, 'schema' | 'value'>; selectionPoint: EditorSelectionPoint; }): BlockOffset | undefined; /** * @public */ declare function getBlockEndPoint({ context, block }: { context: Pick<EditorContext, 'schema'>; block: { node: PortableTextBlock; path: BlockPath; }; }): EditorSelectionPoint; /** * @public */ declare function getBlockStartPoint({ context, block }: { context: Pick<EditorContext, 'schema'>; block: { node: PortableTextBlock; path: BlockPath; }; }): EditorSelectionPoint; /** * @public */ declare function getSelectionEndPoint<TEditorSelection extends NonNullable<EditorSelection> | null, TEditorSelectionPoint extends EditorSelectionPoint | null = (TEditorSelection extends NonNullable<EditorSelection> ? EditorSelectionPoint : null)>(selection: TEditorSelection): TEditorSelectionPoint; /** * @public */ declare function getSelectionStartPoint<TEditorSelection extends NonNullable<EditorSelection> | null, TEditorSelectionPoint extends EditorSelectionPoint | null = (TEditorSelection extends NonNullable<EditorSelection> ? EditorSelectionPoint : null)>(selection: TEditorSelection): TEditorSelectionPoint; /** * @public */ declare function getTextBlockText(block: PortableTextTextBlock): string; /** * @public */ declare function isEmptyTextBlock(context: Pick<EditorContext, 'schema'>, block: PortableTextBlock | unknown): boolean; /** * @public */ declare function isEqualPaths(a: Path, b: Path): boolean; /** * @public */ declare function isEqualSelectionPoints(a: EditorSelectionPoint, b: EditorSelectionPoint): boolean; /** * @public */ declare function isEqualSelections(a: EditorSelection, b: EditorSelection): boolean; /** * @public */ declare function isKeyedSegment(segment: unknown): segment is KeyedSegment; /** * @public */ declare function isSelectionCollapsed(selection: EditorSelection): boolean; /** * @beta */ declare function mergeTextBlocks({ context, targetBlock, incomingBlock }: { context: Pick<EditorContext, 'keyGenerator' | 'schema'>; targetBlock: PortableTextTextBlock; incomingBlock: PortableTextTextBlock; }): PortableTextTextBlock<_portabletext_schema9.PortableTextObject | _portabletext_schema9.PortableTextSpan>; /** * @public */ declare function reverseSelection<TEditorSelection extends NonNullable<EditorSelection> | null>(selection: TEditorSelection): TEditorSelection; /** * @public */ declare function selectionPointToBlockOffset({ context, selectionPoint }: { context: Pick<EditorContext, 'schema' | 'value'>; selectionPoint: EditorSelectionPoint; }): BlockOffset | undefined; /** * @public */ declare function sliceBlocks({ context, blocks }: { context: Pick<EditorContext, 'schema' | 'selection'> & { keyGenerator?: () => string; }; blocks: Array<PortableTextBlock>; }): Array<PortableTextBlock>; /** * @beta */ declare function splitTextBlock({ context, block, point }: { context: Pick<EditorContext, 'schema'>; block: PortableTextTextBlock; point: EditorSelectionPoint; }): { before: PortableTextTextBlock; after: PortableTextTextBlock; } | undefined; export { blockOffsetToBlockSelectionPoint, blockOffsetToSelectionPoint, blockOffsetToSpanSelectionPoint, blockOffsetsToSelection, childSelectionPointToBlockOffset, getBlockEndPoint, getBlockStartPoint, getSelectionEndPoint, getSelectionStartPoint, getTextBlockText, isEmptyTextBlock, isEqualPaths, isEqualSelectionPoints, isEqualSelections, isKeyedSegment, isSelectionCollapsed, isSpan, isTextBlock, mergeTextBlocks, reverseSelection, selectionPointToBlockOffset, sliceBlocks, spanSelectionPointToBlockOffset, splitTextBlock }; //# sourceMappingURL=index.d.ts.map