extension-underline
package @remirror/extension-underline
class UnderlineExtension
Add underline formatting support to the editor.
Signature:
export declare class UnderlineExtension extends MarkExtension
Extends: MarkExtension
(Some inherited members may not be shown because they are not represented in the documentation.)
property name
Signature:
get name(): "underline";
method createMarkSpec
Signature:
createMarkSpec(extra: ApplySchemaAttributes, override: MarkSpecOverride): MarkExtensionSpec;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| extra | ApplySchemaAttributes | |
| override | MarkSpecOverride |
Returns:
method createTags
Signature:
createTags(): ("formattingMark" | "fontStyle")[];
Returns:
("formattingMark" | "fontStyle")[]
method shortcut
Attach the keyboard shortcut for formatting the text.
Signature:
shortcut(props: KeyBindingProps): boolean;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| props | KeyBindingProps |
Returns:
boolean
method toggleUnderline
Toggle the underline formatting of the selected text.
This command is provided by the UnderlineExtension.
Signature:
toggleUnderline(selection?: PrimitiveSelection): CommandFunction;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| selection | PrimitiveSelection | (Optional) |
Returns:
CommandFunction