Create your first component

Creating a component

You can create a new component by clicking the + button in the file explorer, and clicking New component (just as you would a new file or folder).

Screenshot showing how to create a new component
Screenshot showing how to create a new component

Component filename

Give the component a descriptive filename. Component filenames cannot contain /,\,|, <, >, :. ",?,*, . and must be less than 100 characters. You can differentiate files, folders, and components in the file explorer by their icon.

Screenshot showing the different icons for folders, files, and components
Screenshot showing the different icons for folders, files, and components

The component filename (as seen in the file explorer) is unimportant for component use.

Component name

When you create a component, the HTML editor window will be replaced by the component editor window. At the top of this window is the Component Name. The Component Name is the same as the component filename by default, but can be changed independent of the component filename. Component names must only contain letters, numbers, and hyphens - no other characters are permitted. Component names must start with a letter. They cannot contain consecutive hyphens (--) or exactly match HTML reserved keywords (ex: 'button').

Screenshot showing the component filename and component name
Screenshot showing the component filename and component name

Getting started

Only <component>, <fieldset>, and <style> tags are allowed at the top level in a component. Attempting to use other tags at the top level will result in a warning.

Everything inside a <component> </component> tag will be rendered when the component is used. Let's start with a simple component called my-first-component:

my-first-componentcomponent
<component> This will get rendered when this component is used. </component>

Use this component in an email:

my-emailemail
<html>
<body>
A simple email
<my-first-component></my-first-component>
</body>
</html>

The resulting source code will be:

my-emailemail [output]
<html>
<body>
A simple email
This will get rendered when this component is used.
</body>
</html>

Any changes made to the component will propagate to every instance of the component's use.

Jumping back to the component

When you use a component you may want to quickly jump back to it. You can do so by pressing CMD/CTRL + Click on a component to jump to the component file.

Screen recording demonstrating pressing CMD/CTRL + Click to jump to a component file