39 lines
1.1 KiB
TypeScript
39 lines
1.1 KiB
TypeScript
import { Mark } from '@tiptap/core';
|
|
|
|
interface UnderlineOptions {
|
|
/**
|
|
* HTML attributes to add to the underline element.
|
|
* @default {}
|
|
* @example { class: 'foo' }
|
|
*/
|
|
HTMLAttributes: Record<string, any>;
|
|
}
|
|
declare module '@tiptap/core' {
|
|
interface Commands<ReturnType> {
|
|
underline: {
|
|
/**
|
|
* Set an underline mark
|
|
* @example editor.commands.setUnderline()
|
|
*/
|
|
setUnderline: () => ReturnType;
|
|
/**
|
|
* Toggle an underline mark
|
|
* @example editor.commands.toggleUnderline()
|
|
*/
|
|
toggleUnderline: () => ReturnType;
|
|
/**
|
|
* Unset an underline mark
|
|
* @example editor.commands.unsetUnderline()
|
|
*/
|
|
unsetUnderline: () => ReturnType;
|
|
};
|
|
}
|
|
}
|
|
/**
|
|
* This extension allows you to create underline text.
|
|
* @see https://www.tiptap.dev/api/marks/underline
|
|
*/
|
|
declare const Underline: Mark<UnderlineOptions, any>;
|
|
|
|
export { Underline, type UnderlineOptions, Underline as default };
|