docs » ClipboardTool

Whether to remove duplicates from the list, keeping only the latest one. Defaults to true.

Number of characters to which each clipboard item will be truncated, when displaying in the menu. This only truncates in display, the full content will be used for searching and for pasting.

Speed in seconds to check for clipboard changes. If you check too frequently, you will degrade performance, if you check sparsely you will loose copies. Defaults to 0.8.

How many items to keep on history. Defaults to 100

If true, check the data identifiers set in the pasteboard and ignore entries which match those listed in ClipboardTool.ignoredIdentifiers. The list of identifiers comes from http://nspasteboard.org. Defaults to true

Types of clipboard entries to ignore, see http://nspasteboard.org. Code from https://github.com/asmagill/hammerspoon-config/blob/master/utils/_menus/newClipper.lua.

• Default value (don't modify unless you know what you are doing):

 {
    ["de.petermaurer.TransientPasteboardType"] = true, -- Transient : Textpander, TextExpander, Butler
    ["com.typeit4me.clipping"]                 = true, -- Transient : TypeIt4Me
    ["Pasteboard generator type"]              = true, -- Transient : Typinator
    ["com.agilebits.onepassword"]              = true, -- Confidential : 1Password
    ["org.nspasteboard.TransientType"]         = true, -- Universal, Transient
    ["org.nspasteboard.ConcealedType"]         = true, -- Universal, Concealed
    ["org.nspasteboard.AutoGeneratedType"]     = true, -- Universal, Automatic
 }

Logger object used within the Spoon. Can be accessed to set the default log level for the messages coming from the Spoon.

maximum size of a text entry

Whether to check the maximum size of an entry. Defaults to false.

String to show in the menubar if ClipboardTool.show_in_menubar is true. Defaults to "\u{1f4cb}", which is the Unicode clipboard character

Whether to auto-type the item when selecting it from the menu. Can be toggled on the fly from the chooser. Defaults to false.

If true, show an alert when a new item is added to the history, i.e. has been copied.

Whether to show a menubar item to open the clipboard history. Defaults to true

Binds hotkeys for ClipboardTool

• mapping - A table containing hotkey objifier/key details for the following items:
  • show_clipboard - Display the clipboard history chooser
  • toggle_clipboard - Show/hide the clipboard history chooser

If the pasteboard has changed, we add the current item to our history and update the counter

• None

Clears the clipboard and history

• None

Clears the last added to the history

• None

Add the given string to the history

• item - string to add to the clipboard history

• None

Verify whether the pasteboard contents matches one of the values in ClipboardTool.ignoredIdentifiers

• None

Display the current clipboard list in a chooser

• None

Start the clipboard history collector

• None

Show/hide the clipboard list, depending on its current state

• None

Toggle the value of ClipboardTool.paste_on_select

• None