extension-strike
package @remirror/extension-strike
class StrikeExtension
The extension for adding strike-through marks to the editor.
Signature:
export declare class StrikeExtension extends MarkExtension
Extends: MarkExtension
(Some inherited members may not be shown because they are not represented in the documentation.)
property name
Signature:
get name(): "strike";
method createInputRules
Signature:
createInputRules(): InputRule[];
Returns:
InputRule[]
method createMarkSpec
Signature:
createMarkSpec(extra: ApplySchemaAttributes, override: MarkSpecOverride): MarkExtensionSpec;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| extra | ApplySchemaAttributes | |
| override | MarkSpecOverride |
Returns:
method createPasteRules
Signature:
createPasteRules(): MarkPasteRule[];
Returns:
method createTags
Signature:
createTags(): ("formattingMark" | "fontStyle")[];
Returns:
("formattingMark" | "fontStyle")[]
method shortcut
Attach the keyboard shortcut to format the text.
Signature:
shortcut(props: KeyBindingProps): boolean;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| props | KeyBindingProps |
Returns:
boolean
method toggleStrike
Toggle the strike through formatting annotation.
Signature:
toggleStrike(): CommandFunction;
Returns:
CommandFunction