@vscode/markdown-editor 0.0.2-83 → 0.0.2-84

package/dist/index.d.ts

@@ -386,16 +386,10 @@ declare interface Comment_2 {
 export { Comment_2 as Comment }
 
 /**
- * A self-contained comment input box — a rounded panel with an auto-growing
- * textarea and a send button, styled after the gdocs/Word "add a comment"
- * affordance.
+ * The compact editing state for a markdown comment.
  *
- * This widget is *positioning-agnostic*: it only owns its own DOM and state.
- * A host (the comment-mode controller, or a fixture) mounts {@link element}
- * wherever it likes and is responsible for placing it relative to a selection.
- *
- * State is observable-driven (no framework): {@link value} reflects the live
- * textarea content; submit/cancel are reported through the option callbacks.
+ * The widget owns its DOM and draft state but not its position. The comment-mode
+ * controller mounts it next to the active selection.
  */
 export declare class CommentInputWidget extends Disposable {
     private readonly _options?;
@@ -406,27 +400,24 @@ export declare class CommentInputWidget extends Disposable {
     private readonly _value;
     /** Live, untrimmed textarea content. */
     get value(): IObservable<string>;
-    /** The raw textarea, exposed so a host can move focus into it (e.g. on Tab). */
+    /** The raw textarea, exposed so a host can move focus into it. */
     get inputElement(): HTMLTextAreaElement;
     constructor(_options?: CommentInputWidgetOptions | undefined);
-    /** Move focus into the textarea (caret at the end). */
     focus(): void;
-    /** Replace the textarea content. */
     setText(text: string): void;
-    /** Clear the textarea. */
     clear(): void;
     private _submit;
     private _autoSize;
 }
 
 export declare interface CommentInputWidgetOptions {
-    /** Placeholder shown while the textarea is empty. Defaults to "Add Comment". */
+    /** Placeholder shown while the textarea is empty. Defaults to "Add comment". */
     readonly placeholder?: string;
     /** Called after the textarea changes size. */
     readonly onDidChangeSize?: () => void;
     /**
-     * Called when the user submits a non-empty comment (Enter or the send
-     * button). The text is trimmed; never called with an empty string.
+     * Called when the user submits a non-empty comment (Enter or the add button).
+     * The text is trimmed; never called with an empty string.
      */
     readonly onSubmit?: (text: string) => void;
     /** Called when the user dismisses the input (Escape). */
@@ -434,7 +425,7 @@ export declare interface CommentInputWidgetOptions {
 }
 
 /**
- * Comment mode — a gdocs/Word-style "add a comment" affordance layered on top of
+ * Comment mode — a compact "add a comment" affordance layered on top of
  * the editor *without modifying it*. It reads the editor's public observables
  * ({@link EditorModel.readonlyMode}, {@link EditorModel.selection}) and the
  * exposed {@link EditorView.caretRect} geometry, and mounts a
@@ -502,20 +493,10 @@ export declare interface CommentModeControllerOptions {
     readonly gap?: number;
 }
 
-/** Human-readable labels (for pickers / dropdowns). */
-export declare const COMMENTS_DESIGN_LABELS: Record<CommentsDesign, string>;
-
-/** design id → presenter factory over a shared CommentsModel + EditorView. */
-export declare const COMMENTS_DESIGNS: Record<CommentsDesign, CommentsPresenterFactory>;
-
-/** The available comment rendering designs. */
-export declare type CommentsDesign = 'connected' | 'vscode' | 'vscode-v2';
-
 /**
- * Seedable store of {@link Comment}s for the comment-mode contribution. Owns the
- * comment list and the shared hover state; it has no opinion on rendering or
- * persistence — a host seeds it via {@link set}/{@link add} and observes
- * {@link comments}.
+ * Seedable store of {@link Comment}s for the comment-mode contribution. It has
+ * no opinion on rendering or persistence — a host seeds it via
+ * {@link set}/{@link add} and observes {@link comments}.
  */
 export declare class CommentsModel {
     private readonly _comments;
@@ -523,11 +504,6 @@ export declare class CommentsModel {
     private _sequence;
     /** The current comments, in insertion order. */
     get comments(): IObservable<readonly Comment_2[]>;
-    /**
-     * The comment currently hovered (by its card or its highlight), or
-     * `undefined`. Shared so the card and the highlight can react together.
-     */
-    readonly hoveredId: ISettableObservable<string | undefined>;
     /** Replace the whole comment set. */
     set(comments: readonly Comment_2[]): void;
     /**
@@ -546,55 +522,41 @@ export declare class CommentsModel {
     remove(id: string): void;
 }
 
-/** Optional, design-specific context a presenter may use (ignored by others). */
-export declare interface CommentsPresenterContext {
-    /** Light/dark hint for the token-wrapped VS Code widget designs. */
-    readonly theme?: 'light' | 'dark';
-    /**
-     * Resolves a source offset to a 1-based line number, for designs that show
-     * line info (the VS Code V1 card). Optional because the model itself carries
-     * no text; the host (which owns the source) supplies it.
-     */
-    readonly resolveLine?: (offset: number) => number;
-}
-
-/** Builds a presenter for a given model + editor view. */
-export declare type CommentsPresenterFactory = (model: CommentsModel, view: EditorView, context?: CommentsPresenterContext) => ICommentsPresenter;
-
 /** A comment the user submitted, with the source range it was anchored to. */
 export declare interface CommentSubmission {
     readonly text: string;
     readonly range: OffsetRange;
 }
 
-/**
- * Renders persistent comments as a gdocs-style side rail: each comment's range
- * is highlighted (reusing the editor's selection geometry via
- * {@link EditorView.rangeRects}), a leader line curves from the bottom of that
- * highlight to a card stacked in the right rail, and cards never overlap.
- *
- * Everything is mounted into {@link EditorView.overlayContainer} so it shares
- * the selection/caret coordinate space and scrolls with the document. When the
- * editor's natural right margin is too narrow for the rail, the view reserves
- * proportional space by padding the editor on the right — but only while there
- * are comments.
- */
+/** Displays posted comments beside their source ranges. */
 export declare class CommentsView extends Disposable {
     private readonly _model;
     private readonly _view;
     private readonly _layer;
     private readonly _entries;
+    private _order;
+    private _pendingRevealCommentId;
     constructor(_model: CommentsModel, _view: EditorView);
-    private _createLayer;
-    private _update;
-    /** Create/update/remove per-comment DOM to match `comments`. */
+    revealComment(id: string): void;
     private _reconcile;
-    private _createEntry;
-    private _fillCard;
-    private _disposeEntry;
-    /** Position highlights, cards (stacked) and leader lines. */
-    private _layout;
-    private _applyHover;
+    private _relayout;
+    private _revealPendingComment;
+}
+
+/** Compact posted state for a markdown comment. */
+export declare class CommentWidget {
+    private readonly _domNode;
+    private readonly _disposables;
+    get element(): HTMLElement;
+    constructor(options: CommentWidgetOptions);
+    dispose(): void;
+}
+
+export declare interface CommentWidgetOptions {
+    /** The posted comment body. */
+    readonly body: string;
+    /** If provided, shows a delete action and invokes it when activated. */
+    readonly onDelete?: () => void;
 }
 
 /** The lossless source slices of a complete block HTML comment. */
@@ -1902,9 +1864,6 @@ export declare interface IClipboardStrategy {
     connect(context: IClipboardContext): IDisposable;
 }
 
-/** A live rendering of a {@link CommentsModel}. Dispose to unmount it. */
-export declare type ICommentsPresenter = IDisposable;
-
 /** The Monarch language definitions the default highlighter wires up. */
 export declare interface IDefaultMonarchGrammars {
     typescript: unknown;
@@ -2931,29 +2890,6 @@ export declare interface SourceEditEvent {
 
 export declare type SourceOffset = number;
 
-export declare abstract class StackedCommentsPresenter extends Disposable implements ICommentsPresenter {
-    protected readonly model: CommentsModel;
-    protected readonly view: EditorView;
-    protected readonly context?: CommentsPresenterContext | undefined;
-    private readonly _layer;
-    private readonly _entries;
-    private _order;
-    private _pendingRevealCommentId;
-    constructor(model: CommentsModel, view: EditorView, context?: CommentsPresenterContext | undefined);
-    /** Build the card DOM for a comment. Called once per new comment. */
-    protected abstract createWidget(comment: Comment_2): StackWidget;
-    revealComment(id: string): void;
-    private _reconcile;
-    private _relayout;
-    private _revealPendingComment;
-}
-
-/** The minimal widget contract a subclass must produce. */
-export declare interface StackWidget {
-    readonly element: HTMLElement;
-    dispose(): void;
-}
-
 export declare class StrikethroughAstNode extends AstNode {
     readonly openMarker: MarkerAstNode;
     readonly content: readonly (InlineAstNode | GlueAstNode)[];
@@ -3552,14 +3488,6 @@ export declare const vscodeKeyboardProfile: KeyboardProfile;
 
 export declare const vscodeLocalKeyboardProfile: KeyboardProfile;
 
-export declare class VscodeStackedCommentsView extends StackedCommentsPresenter {
-    protected createWidget(comment: Comment_2): StackWidget;
-}
-
-export declare class VsCodeV2CommentsView extends StackedCommentsPresenter {
-    protected createWidget(comment: Comment_2): StackWidget;
-}
-
 export declare interface WordNavigationConfig {
     readonly wordSeparators: string;
     readonly wordSegmenterLocales: readonly string[];