@vscode/markdown-editor 0.0.2-47 → 0.0.2-49

package/README.md

@@ -0,0 +1,26 @@
+# Markdown editor
+
+`@vscode/markdown-editor` is an experimental, browser-based hybrid Markdown
+editor. It keeps Markdown source as the canonical document while presenting
+inactive blocks in rendered form and active blocks in editable source form.
+
+Start with the [current implementation specification](./docs/specification.md).
+It explains the architecture, runtime data flow, public integration surface,
+extension points, the VS Code custom text editor adapter, tests, and current
+limitations.
+
+Other package documents:
+
+- [Original design](./docs/design.md) - historical design intent.
+- [Original implementation plan](./docs/plan.md) - historical roadmap; its
+  checkboxes do not describe current completion.
+- [Engineering backlog](./docs/todo.md) - known issues and future work.
+
+From this package directory:
+
+```sh
+pnpm test
+pnpm test:e2e
+pnpm build
+pnpm build:explorer
+```

package/dist/index.d.ts

@@ -663,6 +663,8 @@ export declare const cursorWordLeft: CursorCommand;
 
 export declare const cursorWordRight: CursorCommand;
 
+export declare const DEFAULT_INDENTATION_CONFIG: IndentationConfig;
+
 export declare const DEFAULT_WORD_NAVIGATION_CONFIG: WordNavigationConfig;
 
 export declare const DEFAULT_WORD_SEPARATORS = "`~!@#$%^&*()-=+[{]}\\|;:'\",.<>/?";
@@ -886,6 +888,9 @@ export declare class EditorController extends Disposable {
     private readonly _keyboardPlatform;
     private readonly _keyboardProfile;
     private readonly _historyStrategy;
+    private readonly _indentation;
+    private readonly _tabFocusStatus;
+    private _tabMovesFocus;
     /** Running click count for the current multi-click sequence (1, 2, 3, …). */
     private _clickCount;
     /** Timestamp and position of the previous pointer-down, for multi-click detection. */
@@ -933,6 +938,7 @@ export declare class EditorController extends Disposable {
      * arms a transient empty paragraph when at the end of a paragraph.
      */
     private _smartEnter;
+    private _registerTabFocusAccessibility;
 }
 
 /** Options for an {@link EditorController}. */
@@ -951,6 +957,8 @@ export declare interface EditorControllerOptions {
     readonly historyStrategy?: IHistoryStrategy;
     readonly keyboardPlatform?: KeyboardPlatform;
     readonly keyboardProfile?: KeyboardProfile;
+    /** Tab-stop settings used outside semantic list indentation. */
+    readonly indentation?: IndentationConfig;
     readonly find?: false;
 }
 
@@ -992,6 +1000,11 @@ export declare type EditorKeyboardAction = {
 } | {
     readonly kind: 'history';
     readonly command: HistoryKeyboardAction;
+} | {
+    readonly kind: 'tab';
+    readonly command: TabKeyboardAction;
+} | {
+    readonly kind: 'toggleTabFocus';
 } | {
     readonly kind: 'selectAll';
 } | {
@@ -1892,6 +1905,14 @@ export declare interface IMonarchApi {
     MonarchTokenizer: new (languageService: unknown, standaloneThemeService: unknown, languageId: string, lexer: unknown, configurationService: unknown) => MonarchTokenizer;
 }
 
+/** Controls tab-stop insertion and non-list line indentation. */
+export declare interface IndentationConfig {
+    /** Number of visual columns between tab stops. */
+    readonly tabSize: number;
+    /** Whether indentation uses spaces instead of tab characters. */
+    readonly insertSpaces: boolean;
+}
+
 export declare type InlineAstNode = TextAstNode | StrongAstNode | EmphasisAstNode | StrikethroughAstNode | InlineCodeAstNode | InlineMathAstNode | LinkAstNode | ImageAstNode;
 
 export declare class InlineCodeAstNode extends AstNode {
@@ -1956,6 +1977,12 @@ export declare const insertParagraph: EditCommand;
  */
 export declare const insertSmartEnter: (ctx: CursorCommandContext) => SmartEnterResult;
 
+/**
+ * VS Code-style Tab: insert to the next tab stop for a caret or partial
+ * single-line selection, and indent every selected line for a line selection.
+ */
+export declare function insertTab(config?: IndentationConfig): EditCommand;
+
 export declare function insertText(text: string): EditCommand;
 
 /**
@@ -2413,6 +2440,9 @@ export declare class OffsetRange {
     toString(): string;
 }
 
+/** Outdent the current line, or every line touched by the selection. */
+export declare function outdent(config?: IndentationConfig): EditCommand;
+
 export declare class ParagraphAstNode extends BlockAstNodeBase {
     readonly content: readonly (InlineAstNode | GlueAstNode)[];
     readonly leadingTrivia?: GlueAstNode | undefined;
@@ -2752,6 +2782,8 @@ declare class StrongViewData {
     constructor(ast: StrongAstNode, content: readonly AnyViewData[]);
 }
 
+declare type TabKeyboardAction = 'insert' | 'outdent';
+
 export declare class TableAstNode extends BlockAstNodeBase {
     readonly content: readonly (TableRowAstNode | GlueAstNode)[];
     readonly leadingTrivia?: GlueAstNode | undefined;