Documentation
¶
Overview ¶
Package clip puts text on the local system clipboard, and HTML alongside it when the caller has some, so a chat app or document editor pastes a real table rather than the markup that describes one.
WHY TWO FLAVORS. A clipboard is not one string: it holds the same content in several representations and the PASTING app picks the richest one it understands. Teams, Outlook, Slack and Google Docs take the HTML flavor and render it; a terminal or a code editor takes the plain-text flavor. Writing only plain text — which is all github.com/atotto/clipboard can do — means a copied HTML table arrives in Teams as a wall of <td> tags.
Each platform names the HTML flavor differently and none of the stock command-line tools set two flavors at once, so each gets its own writer:
macOS osascript -l JavaScript → NSPasteboard: public.html + public.utf8-plain-text
Windows user32 SetClipboardData: "HTML Format" (CF_HTML) + CF_UNICODETEXT
Linux Wayland: wl-copy -t text/html (one payload; see rich_unix.go)
X11: dbc owns the selection, every target (see x11owner.go)
Plain-text writes keep going through atotto, which has been dbc's path all along and whose behavior on every platform is already known.
WHAT THIS PACKAGE DOES NOT DO: reach a clipboard on another machine. Over SSH the local clipboard is the server's (or none), and the only way to the user's is OSC 52 through their terminal — which carries plain text only. That fallback needs the terminal handle, so it lives with the UI; Write reports failure and the UI decides what to do next.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Write ¶
Write places c on the local system clipboard.
With HTML set it tries the platform's rich writer first and reports rich=true when both flavors landed. If the rich write is unavailable or fails, it falls back to c.Text alone, so the user still gets SOMETHING on the clipboard, and rich=false lets the caller say so ("copied as plain text") instead of promising a table that will not appear.
A non-nil error means nothing reached the local clipboard at all — the case where the UI should try OSC 52.
Source Files