@prosekit/extensions 0.11.1 → 0.11.2

package/dist/prosekit-extensions-drop-cursor.d.ts

@@ -3,35 +3,35 @@ import { PlainExtension } from "@prosekit/core";
 //#region src/drop-cursor/drop-cursor.d.ts
 interface DropCursorOptions {
   /**
-  * The color of the cursor.  Use `false` to apply no color and rely only on class.
-  *
-  * @default 'black'
-  */
+   * The color of the cursor.  Use `false` to apply no color and rely only on class.
+   *
+   * @default 'black'
+   */
   color?: string | false;
   /**
-  * The precise width of the cursor in pixels.
-  *
-  * @default 1
-  */
+   * The precise width of the cursor in pixels.
+   *
+   * @default 1
+   */
   width?: number;
   /**
-  * A CSS class name to add to the cursor element.
-  */
+   * A CSS class name to add to the cursor element.
+   */
   class?: string;
 }
 /**
-* @internal
-*/
+ * @internal
+ */
 type DropCursorExtension = PlainExtension;
 /**
-* Show up a decoration at the drop position when something is dragged over the editor.
-*
-* See [prosemirror-dropcursor](https://github.com/ProseMirror/prosemirror-dropcursor) for more information.
-*
-* You probably want to use `<DropIndicator />` component instead of this extension.
-*
-* @public
-*/
+ * Show up a decoration at the drop position when something is dragged over the editor.
+ *
+ * See [prosemirror-dropcursor](https://github.com/ProseMirror/prosemirror-dropcursor) for more information.
+ *
+ * You probably want to use `<DropIndicator />` component instead of this extension.
+ *
+ * @public
+ */
 declare function defineDropCursor(options?: DropCursorOptions): DropCursorExtension;
 //#endregion
 export { type DropCursorExtension, type DropCursorOptions, defineDropCursor };

package/dist/prosekit-extensions-drop-indicator.d.ts

@@ -6,78 +6,78 @@ import { Slice } from "@prosekit/pm/model";
 //#region src/drop-indicator/types.d.ts
 
 /**
-* A function that will be called when the `dragover` event is fired. You can
-* return `false` to disable the current drop point and thus hide the drop
-* indicator.
-*
-* @public
-*/
+ * A function that will be called when the `dragover` event is fired. You can
+ * return `false` to disable the current drop point and thus hide the drop
+ * indicator.
+ *
+ * @public
+ */
 type DragEventHandler = (options: DragEventHandlerOptions) => boolean;
 /**
-* Options for {@link DragEventHandler}.
-*
-* @public
-*/
+ * Options for {@link DragEventHandler}.
+ *
+ * @public
+ */
 interface DragEventHandlerOptions {
   /**
-  * The editor's view.
-  */
+   * The editor's view.
+   */
   view: EditorView;
   /**
-  * The drop position in current document.
-  */
+   * The drop position in current document.
+   */
   pos: number;
   /**
-  * The `dragover` event.
-  */
+   * The `dragover` event.
+   */
   event: DragEvent;
 }
 /**
-* A function that will be called when the drop indicator should be shown.
-*
-* @public
-*/
+ * A function that will be called when the drop indicator should be shown.
+ *
+ * @public
+ */
 type ShowHandler = (options: ShowHandlerOptions) => void;
 /**
-* Options for {@link ShowHandler}.
-*
-* @public
-*/
+ * Options for {@link ShowHandler}.
+ *
+ * @public
+ */
 interface ShowHandlerOptions {
   /**
-  * The editor's view.
-  */
+   * The editor's view.
+   */
   view: EditorView;
   /**
-  * The ProseMirror position that the drop indicator should be shown at.
-  */
+   * The ProseMirror position that the drop indicator should be shown at.
+   */
   pos: number;
   /**
-  * The line that the drop indicator should be shown at.
-  */
+   * The line that the drop indicator should be shown at.
+   */
   line: Line;
 }
 /**
-* @internal
-*/
+ * @internal
+ */
 interface Point {
   readonly x: number;
   readonly y: number;
 }
 /**
-* @internal
-*/
+ * @internal
+ */
 interface Line {
   readonly p1: Point;
   readonly p2: Point;
 }
 /**
-* An interface matching the internal ProseMirror implementation.
-*
-* See https://github.com/ProseMirror/prosemirror-view/blob/1.38.1/src/input.ts#L657
-*
-* @internal
-*/
+ * An interface matching the internal ProseMirror implementation.
+ *
+ * See https://github.com/ProseMirror/prosemirror-view/blob/1.38.1/src/input.ts#L657
+ *
+ * @internal
+ */
 interface ViewDragging {
   readonly slice: Slice;
   readonly move: boolean;
@@ -86,49 +86,49 @@ interface ViewDragging {
 //#endregion
 //#region src/drop-indicator/drop-indicator-facet.d.ts
 /**
-* @internal
-*/
+ * @internal
+ */
 interface DropIndicatorPayload {
   /**
-  * A callback that is called when the drop indicator should be shown.
-  */
+   * A callback that is called when the drop indicator should be shown.
+   */
   onShow?: ShowHandler;
   /**
-  * A callback that is called when the drop indicator should be hidden.
-  */
+   * A callback that is called when the drop indicator should be hidden.
+   */
   onHide?: VoidFunction;
   /**
-  * A callback that is called when the `dragover` event is fired. You can
-  * return `false` to disable the current drop point and thus hide the drop
-  * indicator.
-  */
+   * A callback that is called when the `dragover` event is fired. You can
+   * return `false` to disable the current drop point and thus hide the drop
+   * indicator.
+   */
   onDrag?: DragEventHandler;
 }
 //#endregion
 //#region src/drop-indicator/drop-indicator.d.ts
 /**
-* @internal
-*/
+ * @internal
+ */
 type DropIndicatorExtension = PlainExtension;
 /**
-* Defines an extension that controls the behavior of the drop indicator.
-*
-* This extension itself doesn't draw the drop indicator, but it provides the
-* necessary callbacks to do so. You probably don't want to use this extension
-* directly, but rather use the `<DropIndicator>` component.
-*
-* You can add this extension multiple times. If any extension has `onDrag`
-* callback defined, and it returns `false`, then the drop point will be
-* discarded.
-*
-* @public
-*/
+ * Defines an extension that controls the behavior of the drop indicator.
+ *
+ * This extension itself doesn't draw the drop indicator, but it provides the
+ * necessary callbacks to do so. You probably don't want to use this extension
+ * directly, but rather use the `<DropIndicator>` component.
+ *
+ * You can add this extension multiple times. If any extension has `onDrag`
+ * callback defined, and it returns `false`, then the drop point will be
+ * discarded.
+ *
+ * @public
+ */
 declare function defineDropIndicator(options?: DropIndicatorOptions): DropIndicatorExtension;
 /**
-* Options for {@link defineDropIndicator}.
-*
-* @public
-*/
+ * Options for {@link defineDropIndicator}.
+ *
+ * @public
+ */
 interface DropIndicatorOptions extends DropIndicatorPayload {}
 //#endregion
 export { type DragEventHandler, type DragEventHandlerOptions, type DropIndicatorExtension, type DropIndicatorOptions, type Line, type Point, type ShowHandler, type ShowHandlerOptions, type ViewDragging, defineDropIndicator };

package/dist/prosekit-extensions-drop-indicator.js

@@ -1,3 +1,3 @@
-import { defineDropIndicator } from "./drop-indicator-QKkPzJIx.js";
+import { defineDropIndicator } from "./drop-indicator-B8P652g2.js";
 
 export { defineDropIndicator };

package/dist/prosekit-extensions-enter-rule.d.ts

@@ -5,102 +5,102 @@ import { Attrs, NodeType } from "@prosekit/pm/model";
 //#region src/enter-rule/index.d.ts
 
 /**
-* @public
-*
-* Options for {@link EnterRuleHandler}.
-*/
+ * @public
+ *
+ * Options for {@link EnterRuleHandler}.
+ */
 interface EnterRuleHandlerOptions {
   /**
-  * The current editor state.
-  */
+   * The current editor state.
+   */
   state: EditorState;
   /**
-  * The start position of the matched text.
-  */
+   * The start position of the matched text.
+   */
   from: number;
   /**
-  * The end position of the matched text.
-  */
+   * The end position of the matched text.
+   */
   to: number;
   /**
-  * The matched result from the regular expression.
-  */
+   * The matched result from the regular expression.
+   */
   match: RegExpExecArray;
 }
 /**
-* @public
-*/
+ * @public
+ */
 type EnterRuleHandler = (options: EnterRuleHandlerOptions) => Transaction | null;
 /**
-* Options for {@link defineEnterRule}.
-*
-* @public
-*/
+ * Options for {@link defineEnterRule}.
+ *
+ * @public
+ */
 type EnterRuleOptions = {
   /**
-  * The regular expression to match against. It should end with `$`.
-  */
+   * The regular expression to match against. It should end with `$`.
+   */
   regex: RegExp;
   /**
-  * A function to be called when an enter rule is triggered.
-  */
+   * A function to be called when an enter rule is triggered.
+   */
   handler: EnterRuleHandler;
   /**
-  * Whether to stop further handlers from being called if this rule is triggered.
-  *
-  * @default false
-  */
+   * Whether to stop further handlers from being called if this rule is triggered.
+   *
+   * @default false
+   */
   stop?: boolean;
 };
 /**
-* Options for {@link defineTextBlockEnterRule}.
-*
-* @public
-*/
+ * Options for {@link defineTextBlockEnterRule}.
+ *
+ * @public
+ */
 interface TextBlockEnterRuleOptions {
   /**
-  * The regular expression to match against. It should end with `$`.
-  */
+   * The regular expression to match against. It should end with `$`.
+   */
   regex: RegExp;
   /**
-  * The node type to replace the matched text with.
-  */
+   * The node type to replace the matched text with.
+   */
   type: string | NodeType;
   /**
-  * Attributes to set on the node. If a function is provided, it will be called
-  * with the matched result from the regular expression.
-  */
+   * Attributes to set on the node. If a function is provided, it will be called
+   * with the matched result from the regular expression.
+   */
   attrs?: Attrs | null | ((match: RegExpMatchArray) => Attrs | null);
   /**
-  * Whether to stop further handlers from being called if this rule is triggered.
-  *
-  * @default true
-  */
+   * Whether to stop further handlers from being called if this rule is triggered.
+   *
+   * @default true
+   */
   stop?: boolean;
 }
 /**
-* Defines an enter rule. An enter rule applies when the text directly in front of
-* the cursor matches `regex` and user presses Enter. The `regex` should end
-* with `$`.
-*
-* @param options
-*
-* @public
-*/
+ * Defines an enter rule. An enter rule applies when the text directly in front of
+ * the cursor matches `regex` and user presses Enter. The `regex` should end
+ * with `$`.
+ *
+ * @param options
+ *
+ * @public
+ */
 declare function defineEnterRule({
   regex,
   handler,
   stop
 }: EnterRuleOptions): PlainExtension;
 /**
-* Defines an enter rule that replaces the matched text with a block node.
-*
-* See also {@link defineEnterRule}.
-*
-* @param options
-*
-* @public
-*/
+ * Defines an enter rule that replaces the matched text with a block node.
+ *
+ * See also {@link defineEnterRule}.
+ *
+ * @param options
+ *
+ * @public
+ */
 declare function defineTextBlockEnterRule({
   regex,
   type,

package/dist/prosekit-extensions-file.d.ts

@@ -4,103 +4,103 @@ import { EditorView } from "@prosekit/pm/view";
 //#region src/file/file-drop-handler.d.ts
 interface FileDropHandlerOptions {
   /**
-  * The editor view.
-  */
+   * The editor view.
+   */
   view: EditorView;
   /**
-  * The event that triggered the drop.
-  */
+   * The event that triggered the drop.
+   */
   event: DragEvent;
   /**
-  * The file that was dropped.
-  */
+   * The file that was dropped.
+   */
   file: File;
   /**
-  * The position of the document where the file was dropped.
-  */
+   * The position of the document where the file was dropped.
+   */
   pos: number;
 }
 /**
-* A function that handles one of the files in a drop event.
-*
-* Returns `true` if the file was handled and thus should not be handled by
-* other handlers.
-*/
+ * A function that handles one of the files in a drop event.
+ *
+ * Returns `true` if the file was handled and thus should not be handled by
+ * other handlers.
+ */
 type FileDropHandler = (options: FileDropHandlerOptions) => boolean | void;
 declare function defineFileDropHandler(handler: FileDropHandler): PlainExtension;
 //#endregion
 //#region src/file/file-paste-handler.d.ts
 interface FilePasteHandlerOptions {
   /**
-  * The editor view.
-  */
+   * The editor view.
+   */
   view: EditorView;
   /**
-  * The event that triggered the paste.
-  */
+   * The event that triggered the paste.
+   */
   event: ClipboardEvent;
   /**
-  * The file that was pasted.
-  */
+   * The file that was pasted.
+   */
   file: File;
 }
 /**
-* A function that handles one of the files in a paste event.
-*
-* Returns `true` if the file was handled and thus should not be handled by
-* other handlers.
-*/
+ * A function that handles one of the files in a paste event.
+ *
+ * Returns `true` if the file was handled and thus should not be handled by
+ * other handlers.
+ */
 type FilePasteHandler = (options: FilePasteHandlerOptions) => boolean | void;
 declare function defineFilePasteHandler(handler: FilePasteHandler): PlainExtension;
 //#endregion
 //#region src/file/file-upload.d.ts
 /**
-* An interface representing the upload progress.
-*/
+ * An interface representing the upload progress.
+ */
 interface UploadProgress {
   loaded: number;
   total: number;
 }
 interface UploaderOptions {
   /**
-  * The file to be uploaded.
-  */
+   * The file to be uploaded.
+   */
   file: File;
   /**
-  * A callback function that should be called with the upload progress updates.
-  */
+   * A callback function that should be called with the upload progress updates.
+   */
   onProgress: (progress: UploadProgress) => void;
 }
 /**
-* The implementation of the actual upload function. You need to implement this
-* function to upload files to your desired destination.
-*/
+ * The implementation of the actual upload function. You need to implement this
+ * function to upload files to your desired destination.
+ */
 type Uploader<Result> = (options: UploaderOptions) => Promise<Result>;
 /**
-* A class that represents a upload task.
-*/
+ * A class that represents a upload task.
+ */
 declare class UploadTask<Result> {
   /**
-  * An [object URL](https://developer.mozilla.org/en-US/docs/Web/API/URL/createObjectURL)
-  * representing the file to be uploaded. This URL will be revoked once the
-  * upload is complete successfully.
-  */
+   * An [object URL](https://developer.mozilla.org/en-US/docs/Web/API/URL/createObjectURL)
+   * representing the file to be uploaded. This URL will be revoked once the
+   * upload is complete successfully.
+   */
   readonly objectURL: string;
   /**
-  * A boolean indicating whether the upload is complete (either successfully or with an error).
-  */
+   * A boolean indicating whether the upload is complete (either successfully or with an error).
+   */
   protected done: boolean;
   /**
-  * A promise that fulfills once the upload is complete, or rejects if an error occurs.
-  */
+   * A promise that fulfills once the upload is complete, or rejects if an error occurs.
+   */
   readonly finished: Promise<Result>;
   private subscribers;
   /**
-  * Creates a new upload task. You can find the upload task by its object URL
-  * later using `UploadTask.get()`.
-  *
-  * @param options - The options for the upload task.
-  */
+   * Creates a new upload task. You can find the upload task by its object URL
+   * later using `UploadTask.get()`.
+   *
+   * @param options - The options for the upload task.
+   */
   constructor({
     file,
     uploader
@@ -109,16 +109,16 @@ declare class UploadTask<Result> {
     uploader: Uploader<Result>;
   });
   /**
-  * Subscribes to progress updates. Returns a function to unsubscribe.
-  */
+   * Subscribes to progress updates. Returns a function to unsubscribe.
+   */
   subscribeProgress(callback: (progress: UploadProgress) => void): VoidFunction;
   /**
-  * Finds an upload task by its object URL.
-  */
+   * Finds an upload task by its object URL.
+   */
   static get<Result = unknown>(objectURL: string): UploadTask<Result> | undefined;
   /**
-  * Deletes an upload task by its object URL.
-  */
+   * Deletes an upload task by its object URL.
+   */
   static delete(objectURL: string): void;
 }
 //#endregion

package/dist/prosekit-extensions-gap-cursor.d.ts

@@ -4,23 +4,23 @@ import "prosemirror-gapcursor";
 //#region src/gap-cursor/gap-cursor.d.ts
 
 /**
-* @internal
-*/
+ * @internal
+ */
 type GapCursorExtension = PlainExtension;
 /**
-* Capture clicks near and arrow-key-motion past places that don't have a
-* normally selectable position nearby, and create a gap cursor selection for
-* them. The cursor is drawn as an element with class `ProseMirror-gapcursor`.
-*
-* You can either include `prosekit/extensions/gap-cursor.css` or add your own
-* styles to make it visible.
-*
-* See
-* [prosemirror-gapcursor](https://github.com/ProseMirror/prosemirror-gapcursor)
-* for more information.
-*
-* @public
-*/
+ * Capture clicks near and arrow-key-motion past places that don't have a
+ * normally selectable position nearby, and create a gap cursor selection for
+ * them. The cursor is drawn as an element with class `ProseMirror-gapcursor`.
+ *
+ * You can either include `prosekit/extensions/gap-cursor.css` or add your own
+ * styles to make it visible.
+ *
+ * See
+ * [prosemirror-gapcursor](https://github.com/ProseMirror/prosemirror-gapcursor)
+ * for more information.
+ *
+ * @public
+ */
 declare function defineGapCursor(): GapCursorExtension;
 //#endregion
 export { type GapCursorExtension, defineGapCursor };