Plugin that adds CSS support to Sketch 3 for a faster design workflow.
Objective-C JavaScript Ruby Other
Latest commit 119961d Nov 23, 2016 @JohnCoates committed on GitHub Merge pull request #53 from samueljoos/master
fix endless file selecting loop issue #47

Readme.md

CSSketch - CSS for Sketch 3

CSSketch is a Sketch 3 plugin that enables you to modify your designs quickly by attaching it a stylesheet to it that you can use to lay out your designs, change colors and shadows quickly, etc. It supports Sass and {less} stylesheets, which means you can put functions and variables in your stylesheet to make your workflow even more efficient.

CSSketch is completely open source, so feel free to contribute to its development!

The Story Behind CSSketch

Programmers Design Differently: Why I Built a CSS Plugin for Sketch 3 on Medium.com

Screencast

Screencast

Download & Install

CSSketch is available through Sketch Toolbox. This is the best option for installation, as it automatically keeps CSSketch up to date.

Download & Install Manually

Download from Github

Open CSSketch.sketchplugin and Sketch will ask if you'd like it installed

Using CSSketch

  • To enable CSSketch you must run the menu bar option every time Sketch 3 launches. You can find it on the menu bar at Plugins -> CSSketch -> Layout Layers.
  • A stylesheet is set on a per-page basis. Set the stylesheet at Plugins -> CSSketch -> Set Page's Stylesheet for every page you want a stylesheet for. Once this is set, simply make changes to the stylesheet and save them to see the effects.
  • Take a look in Examples/ for examples of what you can do right now.
  • Please Note: Handling for many CSS rules is missing currently.

Targeting Your Sketch File

You can use the following attributes to target various components of your sketch file in combination with other css targeting methods:

  • [type="artboard"] - To target all artboards
  • [type="text"] - To target all text
  • [name="yourLayerName"] - To target all layers with yourLayerName in their name
  • .className - To target all layers named .className

Features

  • Less Support: Variables and functions are supported. Find out more at LessCSS.org
  • Auto Detect Stylesheet changes: Set the stylesheet once, and that's it. Changes are detected and applied as soon as you save the stylesheet.
  • Webkit Engine: CSSketch is powered by the WebKit engine, the same code that powers Safari and Google Chrome.
  • Toolbar Icon: A toolbar icon is added after running CSSketch for easy applying of changes.
  • Sandbox Support: CSSketch works with the Mac App Store version of Sketch 3 as well as the regular version.
  • Stylesheet Path Store In Document: You only ever have to set the stylesheet path once. It's then stored in the document for future use.

Supported CSS

  • CSSketch uses the system version of WebKit. Upgrade to El Capitan for the best compatibility with CSS standards.
  • All layout variables should work fine.
  • All elements are given default values of position:absolute, top, and left, with their current positions on the artboard.
  • For selectors: All layers are the element type "layer". The name attribute is set to a layer's name, minus the classes. The type attribute is set to "text" for text, and "artboard" for artboards.
  • Background-color is supported
  • Border is supported (only solid lines)
  • Shadow is supported
  • Color is supported
  • Text-transform is supported

Extra Resources Posted On Dribbble!

Dribbble

Community

  • Find a bug? Open an issue. Try to be as specific as possible.
  • Have a feature request Open an issue. Tell me why this feature would be useful, and why you and others would want it.

Contribute

Lot of CSS rules have yet to be added. They're decently easy to add. I appreciate all pull requests! You'll want to modify the following files to add CSS rule handling:

Changelog

  • February 2016 - 1.1: Sass support, installer, now uses SketchKit
  • October 2015 - 1.0: first release

License

MIT License

Author

Maintained and created by John Coates @punksomething