@tiptap/core 2.3.2 → 2.5.0-beta.0

package/dist/packages/core/src/EventEmitter.d.ts

@@ -4,8 +4,8 @@ declare type CallbackFunction<T extends Record<string, any>, EventName extends S
 export declare class EventEmitter<T extends Record<string, any>> {
     private callbacks;
     on<EventName extends StringKeyOf<T>>(event: EventName, fn: CallbackFunction<T, EventName>): this;
-    protected emit<EventName extends StringKeyOf<T>>(event: EventName, ...args: CallbackType<T, EventName>): this;
+    emit<EventName extends StringKeyOf<T>>(event: EventName, ...args: CallbackType<T, EventName>): this;
     off<EventName extends StringKeyOf<T>>(event: EventName, fn?: CallbackFunction<T, EventName>): this;
-    protected removeAllListeners(): void;
+    removeAllListeners(): void;
 }
 export {};

package/dist/packages/core/src/Extension.d.ts

@@ -10,26 +10,50 @@ declare module '@tiptap/core' {
     interface ExtensionConfig<Options = any, Storage = any> {
         [key: string]: any;
         /**
-         * Name
+         * The extension name - this must be unique.
+         * It will be used to identify the extension.
+         *
+         * @example 'myExtension'
          */
         name: string;
         /**
-         * Priority
+         * The priority of your extension. The higher, the later it will be called
+         * and will take precedence over other extensions with a lower priority.
+         * @default 1000
+         * @example 1001
          */
         priority?: number;
         /**
-         * Default options
+         * The default options for this extension.
+         * @example
+         * defaultOptions: {
+         *   myOption: 'foo',
+         *   myOtherOption: 10,
+         * }
          */
         defaultOptions?: Options;
         /**
-         * Default Options
+         * This method will add options to this extension
+         * @see https://tiptap.dev/guide/custom-extensions#settings
+         * @example
+         * addOptions() {
+         *  return {
+         *    myOption: 'foo',
+         *    myOtherOption: 10,
+         * }
          */
         addOptions?: (this: {
             name: string;
             parent: Exclude<ParentConfig<ExtensionConfig<Options, Storage>>['addOptions'], undefined>;
         }) => Options;
         /**
-         * Default Storage
+         * The default storage this extension can save data to.
+         * @see https://tiptap.dev/guide/custom-extensions#storage
+         * @example
+         * defaultStorage: {
+         *   prefetchedUsers: [],
+         *   loading: false,
+         * }
          */
         addStorage?: (this: {
             name: string;
@@ -37,7 +61,30 @@ declare module '@tiptap/core' {
             parent: Exclude<ParentConfig<ExtensionConfig<Options, Storage>>['addStorage'], undefined>;
         }) => Storage;
         /**
-         * Global attributes
+         * This function adds globalAttributes to specific nodes.
+         * @see https://tiptap.dev/guide/custom-extensions#global-attributes
+         * @example
+         * addGlobalAttributes() {
+         *   return [
+         *     {
+                 // Extend the following extensions
+         *       types: [
+         *         'heading',
+         *         'paragraph',
+         *       ],
+         *       // … with those attributes
+         *       attributes: {
+         *         textAlign: {
+         *           default: 'left',
+         *           renderHTML: attributes => ({
+         *             style: `text-align: ${attributes.textAlign}`,
+         *           }),
+         *           parseHTML: element => element.style.textAlign || 'left',
+         *         },
+         *       },
+         *     },
+         *   ]
+         * }
          */
         addGlobalAttributes?: (this: {
             name: string;
@@ -46,7 +93,14 @@ declare module '@tiptap/core' {
             parent: ParentConfig<ExtensionConfig<Options, Storage>>['addGlobalAttributes'];
         }) => GlobalAttributes | {};
         /**
-         * Raw
+         * This function adds commands to the editor
+         * @see https://tiptap.dev/guide/custom-extensions#keyboard-shortcuts
+         * @example
+         * addCommands() {
+         *   return {
+         *     myCommand: () => ({ chain }) => chain().setMark('type', 'foo').run(),
+         *   }
+         * }
          */
         addCommands?: (this: {
             name: string;
@@ -56,7 +110,14 @@ declare module '@tiptap/core' {
             parent: ParentConfig<ExtensionConfig<Options, Storage>>['addCommands'];
         }) => Partial<RawCommands>;
         /**
-         * Keyboard shortcuts
+         * This function registers keyboard shortcuts.
+         * @see https://tiptap.dev/guide/custom-extensions#keyboard-shortcuts
+         * @example
+         * addKeyboardShortcuts() {
+         *   return {
+         *     'Mod-l': () => this.editor.commands.toggleBulletList(),
+         *   }
+         * },
          */
         addKeyboardShortcuts?: (this: {
             name: string;
@@ -68,7 +129,17 @@ declare module '@tiptap/core' {
             [key: string]: KeyboardShortcutCommand;
         };
         /**
-         * Input rules
+         * This function adds input rules to the editor.
+         * @see https://tiptap.dev/guide/custom-extensions#input-rules
+         * @example
+         * addInputRules() {
+         *   return [
+         *     markInputRule({
+         *       find: inputRegex,
+         *       type: this.type,
+         *     }),
+         *   ]
+         * },
          */
         addInputRules?: (this: {
             name: string;
@@ -78,7 +149,17 @@ declare module '@tiptap/core' {
             parent: ParentConfig<ExtensionConfig<Options, Storage>>['addInputRules'];
         }) => InputRule[];
         /**
-         * Paste rules
+         * This function adds paste rules to the editor.
+         * @see https://tiptap.dev/guide/custom-extensions#paste-rules
+         * @example
+         * addPasteRules() {
+         *   return [
+         *     markPasteRule({
+         *       find: pasteRegex,
+         *       type: this.type,
+         *     }),
+         *   ]
+         * },
          */
         addPasteRules?: (this: {
             name: string;
@@ -88,7 +169,14 @@ declare module '@tiptap/core' {
             parent: ParentConfig<ExtensionConfig<Options, Storage>>['addPasteRules'];
         }) => PasteRule[];
         /**
-         * ProseMirror plugins
+         * This function adds Prosemirror plugins to the editor
+         * @see https://tiptap.dev/guide/custom-extensions#prosemirror-plugins
+         * @example
+         * addProseMirrorPlugins() {
+         *   return [
+         *     customPlugin(),
+         *   ]
+         * }
          */
         addProseMirrorPlugins?: (this: {
             name: string;
@@ -98,7 +186,16 @@ declare module '@tiptap/core' {
             parent: ParentConfig<ExtensionConfig<Options, Storage>>['addProseMirrorPlugins'];
         }) => Plugin[];
         /**
-         * Extensions
+         * This function adds additional extensions to the editor. This is useful for
+         * building extension kits.
+         * @example
+         * addExtensions() {
+         *   return [
+         *     BulletList,
+         *     OrderedList,
+         *     ListItem
+         *   ]
+         * }
          */
         addExtensions?: (this: {
             name: string;
@@ -107,7 +204,14 @@ declare module '@tiptap/core' {
             parent: ParentConfig<ExtensionConfig<Options, Storage>>['addExtensions'];
         }) => Extensions;
         /**
-         * Extend Node Schema
+         * This function extends the schema of the node.
+         * @example
+         * extendNodeSchema() {
+         *   return {
+         *     group: 'inline',
+         *     selectable: false,
+         *   }
+         * }
          */
         extendNodeSchema?: ((this: {
             name: string;
@@ -116,7 +220,14 @@ declare module '@tiptap/core' {
             parent: ParentConfig<ExtensionConfig<Options, Storage>>['extendNodeSchema'];
         }, extension: Node) => Record<string, any>) | null;
         /**
-         * Extend Mark Schema
+         * This function extends the schema of the mark.
+         * @example
+         * extendMarkSchema() {
+         *   return {
+         *     group: 'inline',
+         *     selectable: false,
+         *   }
+         * }
          */
         extendMarkSchema?: ((this: {
             name: string;
@@ -212,6 +323,10 @@ declare module '@tiptap/core' {
         }) => void) | null;
     }
 }
+/**
+ * The Extension class is the base class for all extensions.
+ * @see https://tiptap.dev/api/extensions#create-a-new-extension
+ */
 export declare class Extension<Options = any, Storage = any> {
     type: string;
     name: string;

package/dist/packages/core/src/ExtensionManager.d.ts

@@ -8,11 +8,48 @@ export declare class ExtensionManager {
     extensions: Extensions;
     splittableMarks: string[];
     constructor(extensions: Extensions, editor: Editor);
+    /**
+     * Returns a flattened and sorted extension list while
+     * also checking for duplicated extensions and warns the user.
+     * @param extensions An array of Tiptap extensions
+     * @returns An flattened and sorted array of Tiptap extensions
+     */
     static resolve(extensions: Extensions): Extensions;
+    /**
+     * Create a flattened array of extensions by traversing the `addExtensions` field.
+     * @param extensions An array of Tiptap extensions
+     * @returns A flattened array of Tiptap extensions
+     */
     static flatten(extensions: Extensions): Extensions;
+    /**
+     * Sort extensions by priority.
+     * @param extensions An array of Tiptap extensions
+     * @returns A sorted array of Tiptap extensions by priority
+     */
     static sort(extensions: Extensions): Extensions;
+    /**
+     * Get all commands from the extensions.
+     * @returns An object with all commands where the key is the command name and the value is the command function
+     */
     get commands(): RawCommands;
+    /**
+     * Get all registered Prosemirror plugins from the extensions.
+     * @returns An array of Prosemirror plugins
+     */
     get plugins(): Plugin[];
+    /**
+     * Get all attributes from the extensions.
+     * @returns An array of attributes
+     */
     get attributes(): import("@tiptap/core").ExtensionAttribute[];
+    /**
+     * Get all node views from the extensions.
+     * @returns An object with all node views where the key is the node name and the value is the node view function
+     */
     get nodeViews(): any;
+    /**
+     * Go through all extensions, create extension storages & setup marks
+     * & bind editor event listener.
+     */
+    private setupExtensions;
 }

package/dist/packages/core/src/Mark.d.ts

@@ -10,26 +10,50 @@ declare module '@tiptap/core' {
     interface MarkConfig<Options = any, Storage = any> {
         [key: string]: any;
         /**
-         * Name
+         * The extension name - this must be unique.
+         * It will be used to identify the extension.
+         *
+         * @example 'myExtension'
          */
         name: string;
         /**
-         * Priority
+         * The priority of your extension. The higher, the later it will be called
+         * and will take precedence over other extensions with a lower priority.
+         * @default 1000
+         * @example 1001
          */
         priority?: number;
         /**
-         * Default options
+         * The default options for this extension.
+         * @example
+         * defaultOptions: {
+         *   myOption: 'foo',
+         *   myOtherOption: 10,
+         * }
          */
         defaultOptions?: Options;
         /**
-         * Default Options
+         * This method will add options to this extension
+         * @see https://tiptap.dev/guide/custom-extensions#settings
+         * @example
+         * addOptions() {
+         *  return {
+         *    myOption: 'foo',
+         *    myOtherOption: 10,
+         * }
          */
         addOptions?: (this: {
             name: string;
             parent: Exclude<ParentConfig<MarkConfig<Options, Storage>>['addOptions'], undefined>;
         }) => Options;
         /**
-         * Default Storage
+         * The default storage this extension can save data to.
+         * @see https://tiptap.dev/guide/custom-extensions#storage
+         * @example
+         * defaultStorage: {
+         *   prefetchedUsers: [],
+         *   loading: false,
+         * }
          */
         addStorage?: (this: {
             name: string;
@@ -37,7 +61,30 @@ declare module '@tiptap/core' {
             parent: Exclude<ParentConfig<MarkConfig<Options, Storage>>['addStorage'], undefined>;
         }) => Storage;
         /**
-         * Global attributes
+         * This function adds globalAttributes to specific nodes.
+         * @see https://tiptap.dev/guide/custom-extensions#global-attributes
+         * @example
+         * addGlobalAttributes() {
+         *   return [
+         *     {
+                 // Extend the following extensions
+         *       types: [
+         *         'heading',
+         *         'paragraph',
+         *       ],
+         *       // … with those attributes
+         *       attributes: {
+         *         textAlign: {
+         *           default: 'left',
+         *           renderHTML: attributes => ({
+         *             style: `text-align: ${attributes.textAlign}`,
+         *           }),
+         *           parseHTML: element => element.style.textAlign || 'left',
+         *         },
+         *       },
+         *     },
+         *   ]
+         * }
          */
         addGlobalAttributes?: (this: {
             name: string;
@@ -46,7 +93,14 @@ declare module '@tiptap/core' {
             parent: ParentConfig<MarkConfig<Options, Storage>>['addGlobalAttributes'];
         }) => GlobalAttributes | {};
         /**
-         * Raw
+         * This function adds commands to the editor
+         * @see https://tiptap.dev/guide/custom-extensions#keyboard-shortcuts
+         * @example
+         * addCommands() {
+         *   return {
+         *     myCommand: () => ({ chain }) => chain().setMark('type', 'foo').run(),
+         *   }
+         * }
          */
         addCommands?: (this: {
             name: string;
@@ -57,7 +111,14 @@ declare module '@tiptap/core' {
             parent: ParentConfig<MarkConfig<Options, Storage>>['addCommands'];
         }) => Partial<RawCommands>;
         /**
-         * Keyboard shortcuts
+         * This function registers keyboard shortcuts.
+         * @see https://tiptap.dev/guide/custom-extensions#keyboard-shortcuts
+         * @example
+         * addKeyboardShortcuts() {
+         *   return {
+         *     'Mod-l': () => this.editor.commands.toggleBulletList(),
+         *   }
+         * },
          */
         addKeyboardShortcuts?: (this: {
             name: string;
@@ -70,7 +131,17 @@ declare module '@tiptap/core' {
             [key: string]: KeyboardShortcutCommand;
         };
         /**
-         * Input rules
+         * This function adds input rules to the editor.
+         * @see https://tiptap.dev/guide/custom-extensions#input-rules
+         * @example
+         * addInputRules() {
+         *   return [
+         *     markInputRule({
+         *       find: inputRegex,
+         *       type: this.type,
+         *     }),
+         *   ]
+         * },
          */
         addInputRules?: (this: {
             name: string;
@@ -81,7 +152,17 @@ declare module '@tiptap/core' {
             parent: ParentConfig<MarkConfig<Options, Storage>>['addInputRules'];
         }) => InputRule[];
         /**
-         * Paste rules
+         * This function adds paste rules to the editor.
+         * @see https://tiptap.dev/guide/custom-extensions#paste-rules
+         * @example
+         * addPasteRules() {
+         *   return [
+         *     markPasteRule({
+         *       find: pasteRegex,
+         *       type: this.type,
+         *     }),
+         *   ]
+         * },
          */
         addPasteRules?: (this: {
             name: string;
@@ -92,7 +173,14 @@ declare module '@tiptap/core' {
             parent: ParentConfig<MarkConfig<Options, Storage>>['addPasteRules'];
         }) => PasteRule[];
         /**
-         * ProseMirror plugins
+         * This function adds Prosemirror plugins to the editor
+         * @see https://tiptap.dev/guide/custom-extensions#prosemirror-plugins
+         * @example
+         * addProseMirrorPlugins() {
+         *   return [
+         *     customPlugin(),
+         *   ]
+         * }
          */
         addProseMirrorPlugins?: (this: {
             name: string;
@@ -103,7 +191,16 @@ declare module '@tiptap/core' {
             parent: ParentConfig<MarkConfig<Options, Storage>>['addProseMirrorPlugins'];
         }) => Plugin[];
         /**
-         * Extensions
+         * This function adds additional extensions to the editor. This is useful for
+         * building extension kits.
+         * @example
+         * addExtensions() {
+         *   return [
+         *     BulletList,
+         *     OrderedList,
+         *     ListItem
+         *   ]
+         * }
          */
         addExtensions?: (this: {
             name: string;
@@ -112,7 +209,14 @@ declare module '@tiptap/core' {
             parent: ParentConfig<MarkConfig<Options, Storage>>['addExtensions'];
         }) => Extensions;
         /**
-         * Extend Node Schema
+         * This function extends the schema of the node.
+         * @example
+         * extendNodeSchema() {
+         *   return {
+         *     group: 'inline',
+         *     selectable: false,
+         *   }
+         * }
          */
         extendNodeSchema?: ((this: {
             name: string;
@@ -121,7 +225,14 @@ declare module '@tiptap/core' {
             parent: ParentConfig<MarkConfig<Options, Storage>>['extendNodeSchema'];
         }, extension: Node) => Record<string, any>) | null;
         /**
-         * Extend Mark Schema
+         * This function extends the schema of the mark.
+         * @example
+         * extendMarkSchema() {
+         *   return {
+         *     group: 'inline',
+         *     selectable: false,
+         *   }
+         * }
          */
         extendMarkSchema?: ((this: {
             name: string;
@@ -316,6 +427,10 @@ declare module '@tiptap/core' {
         }) => Attributes | {};
     }
 }
+/**
+ * The Mark class is used to create custom mark extensions.
+ * @see https://tiptap.dev/api/extensions#create-a-new-extension
+ */
 export declare class Mark<Options = any, Storage = any> {
     type: string;
     name: string;