Merge branch 'webext' into 'main'

Web extension POC

Closes #3

See merge request teklia/escriptorium/virtual-keyboard!1

.gitignore

+node_modules

README.md

 # Virtual Keyboard
 
+## Setup
+`npm i`
+
+## Development
+`npm run start:firefox`

extension-dist/index.js

+const inputFields = document.getElementsByTagName('input')
+const replacements = {
+  a: "b"
+}
+// Create a simple keyboard
+const buttonA = document.createElement('button')
+buttonA.textContent = 'Insert "a"'
+const buttonB = document.createElement('button')
+buttonB.textContent = 'Insert "b"'
+const keyboard = document.createElement('div')
+keyboard.appendChild(buttonA)
+keyboard.appendChild(buttonB)
+
+let selectedInput = null
+
+addChar = (i, char) => {
+    const start = i.selectionStart
+    i.value = i.value.slice(0, start) + char + i.value.slice(i.selectionEnd)
+    // Updating the input value moves the caret to the end by default
+    i.selectionStart = i.selectionEnd = start + 1
+}
+
+for (const input of inputFields) {
+  input.onkeydown = e => {
+    const character = replacements[e.key]
+    if (!character) return
+    addChar(input, character)
+    return false
+  }
+  // Handle the case where the input is already focused
+  if (document.activeElement === input) {
+    input.parentElement.appendChild(keyboard)
+    selectedInput = input
+  }
+  input.onfocus = e => {
+    input.parentElement.appendChild(keyboard)
+    selectedInput = input
+  }
+  // https://css-tricks.com/a-css-approach-to-trap-focus-inside-of-an-element/
+  input.ontransitionend = e => {
+    if (input.matches(':focus') || keyboard.contains(document.activeElement)) e.target.focus()
+    else {
+      input.parentElement.removeChild(keyboard)
+      selectedInput = null
+    }
+  }
+}
+
+keyboard.onclick = e => {
+  return false
+}
+buttonA.onmouseup = e => {
+  if (selectedInput) addChar(selectedInput, "a")
+}
+buttonB.onmouseup = e => {
+  if (selectedInput) addChar(selectedInput, "b")
+}

extension-dist/manifest.json

+{
+
+  "manifest_version": 2,
+  "name": "Virtual keyboard",
+  "version": "0.0.1",
+
+  "description": "Adds a customizable virtual keyboard on text input areas.",
+
+  "icons": {
+    "48": "icons/keyboard-48.png",
+    "96": "icons/keyboard-96.png"
+  },
+
+  "browser_action": {
+    "default_icon": {
+      "19": "icons/keyboard-19.png",
+      "32": "icons/keyboard-32.png"
+    },
+    "default_title": "Virtual Keyboard"
+  },
+
+  "content_scripts": [
+    {
+      "matches": ["<all_urls>"],
+      "js": ["index.js"],
+      "css": ["style.css"]
+    }
+  ]
+}

extension-dist/style.css

+input:not(:focus-within) {
+  border-color: black;
+  transition: border-color 0.001s;
+}

package.json

+{
+  "name": "virtual-keyboard",
+  "version": "0.0.1",
+  "description": "Adds a customizable virtual keyboard on text input areas.",
+  "main": "extension-dist/index.js",
+  "scripts": {
+    "start:firefox": "web-ext run --source-dir ./extension-dist/"
+  },
+  "dependencies": {
+    "web-ext": "6.1.0"
+  }
+}