@tiptap/extension-link 3.30.2 → 3.30.3

package/dist/index.d.ts

@@ -1,19 +1,19 @@
-import { Mark } from '@tiptap/core';
-
+import { Mark } from "@tiptap/core";
+//#region src/link.d.ts
 interface LinkProtocolOptions {
-    /**
-     * The protocol scheme to be registered.
-     * @default '''
-     * @example 'ftp'
-     * @example 'git'
-     */
-    scheme: string;
-    /**
-     * If enabled, it allows optional slashes after the protocol.
-     * @default false
-     * @example true
-     */
-    optionalSlashes?: boolean;
+  /**
+   * The protocol scheme to be registered.
+   * @default '''
+   * @example 'ftp'
+   * @example 'git'
+   */
+  scheme: string;
+  /**
+   * If enabled, it allows optional slashes after the protocol.
+   * @default false
+   * @example true
+   */
+  optionalSlashes?: boolean;
 }
 declare const pasteRegex: RegExp;
 /**
@@ -21,132 +21,132 @@ declare const pasteRegex: RegExp;
  */
 type DeprecatedOpenWhenNotEditable = 'whenNotEditable';
 interface LinkOptions {
+  /**
+   * If enabled, the extension will automatically add links as you type.
+   * @default true
+   * @example false
+   */
+  autolink: boolean;
+  /**
+   * An array of custom protocols to be registered with linkifyjs.
+   * @default []
+   * @example ['ftp', 'git']
+   */
+  protocols: Array<LinkProtocolOptions | string>;
+  /**
+   * Default protocol to use when no protocol is specified.
+   * @default 'http'
+   */
+  defaultProtocol: string;
+  /**
+   * If enabled, links will be opened on click.
+   * @default true
+   * @example false
+   */
+  openOnClick: boolean | DeprecatedOpenWhenNotEditable;
+  /**
+   * If enabled, the link will be selected when clicked.
+   * @default false
+   * @example true
+   */
+  enableClickSelection: boolean;
+  /**
+   * Adds a link to the current selection if the pasted content only contains an url.
+   * @default true
+   * @example false
+   */
+  linkOnPaste: boolean;
+  /**
+   * If enabled, typing or pasting the Markdown link syntax, e.g. `[Tiptap](https://tiptap.dev)`
+   * or `[Tiptap](https://tiptap.dev "Rich text editor")`, converts it into a link.
+   * @default false
+   * @example true
+   */
+  markdownLinks: boolean;
+  /**
+   * HTML attributes to add to the link element.
+   * @default {}
+   * @example { class: 'foo' }
+   */
+  HTMLAttributes: Record<string, any>;
+  /**
+   * @deprecated Use the `shouldAutoLink` option instead.
+   * A validation function that modifies link verification for the auto linker.
+   * @param url - The url to be validated.
+   * @returns - True if the url is valid, false otherwise.
+   */
+  validate: (url: string) => boolean;
+  /**
+   * A validation function which is used for configuring link verification for preventing XSS attacks.
+   * Only modify this if you know what you're doing.
+   *
+   * @returns {boolean} `true` if the URL is valid, `false` otherwise.
+   *
+   * @example
+   * isAllowedUri: (url, { defaultValidate, protocols, defaultProtocol }) => {
+   * return url.startsWith('./') || defaultValidate(url)
+   * }
+   */
+  isAllowedUri: (
+  /**
+   * The URL to be validated.
+   */
+  url: string, ctx: {
     /**
-     * If enabled, the extension will automatically add links as you type.
-     * @default true
-     * @example false
+     * The default validation function.
      */
-    autolink: boolean;
+    defaultValidate: (url: string) => boolean;
     /**
-     * An array of custom protocols to be registered with linkifyjs.
-     * @default []
-     * @example ['ftp', 'git']
+     * An array of allowed protocols for the URL (e.g., "http", "https"). As defined in the `protocols` option.
      */
     protocols: Array<LinkProtocolOptions | string>;
     /**
-     * Default protocol to use when no protocol is specified.
-     * @default 'http'
+     * A string that represents the default protocol (e.g., 'http'). As defined in the `defaultProtocol` option.
      */
     defaultProtocol: string;
-    /**
-     * If enabled, links will be opened on click.
-     * @default true
-     * @example false
-     */
-    openOnClick: boolean | DeprecatedOpenWhenNotEditable;
-    /**
-     * If enabled, the link will be selected when clicked.
-     * @default false
-     * @example true
-     */
-    enableClickSelection: boolean;
-    /**
-     * Adds a link to the current selection if the pasted content only contains an url.
-     * @default true
-     * @example false
-     */
-    linkOnPaste: boolean;
-    /**
-     * If enabled, typing or pasting the Markdown link syntax, e.g. `[Tiptap](https://tiptap.dev)`
-     * or `[Tiptap](https://tiptap.dev "Rich text editor")`, converts it into a link.
-     * @default false
-     * @example true
-     */
-    markdownLinks: boolean;
-    /**
-     * HTML attributes to add to the link element.
-     * @default {}
-     * @example { class: 'foo' }
-     */
-    HTMLAttributes: Record<string, any>;
-    /**
-     * @deprecated Use the `shouldAutoLink` option instead.
-     * A validation function that modifies link verification for the auto linker.
-     * @param url - The url to be validated.
-     * @returns - True if the url is valid, false otherwise.
-     */
-    validate: (url: string) => boolean;
-    /**
-     * A validation function which is used for configuring link verification for preventing XSS attacks.
-     * Only modify this if you know what you're doing.
-     *
-     * @returns {boolean} `true` if the URL is valid, `false` otherwise.
-     *
-     * @example
-     * isAllowedUri: (url, { defaultValidate, protocols, defaultProtocol }) => {
-     * return url.startsWith('./') || defaultValidate(url)
-     * }
-     */
-    isAllowedUri: (
-    /**
-     * The URL to be validated.
-     */
-    url: string, ctx: {
-        /**
-         * The default validation function.
-         */
-        defaultValidate: (url: string) => boolean;
-        /**
-         * An array of allowed protocols for the URL (e.g., "http", "https"). As defined in the `protocols` option.
-         */
-        protocols: Array<LinkProtocolOptions | string>;
-        /**
-         * A string that represents the default protocol (e.g., 'http'). As defined in the `defaultProtocol` option.
-         */
-        defaultProtocol: string;
-    }) => boolean;
-    /**
-     * Determines whether a valid link should be automatically linked in the content.
-     *
-     * @param {string} url - The URL that has already been validated.
-     * @returns {boolean} - True if the link should be auto-linked; false if it should not be auto-linked.
-     */
-    shouldAutoLink: (url: string) => boolean;
+  }) => boolean;
+  /**
+   * Determines whether a valid link should be automatically linked in the content.
+   *
+   * @param {string} url - The URL that has already been validated.
+   * @returns {boolean} - True if the link should be auto-linked; false if it should not be auto-linked.
+   */
+  shouldAutoLink: (url: string) => boolean;
 }
 declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        link: {
-            /**
-             * Set a link mark
-             * @param attributes The link attributes
-             * @example editor.commands.setLink({ href: 'https://tiptap.dev' })
-             */
-            setLink: (attributes: {
-                href: string;
-                target?: string | null;
-                rel?: string | null;
-                class?: string | null;
-                title?: string | null;
-            }) => ReturnType;
-            /**
-             * Toggle a link mark
-             * @param attributes The link attributes
-             * @example editor.commands.toggleLink({ href: 'https://tiptap.dev' })
-             */
-            toggleLink: (attributes?: {
-                href: string;
-                target?: string | null;
-                rel?: string | null;
-                class?: string | null;
-                title?: string | null;
-            }) => ReturnType;
-            /**
-             * Unset a link mark
-             * @example editor.commands.unsetLink()
-             */
-            unsetLink: () => ReturnType;
-        };
-    }
+  interface Commands<ReturnType> {
+    link: {
+      /**
+       * Set a link mark
+       * @param attributes The link attributes
+       * @example editor.commands.setLink({ href: 'https://tiptap.dev' })
+       */
+      setLink: (attributes: {
+        href: string;
+        target?: string | null;
+        rel?: string | null;
+        class?: string | null;
+        title?: string | null;
+      }) => ReturnType;
+      /**
+       * Toggle a link mark
+       * @param attributes The link attributes
+       * @example editor.commands.toggleLink({ href: 'https://tiptap.dev' })
+       */
+      toggleLink: (attributes?: {
+        href: string;
+        target?: string | null;
+        rel?: string | null;
+        class?: string | null;
+        title?: string | null;
+      }) => ReturnType;
+      /**
+       * Unset a link mark
+       * @example editor.commands.unsetLink()
+       */
+      unsetLink: () => ReturnType;
+    };
+  }
 }
 declare function isAllowedUri(uri: string | undefined, protocols?: LinkOptions['protocols']): true | RegExpMatchArray | null;
 /**
@@ -154,5 +154,6 @@ declare function isAllowedUri(uri: string | undefined, protocols?: LinkOptions['
  * @see https://www.tiptap.dev/api/marks/link
  */
 declare const Link: Mark<LinkOptions, any>;
-
-export { Link, type LinkOptions, type LinkProtocolOptions, Link as default, isAllowedUri, pasteRegex };
+//#endregion
+export { Link, Link as default, LinkOptions, LinkProtocolOptions, isAllowedUri, pasteRegex };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/link.ts"],"mappings":";;UAWiB;;;;;;;EAOf;;;;;;EAOA;;cAGW,YAAU;;;;KAMlB;UAEY;;;;;;EAMf;;;;;;EAOA,WAAW,MAAM;;;;;EAMjB;;;;;;EAMA,uBAAuB;;;;;;EAMvB;;;;;;EAMA;;;;;;;EAQA;;;;;;EAOA,gBAAgB;;;;;;;EAQhB,WAAW;;;;;;;;;;;;EAaX,eAIE;;;;EAAA,aACA;;;;IAIE,kBAAkB;;;;IAIlB,WAAW,MAAM;;;;IAIjB;;;;;;;;EAUJ,iBAAiB;;;YAIP,SAAS;IACjB;;;;;;MAME,UAAU;QACR;QACA;QACA;QACA;QACA;YACI;;;;;;MAMN,aAAa;QACX;QACA;QACA;QACA;QACA;YACI;;;;;MAKN,iBAAiB;;;;iBAKP,aAAa,yBAAyB,YAAY,kCAAwB;;;;;cA2C7E,MAAI,KAAA"}