Skip to main content

extension-gap-cursor

package @remirror/extension-gap-cursor

class GapCursorExtension​

Create a gap cursor plugin.

Signature:

export declare class GapCursorExtension extends PlainExtension

Extends: PlainExtension

Remarks:

When enabled, this will capture clicks near and arrow-key-motion past places that don't have a normally selectable position nearby, and create a gap cursor selection for them. The cursor is drawn as an element with class ProseMirror-gapcursor.

Make sure to import the styles as shown below.

import '@remirror/styles/extension-gap-cursor.css';

(Some inherited members may not be shown because they are not represented in the documentation.)

property name​

Signature:

get name(): "gapCursor";

method createExternalPlugins​

Signature:

createExternalPlugins(): ProsemirrorPlugin[];

Returns:

ProsemirrorPlugin[]

variable isGapCursorSelection​

Predicate checking whether the selection is a GapCursor

Signature:

isGapCursorSelection: (value: unknown) => value is GapCursor