Made in Builder

Made in Builder

×

Developers

Product

Use Cases

Pricing

Developers

Resources

Company

Get StartedLogin

Product

Pricing

Blog

Home

Resources

Blog

Forum

Github

Login

Signup

×

Visual CMS

Drag-and-drop visual editor and headless CMS for any tech stack

Theme Studio for Shopify

Build and optimize your Shopify-hosted storefront, no coding required

Resources

Blog

Get StartedLogin

Contributing Plugins to Builder

If you'd like a plugin with specific features but it's not already in Builder, you can submit a public plugin to Builder with a GitHub pull request. A public plugin is a plugin that anyone can use with Builder. When a public plugin is merged, it becomes part of Builder and Builder developers maintain it.

This document covers the main types of plugins developers contribute with links to examples and more information.

Tip: You can create public plugins and submit a pull request on any plan. If a public plugin doesn't meet your needs, you can create a private plugin. Private plugins require an Enterprise plan, you host your own plugins, and you handle configuration manually.

Prerequisites

To get started contributing plugins, you should be familiar with the following:

Types of Builder plugins

Plugin contributions tend to fall into three categories that cover the most common use cases:

E-commerce custom editor plugins

With e-commerce plugins, teammates can search and link selected products and categories from their e-commerce backend to structured data entries, Sections, and Pages within the Visual Editor. This gives teams a minimal process for enriching content by selecting products linked to their e-commerce backend from within the Visual Editor.

For example, marketing or design teammate can populate elements such as product cards, product galleries, add to cart buttons, list of product recommendations, by selecting what they need from your plugin.

For more information see the following resources:

Data Connector plugins

Use data connector plugins to enrich the data available in Visual Editor Sections and Pages from external sources. With a data plugin, team mates can select entries or query the source and bind to the results of queries directly in Builder.

Resources:

Action shortcut plugins

You can use action shortcuts in Builder to give non-technical teammates access to some of the tasks that would otherwise require developer involvement. With action shortcuts a user can trigger tracking events, set up conditional values, or set specific values on state without having to write code.

In the example illustrations that follow, the action Track Event with Google Analytics comes from a plugin that defines what this action does for the bound element. In this example, when the user clicks a button, the action sends the event addToCart to Google Analytics.

For a pre-made example, check out Builder's example action plugin.

Generic Custom Editor plugin

Custom editor plugins help you register custom field types for your Builder model custom fields and inputs for your custom components, custom targeting, and symbols.

To create a custom editor, build a React component that takes a value prop and an onChange prop. Within your custom editor component, call the passed in onChange() function when the value is updated. The value you set can be any type serializable to JSON—for example, string, number, null, array, object—and be as deeply nested as you need.

For more information see the following resources:

Next steps

If you're ready to start contributing, check these articles:



Need Expert help?

Submit a project to our partners, BuildQuick, and be matched with a Builder expert.

Submit a project

Was this article helpful?