Unlayer Documentation

Unlayer Documentation

Welcome to Unlayer Documentation. It takes less than 5 minutes to get our editor up and running on your project.

These guides will take you through the process and get you up and running.

Get Started    Changelog

Custom Tools

What is a Custom Tool?

Custom tools can help you add your own content blocks to the editor. We know that every application is different and needs different tools to reach it's full potential.

It's super simple and easy to create custom tools in Unlayer.

Property Editors

Each tool comes with a set of properties and property editors that are available in tool's template.

Every custom tool needs to have the following items to get up and running.

Slug

A unique identifier string for your tool

Name

A display name for your tool

Icon

An icon for your tool from a choice of 700+ icons

Supported Modes

Display mode this tool will work in (email, web page or both)

Template

Nunjucks template that the tool will output

Properties

A set of properties and controls that your custom tool will need


Creating a Custom Tool

There are 2 ways to create a custom tool. The easy way is to use our GUI Tool Builder in Unlayer Dashboard, but for advanced tools, we recommend using our JavaScript API.

Here are both ways to create a custom tool.

GUI Tool Builder

For simple tools - no coding required

  1. Open Unlayer Dashboard.
  2. Go to your Project. If you don't have one, create a new one.
  3. Go to the Tools menu on top.
  4. Click New Tool
  5. Fill the form and click Create Tool

JavaScript API

For advanced tools - requires coding

If you want to create more advanced and powerful tools, you should use our JavaScript API. It's the same API that our built-in tools are built with so you can create anything you can imagine.

Go to JavaScript API to learn more.


Custom Tools


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.