@adecore/editor 0.0.1 → 0.17.0-beta.1

package/dist/view.d.ts

@@ -0,0 +1,382 @@
+import { type DocumentModel, type FoldHints, type FoldRole, type FoldingRange, type Selection as EditorSelection } from '@adecore/editor-core';
+import { FindController } from './find.ts';
+import { type BlockWidget, EditorLayout, type Inlay } from './layout.ts';
+import { type ScrollKind } from './scroll.ts';
+import { TokenCache } from './tokens.ts';
+import type { EditorBlock, EditorChangeMark, EditorCodeBlockOptions, EditorFindQuery, EditorFindState, EditorHighlightKind, EditorMarkerSeverity, EditorMessages, EditorRect, EditorSmartKeys, LineTokenizer, ScopeColors } from './types.ts';
+export interface ViewSettings {
+    language: string | undefined;
+    tabSize: number;
+    insertSpaces: boolean;
+    readOnly: boolean;
+    readOnlyReason: string | undefined;
+    wrap: boolean;
+    smartKeys: EditorSmartKeys;
+    messages: Partial<EditorMessages>;
+    guides: boolean;
+    whitespace: boolean;
+    rightMargin: number | null;
+    foldOutline: 'off' | 'hover' | 'always';
+}
+export type ViewFold = Omit<FoldingRange, 'kind'> & {
+    kind: FoldingRange['kind'] | 'custom';
+};
+export interface Occurrence {
+    from: number;
+    to: number;
+    kind?: EditorHighlightKind;
+}
+export interface ViewSemanticToken {
+    from: number;
+    to: number;
+    scopes: readonly string[];
+}
+export interface ViewMarker {
+    severity: EditorMarkerSeverity;
+    from: number;
+    to: number;
+    unnecessary: boolean;
+    deprecated: boolean;
+    message?: string;
+}
+export declare class EditorView {
+    readonly root: HTMLElement;
+    readonly viewport: HTMLElement;
+    readonly input: HTMLTextAreaElement;
+    readonly layout: EditorLayout;
+    readonly find: FindController;
+    readonly tokens: TokenCache;
+    private readonly content;
+    private readonly gutter;
+    private readonly gutterLines;
+    private readonly overlays;
+    private readonly over;
+    private readonly carets;
+    private readonly remote;
+    private readonly actions;
+    private readonly preview;
+    private readonly signs;
+    private readonly notice;
+    private readonly sticky;
+    private readonly overview;
+    private readonly tickTip;
+    private readonly painter;
+    private readonly document;
+    private readonly resizeObserver;
+    private readonly blockObserver;
+    private readonly subscription;
+    private readonly findListeners;
+    private readonly scopeListeners;
+    private readonly viewListeners;
+    private readonly gutterActionListeners;
+    private gutterAction;
+    private readonly gutterMarkerListeners;
+    private readonly gutterMarkers;
+    private semantic;
+    private scopeColors;
+    private semanticVersion;
+    private semanticIndex;
+    private readonly semanticLines;
+    private markers;
+    private markerVersion;
+    private viewKey;
+    private readonly hoverListeners;
+    private hoverOffset;
+    private readonly outline;
+    private stickyEntries;
+    private scopeKey;
+    private changeMarks;
+    private changeVersion;
+    private readonly attribution;
+    private readonly highlights;
+    private remoteCarets;
+    private remoteKey;
+    private readonly lineActions;
+    private readonly actionElements;
+    private readonly attributionListeners;
+    private attributionHover;
+    private attributionPointer;
+    private readonly tracked;
+    private overviewKey;
+    private gutterWidth;
+    private frame;
+    private caretTimer;
+    private caretKey;
+    private renderedScroll;
+    private font;
+    private layoutVersion;
+    private revision;
+    private rendering;
+    private frameGeometry;
+    private disposed;
+    private inlays;
+    private readonly blocks;
+    private lenses;
+    private occurrences;
+    private replacePreview;
+    private dropCaret;
+    private activeGuideCache;
+    columnMode: boolean;
+    private scrollRun;
+    private selectionOccurrenceCache;
+    private link;
+    private composition;
+    private ghost;
+    private ghostSerial;
+    private foldRanges;
+    private customFolds;
+    private collapsed;
+    private foldHints;
+    private defaultRoles;
+    private settled;
+    private foldTimer;
+    private colorTimer;
+    private noticeTimer;
+    private bracketCache;
+    private wrapWidth;
+    private rowEndCaret;
+    private topAnchor;
+    readonly model: DocumentModel;
+    readonly settings: ViewSettings;
+    constructor(container: HTMLElement, model: DocumentModel, settings: ViewSettings);
+    applySettings(): void;
+    refreshFont(): void;
+    setTokenizer(tokenizer: LineTokenizer | null): void;
+    setInlays(inlays: readonly Inlay[]): void;
+    setBlockWidgets(owner: string, blocks: readonly BlockWidget[]): void;
+    setLenses(lenses: readonly BlockWidget[]): void;
+    private allBlocks;
+    setOccurrences(occurrences: readonly Occurrence[]): void;
+    setLink(link: {
+        from: number;
+        to: number;
+    } | null): void;
+    setSemanticTokens(tokens: readonly ViewSemanticToken[] | null): void;
+    setScopeColors(colors: ScopeColors | null): void;
+    private styledTokensOf;
+    private semanticSpans;
+    setMarkers(markers: readonly ViewMarker[]): void;
+    setComposition(text: string | undefined): void;
+    notify(message: string): void;
+    get gutterElement(): HTMLElement;
+    get stickyElement(): HTMLElement;
+    focus(): void;
+    get focused(): boolean;
+    get viewportHeight(): number;
+    private get scrollTop();
+    private get scrollLeft();
+    private get clientWidth();
+    private get clientHeight();
+    private get overscan();
+    private get viewportWidth();
+    private modelChanged;
+    private mapTracked;
+    trackRange(from: number, to: number): {
+        get(): {
+            from: number;
+            to: number;
+        } | null;
+        dispose(): void;
+    };
+    private mappedFolds;
+    private displayedInlays;
+    setGhost(ghost: {
+        at: number;
+        text: string;
+        accessory: ((container: HTMLElement) => void) | undefined;
+    } | null): void;
+    private layoutGhostParts;
+    private configureText;
+    private foldStates;
+    private scheduleFolds;
+    refreshFolds(): void;
+    private withCustomFolds;
+    private closerOf;
+    private foldAt;
+    private soleFoldAt;
+    private foldsAt;
+    private isCollapsed;
+    private setCollapsed;
+    toggleFold(line: number, collapse?: boolean): boolean;
+    collapseRegion(): void;
+    expandRegion(): void;
+    private foldTreeAtCaret;
+    collapseRecursively(): void;
+    expandRecursively(): void;
+    foldAll(collapse: boolean): void;
+    foldSelection(): void;
+    getFolds(): {
+        collapsed: {
+            startLine: number;
+            endLine: number;
+        }[];
+        custom: {
+            startLine: number;
+            endLine: number;
+        }[];
+    };
+    restoreFolds(state: {
+        collapsed: readonly {
+            startLine: number;
+            endLine: number;
+        }[];
+        custom: readonly {
+            startLine: number;
+            endLine: number;
+        }[];
+    } | null, defaults?: readonly FoldRole[]): void;
+    setFoldHints(hints: FoldHints | null): void;
+    private applyFoldDefaults;
+    foldRole(role: FoldRole, collapse: boolean): void;
+    expandAllToLevel(level: number): void;
+    private refoldLayout;
+    private moveHiddenCarets;
+    ensureVisible(offset: number): void;
+    private anchorScroll;
+    private syncWrap;
+    private bracketAt;
+    private brackets;
+    matchingBracket(selection: {
+        anchor: number;
+        head: number;
+    }): {
+        at: number;
+        mate: number | undefined;
+    } | null;
+    unmatchedBracket(at: number): boolean;
+    contentPoint(clientX: number, clientY: number): {
+        x: number;
+        y: number;
+    };
+    offsetAtPoint(clientX: number, clientY: number): number;
+    private screenScale;
+    clientRectOf(offset: number): EditorRect | null;
+    characterAtPoint(clientX: number, clientY: number, target: EventTarget | null): number | null;
+    rowOf(offset: number): {
+        start: number;
+        end: number;
+    };
+    lineSpan(line: number): {
+        first: number;
+        last: number;
+    };
+    refoldMoved(folded: readonly {
+        startLine: number;
+        endLine: number;
+    }[], moves: readonly {
+        from: number;
+        to: number;
+    }[]): void;
+    markRowEnd(offset: number): void;
+    onHover(listener: (offset: number | null) => void): () => void;
+    private selectionOccurrences;
+    private wrapSigns;
+    private indentOf;
+    private effectiveIndent;
+    private activeGuide;
+    private scopeGuide;
+    private guideRects;
+    selectionAtPoint(clientX: number, clientY: number): EditorSelection | null;
+    setColumnMode(on: boolean): void;
+    setDropCaret(offset: number | null): void;
+    hoverMoved(event: PointerEvent): void;
+    setHover(offset: number | null): void;
+    onViewChange(listener: () => void): () => void;
+    private announceView;
+    private caretOf;
+    get scrollPlace(): {
+        x: number;
+        y: number;
+    };
+    cancelScroll(): void;
+    private reducedMotion;
+    scrollTo(x: number, y: number, animate?: boolean): void;
+    revealOffset(offset: number, kind?: ScrollKind, animate?: boolean): void;
+    revealCaret(kind?: ScrollKind): void;
+    setReplacePreview(replacement: string | null, preserveCase?: boolean): void;
+    private paintPreview;
+    setFind(query: EditorFindQuery | null, reveal: boolean): void;
+    stepFind(direction: 1 | -1): void;
+    onFind(listener: (state: EditorFindState) => void): () => void;
+    private announceFind;
+    revealFind(): void;
+    colorAhead(immediate?: boolean): void;
+    private syncGutter;
+    requestRender(): void;
+    scrolled(): void;
+    render(): void;
+    private paintDecorations;
+    setChangeMarks(marks: readonly EditorChangeMark[]): void;
+    private markedLines;
+    private changedLines;
+    setRemoteCarets(carets: readonly {
+        id: string;
+        name: string;
+        color: string;
+        at: number;
+    }[]): void;
+    private paintRemote;
+    setLineActions(owner: string, actions: readonly {
+        id: string;
+        at: number;
+        render: (container: HTMLElement) => void;
+    }[]): void;
+    private paintLineActions;
+    setAttributionMarks(marks: readonly {
+        id: string;
+        startLine: number;
+        endLine: number;
+        color: string;
+    }[]): void;
+    setLineHighlights(highlights: readonly {
+        startLine: number;
+        endLine: number;
+        color: string;
+        sign?: string;
+        fill?: string;
+    }[]): void;
+    private highlightedLines;
+    private highlightMarks;
+    renderCode(container: HTMLElement, text: string, options: EditorCodeBlockOptions): void;
+    private attributedLines;
+    onAttributionHover(listener: (hover: {
+        id: string;
+        rect: EditorRect;
+    } | null) => void): () => void;
+    private wireAttribution;
+    private refreshAttributionHover;
+    private attributionUnder;
+    visibleLines(): {
+        first: number;
+        last: number;
+    };
+    private wireOverview;
+    private jumpTo;
+    private paintOverview;
+    setBlocks(blocks: readonly EditorBlock[] | null): void;
+    onScope(listener: (scope: readonly EditorBlock[]) => void): () => void;
+    private announceScope;
+    private stickyLimit;
+    private stickyAt;
+    private stickyHeightAt;
+    private paintSticky;
+    jumpToHeader(line: number, depth: number): void;
+    setGutterAction(action: {
+        line: number;
+        label: string;
+    } | null): void;
+    onGutterAction(listener: (line: number) => void): () => void;
+    setGutterMarkers(owner: string, markers: readonly {
+        id: string;
+        line: number;
+        label: string;
+    }[]): void;
+    onGutterMarker(listener: (id: string) => void): () => void;
+    gutterMarkerIdOf(target: EventTarget | null): string | null;
+    pressGutterMarker(id: string): void;
+    private markersByLine;
+    gutterActionLineOf(target: EventTarget | null): number | null;
+    pressGutterAction(line: number): void;
+    foldLineOf(target: EventTarget | null): number | null;
+    dispose(): void;
+}