Read/Write Sketch objects from the pasteboard

100%

Read/Write Sketch objects from the pasteboard

✓ Published0🌍 Public

Last edited May 20, 2021

Created on May 20, 2021

This example demonstrates how to copy and paste Sketch layer objects through the system pasteboard, showing both read and write operations. The read script retrieves layers from the pasteboard using `MSPasteboardManager.readPasteboardLayersFromPasteboard` and wraps them with the Sketch JavaScript API. The write script takes a selected layer from `doc.selectedLayers`, wraps it in an `MSLayerArray`, and writes it using `MSPasteboardLayers.pasteboardLayersWithLayers` and `MSPasteboardManager.writePasteboardLayers_toPasteboard`. The code relies on the `sketch` module and native Objective-C class access, with `context.document` providing the document’s color space.

AI-generated description

Similar vizzes

Loading thumbnail…

Pasteboard

This example demonstrates the various formats a copied Sketch object can take when retrieved from the system pasteboard. It shows that a single clipboard item contains multiple simultaneously available data representations, including native Sketch JSON, Adobe PDF, and TIFF image data. The visualization uses AppleScript’s `NSPasteboard.generalPasteboard().pasteboardItems()` API to access clipboard contents, then calls `items[0].types()` to list the available MIME types and `items[0].dataForType('com.bohemiancoding.sketch.v3')` to extract the raw binary data, which appears as a hexadecimal dump. The code reveals the clipboard’s multi-format nature without rendering any graphical output.

KKevinGutowski

74% match

Loading thumbnail…

Reading/writing a sketch file without opening it

This example demonstrates direct, scripted access to Sketch design files without opening the Sketch application, showing both how to read an existing `.sketch` document and how to write a new one. In the reading script, the code uses Sketch’s `Document` API alongside native macOS `MSDocument` methods, specifically `readDocumentFromURL_ofType_error`, to load a file from a hardcoded file path and log its JavaScript representation. The writing script similarly uses `MSDocument`’s `writeToURL_ofType_options_error` to save a new file to a given URL. Both scripts rely on the `sketch` module and coercive bridging from native objects via `Document.fromNative`. The data source is a local file path (`/Users/kgutowski/Downloads/Test.sketch`), and the concrete interaction is entirely file-based, with no visual output rendered.

KKevinGutowski

67% match

Loading thumbnail…

SF Symbols -> Sketch

The example imports SVG files from URLs copied to the macOS pasteboard and places them onto a selected artboard in Sketch. It uses the Sketch JavaScript API with `sketch.ShapePath`, `sketch.getSelectedDocument`, and `MSSVGImporter` to parse and convert each SVG into a native layer. The script reads URLs via `NSPasteboard` and `readObjectsForClasses_options`, then positions each imported layer horizontally with an offset of 50 pixels. The code demonstrates batch SVG ingestion from clipboard data into a design document.

KKevinGutowski

67% match

Loading thumbnail…

Clipboard/Pasteboard reading

This example demonstrates a live readout of the system clipboard’s contents by inspecting the pasteboard directly. It shows the list of available data types, then retrieves and prints the plain-text and HTML representations, as well as the raw bytes of a custom Apple WebKit type. The code uses the macOS `NSPasteboard` API and its `generalPasteboard()` method to access the current pasteboard item, calling `pasteboardItems()` and then `stringForType` and `dataForType` to extract specific formats. The output is logged to the console, revealing the actual clipboard payload.

KKevinGutowski

66% match

Loading thumbnail…

A Sketch snippet to copy global colors to the pasteboard

This sketch copies all global color assets from a Sketch document to the clipboard as CSS rules, converting each color to hex and generating class names. It uses the Sketch JavaScript API (`sketch.globalAssets`) to access color assets and `NSPasteboard` to write the formatted string. The code iterates through every saved color, builds a CSS block with a `.colorN` selector or the asset’s name, and trims trailing whitespace before showing a confirmation message.

KKevinGutowski

65% match

Loading thumbnail…

Sketch Global colors to Layers

This example demonstrates how to extract the global color palette from Sketch’s asset library and render each color as a square swatch on the selected page. It iterates through the document’s color assets, converts each color from its native color space to a hexadecimal string, and creates a new `ShapePath` for every swatch, positioning them in a horizontal row. The script uses the Sketch JavaScript API, specifically `MSPersistentAssetCollection`, `ShapePath`, and `Rectangle`, with custom helper functions for RGB-to-hex conversion.

KKevinGutowski

62% match

Loading thumbnail…

Paste In SVG code

This example demonstrates how to insert raw SVG markup directly into a Sketch document using the Sketch DOM API and the `sketch/createLayerFromData` function with an 'svg' format. The code prompts the user for an SVG string through `UI.getInputFromUser`, then assigns the resulting layer to the selected page. It relies on the `sketch/dom` module to handle document and page selection, and `sketch/ui` for the input dialog, creating a quick bridge between external SVG code and Sketch’s native layer hierarchy.

KKevinGutowski

60% match

Loading thumbnail…

Add padding to artboard (WIP)

This plugin demonstrates how to adjust an artboard's dimensions and reposition its contents with a user-defined padding value. It uses the Sketch JavaScript API, including `doc.selectedLayers`, `Rectangle`, and `UI.getInputFromUser`, to prompt for input and modify layer frames. The script shifts the artboard’s frame outward by the padding amount while moving all nested layers inward by the same value, preserving their relative positions. It relies on `selection.frame` and `layer.frame` properties to apply geometric transformations.

KKevinGutowski

60% match