Sketch Assistant Rules Explained 📐

Here's all of our awesome Sketch assistant rules explained. For normal humans.

Download our Sketch assistant

Document must contain one artboard named “Start” on a page named “Start here”

Behind the scenes this artboard actually becomes your very first page in code, aka index.html 🤖💪

Document must contain one page named “Start here”

We call this the code page. You can have several pages in your Sketch file but only the things that are on this super important page comes out to code in Sketch2React. ✅

Group name may contain zero or one pair of square brackets

In this example we added a margin top of 16px to this text block

Square brackets [ ] are used for adding CSS rules to specific parts of your design. Read more about them here.

Group name must contain one pair of curly brackets

Curly brackets { } are used within the Sketch2React framework to define component name i.e. {container}. Incorrect number of square brackets will cause parsing errors.

Text name must contain one pair of curly brackets

Here we have created a {text} component and saved it as a symbol aka reusable component

Curly brackets { } are used within the Sketch2React framework to define component name i.e. {text}. One neat trick is that if you convert your Sketch2React components to symbols, you don't need to follow our naming convention for the parent, in above case we have called the symbol H1.

Text name may contain zero or one pair of square brackets

Here we use the CSS class for using view height 100% for a nice flex layout of the whole container

Square brackets are used within the Sketch2React framework to define css-classes i.e. [css-class-name1 css-class-name2].

Artboards must contain at least one text layer named {externalasset.css}

{externalasset.css} is used within the Sketch2React framework to target external CSS assets (fonts, local CSS-files, animation libraries etc.) that should be included in the generated output. Make sure to copy them to all your pages where you have external dependencies.