47 lines
1.2 KiB
TypeScript
47 lines
1.2 KiB
TypeScript
import { Mark } from '@tiptap/core';
|
|
|
|
interface StrikeOptions {
|
|
/**
|
|
* HTML attributes to add to the strike element.
|
|
* @default {}
|
|
* @example { class: 'foo' }
|
|
*/
|
|
HTMLAttributes: Record<string, any>;
|
|
}
|
|
declare module '@tiptap/core' {
|
|
interface Commands<ReturnType> {
|
|
strike: {
|
|
/**
|
|
* Set a strike mark
|
|
* @example editor.commands.setStrike()
|
|
*/
|
|
setStrike: () => ReturnType;
|
|
/**
|
|
* Toggle a strike mark
|
|
* @example editor.commands.toggleStrike()
|
|
*/
|
|
toggleStrike: () => ReturnType;
|
|
/**
|
|
* Unset a strike mark
|
|
* @example editor.commands.unsetStrike()
|
|
*/
|
|
unsetStrike: () => ReturnType;
|
|
};
|
|
}
|
|
}
|
|
/**
|
|
* Matches a strike to a ~~strike~~ on input.
|
|
*/
|
|
declare const inputRegex: RegExp;
|
|
/**
|
|
* Matches a strike to a ~~strike~~ on paste.
|
|
*/
|
|
declare const pasteRegex: RegExp;
|
|
/**
|
|
* This extension allows you to create strike text.
|
|
* @see https://www.tiptap.dev/api/marks/strike
|
|
*/
|
|
declare const Strike: Mark<StrikeOptions, any>;
|
|
|
|
export { Strike, type StrikeOptions, Strike as default, inputRegex, pasteRegex };
|