Using Snippets

Snippets are a file type in the Web IDE that allow for small pieces of code to be abstracted out from the views.


The code in Views can get pretty crowded with code depending on what you're working on. Snippets can make all that code more modular and easy to manage by allowing user to abstract complicated and repeated pieces of code into a separate file. When you want to include your abstracted code into a view, use the Parsley {{ include }} call.

Common Use Cases

There are several common use cases that Snippets are commonly used for:
  • Headers
  • Footers
  • Sidebars
  • Navigation bar(s)
While these are common use cases, more complex pieces of code can be abstracted as well. For example, it may be easier to work on a large form when it's abstracted into its own Snippet, or a complex in-View script may be easier to work when it's not surrounded by a View's HTML.
The Loader, which comes with every single instance, is a Snippet. This file allows for views to be rendered using the {{ current_view }} call.

Creating Snippets

For this guide we're going to be making a simple header for our website. We are starting at the last step of the Schema-Content-Code process: coding it all in. If you need a refresher on how works refer to these articles: create an instance, build the Schema, and add Content before jumping into the Web IDE to code it all in.
1. Navigate to the Web IDE.
Navigate to the Web IDE.
2. Create the blue Create File button. Note: depending on your screen size you'll simple see a blue button with a + sign on it.
Create a new file.
3. Select Snippet from the dropdown.
Select Snippet as your File Type.
4. Give it a name. There is no need to add an extension to the file name.
Give your snippet a name.
5. Click Create.
Click the green Create File button to create your file.

Using Snippets

When working on your Snippet you'll need to include it in a view in order to preview your changes. Since we're working on a header that we want to be on every single page, we're going to add our Snippet to the Loader which loads every view.
After creating your Snippet:
1. Include your snippet in a View so you can view your changes as you're coding.
Include your snippet in a view.
2. Code your Snippet as necessary.
Add code to your snippet file.
3. Save your changes.
Save your changes.
4. preview them before sending them live.
Before and after adding the header snippet.
5. Once you're satisfied with the code in your Snippet, send it live by publishing it.
Publish your snippet once you're ready to go live.
To send snippets live both the snippet and the view that the snippet is included in need to be published.