docs » DeepLTranslate

Show a popup window with the translation of the currently selected text

The spoon uses the https://www.deepl.com translator page The selected text is copied into the source field.
The modal hotkey cmd+alt+ctrl+O replaces the selected text with the translation

Supported language codes are listed at https://www.deepl.com/translator

This is just an adaption of the Spoon PopupTranslateSelection written by Diego Zamboni Download: https://github.com/Hammerspoon/Spoons/raw/master/Spoons/DeepLTranslate.spoon.zip

API Overview

Variables - Configurable values

logger
popup_close_after_copy
popup_close_on_escape
popup_size
popup_style

Methods - API calls which can only be made on an object returned by a constructor

bindHotkeys
translatePopup
translateSelectionPopup

API Documentation

Variables

logger

Signature	`DeepLTranslate.logger`
Type	Variable
Description	Logger object used within the Spoon. Can be accessed to set the default log level for the messages coming from the Spoon.
Source	Source/DeepLTranslate.spoon/init.lua line 47

popup_close_after_copy

Signature	`DeepLTranslate.popup_close_after_copy`
Type	Variable
Description	If true, the popup window will close after translated text is copied to pasteboard. Defaults to `true`
Source	Source/DeepLTranslate.spoon/init.lua line 41

popup_close_on_escape

Signature	`DeepLTranslate.popup_close_on_escape`
Type	Variable
Description	If true, pressing ESC on the popup window will close it. Defaults to `true`
Source	Source/DeepLTranslate.spoon/init.lua line 36

popup_size

Signature	`DeepLTranslate.popup_size`
Type	Variable
Description	`hs.geometry` object representing the size to use for the translation popup window. Defaults to `hs.geometry.size(770, 610)`.
Source	Source/DeepLTranslate.spoon/init.lua line 26

popup_style

Signature	`DeepLTranslate.popup_style`
Type	Variable
Description	Value representing the window style to be used for the translation popup window. This value needs to be a valid argument to `hs.webview.setStyle()` (i.e. a combination of values from `hs.webview.windowMasks`. Default value: `hs.webview.windowMasks.utility\|hs.webview.windowMasks.HUD\|hs.webview.windowMasks.titled\|hs.webview.windowMasks.closable`
Source	Source/DeepLTranslate.spoon/init.lua line 31

Methods

bindHotkeys

Signature	`DeepLTranslate:bindHotkeys(mapping)`
Type	Method
Description	Binds hotkeys for DeepLTranslate
Parameters	mapping - A table containing hotkey modifier/key details for the following items: `translate` - translate the selected text without specifying source/destination languages (source defaults to auto-detect, destination defaults to your last choice or to English)
Returns
Examples
Source	Source/DeepLTranslate.spoon/init.lua line 217

translatePopup

Signature	`DeepLTranslate:translatePopup(text)`
Type	Method
Description	Display a translation popup with the translation of the given text
Parameters	text - string containing the text to translate
Returns	The DeepLTranslate object
Source	Source/DeepLTranslate.spoon/init.lua line 119

translateSelectionPopup

Signature	`DeepLTranslate:translateSelectionPopup()`
Type	Method
Description	Get the current selected text in the frontmost window and display a translation popup with the translation between the specified languages
Parameters	None
Returns	The DeepLTranslate object
Source	Source/DeepLTranslate.spoon/init.lua line 196