From 729fa7f0360fd4eabaf878bbb7b575967ef6a07b Mon Sep 17 00:00:00 2001
From: Hans Pagel <hans.pagel@ueber.io>
Date: Thu, 5 Nov 2020 11:46:27 +0100
Subject: [PATCH] add content to the gapcursor page

---
 .../demos/Extensions/Gapcursor/index.spec.js  |  5 ++
 docs/src/demos/Extensions/Gapcursor/index.vue | 77 +++++++++++++++++++
 docs/src/docPages/api/extensions/gapcursor.md | 12 +--
 3 files changed, 85 insertions(+), 9 deletions(-)
 create mode 100644 docs/src/demos/Extensions/Gapcursor/index.spec.js
 create mode 100644 docs/src/demos/Extensions/Gapcursor/index.vue

diff --git a/docs/src/demos/Extensions/Gapcursor/index.spec.js b/docs/src/demos/Extensions/Gapcursor/index.spec.js
new file mode 100644
index 00000000..3adf87fd
--- /dev/null
+++ b/docs/src/demos/Extensions/Gapcursor/index.spec.js
@@ -0,0 +1,5 @@
+context('/examples/gapcursor', () => {
+  before(() => {
+    cy.visit('/examples/gapcursor')
+  })
+})
diff --git a/docs/src/demos/Extensions/Gapcursor/index.vue b/docs/src/demos/Extensions/Gapcursor/index.vue
new file mode 100644
index 00000000..14e46c2a
--- /dev/null
+++ b/docs/src/demos/Extensions/Gapcursor/index.vue
@@ -0,0 +1,77 @@
+<template>
+  <div>
+    <editor-content :editor="editor" />
+  </div>
+</template>
+
+<script>
+import { Editor, EditorContent } from '@tiptap/vue-starter-kit'
+import Document from '@tiptap/extension-document'
+import Paragraph from '@tiptap/extension-paragraph'
+import Text from '@tiptap/extension-text'
+import Gapcursor from '@tiptap/extension-focus'
+import Image from '@tiptap/extension-image'
+
+export default {
+  components: {
+    EditorContent,
+  },
+
+  data() {
+    return {
+      editor: null,
+    }
+  },
+
+  mounted() {
+    this.editor = new Editor({
+      extensions: [
+        Document(),
+        Paragraph(),
+        Text(),
+        Image(),
+        Gapcursor(),
+      ],
+      content: `
+        <p>Try to set the cursor behind the image!</p>
+        <img src="https://source.unsplash.com/8xznAGy4HcY/800x400" />
+      `,
+    })
+  },
+
+  beforeDestroy() {
+    this.editor.destroy()
+  },
+}
+</script>
+
+<style lang="scss">
+/* Copied form the original prosemirror-gapcursor plugin by Marijn Haverbeke */
+/* https://github.com/ProseMirror/prosemirror-gapcursor/blob/master/style/gapcursor.css */
+
+.ProseMirror-gapcursor {
+  display: none;
+  pointer-events: none;
+  position: absolute;
+}
+
+.ProseMirror-gapcursor:after {
+  content: "";
+  display: block;
+  position: absolute;
+  top: -2px;
+  width: 20px;
+  border-top: 1px solid black;
+  animation: ProseMirror-cursor-blink 1.1s steps(2, start) infinite;
+}
+
+@keyframes ProseMirror-cursor-blink {
+  to {
+    visibility: hidden;
+  }
+}
+
+.ProseMirror-focused .ProseMirror-gapcursor {
+  display: block;
+}
+</style>
diff --git a/docs/src/docPages/api/extensions/gapcursor.md b/docs/src/docPages/api/extensions/gapcursor.md
index 1f16726b..52d358f2 100644
--- a/docs/src/docPages/api/extensions/gapcursor.md
+++ b/docs/src/docPages/api/extensions/gapcursor.md
@@ -1,4 +1,7 @@
 # Gapcursor
+This extension loads the [ProseMirror Gapcursor plugin](https://github.com/ProseMirror/prosemirror-gapcursor) by Marijn Haverbeke, which adds a gap for the cursor in places that don’t allow regular selection. For example, after a table at the end of a document.
+
+Note that tiptap is renderless, but the dropcursor needs CSS for its appearance. The default CSS is added to the usage example below.
 
 ## Installation
 ```bash
@@ -9,15 +12,6 @@ npm install @tiptap/extension-gapcursor
 yarn add @tiptap/extension-gapcursor
 ```
 
-## Settings
-*None*
-
-## Commands
-*None*
-
-## Keyboard shortcuts
-*None*
-
 ## Source code
 [packages/extension-gapcursor/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-gapcursor/)