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

Setting up Plugins

Plugins are distributed as JavaScript files that you can install from npm packages or directly from a URL.

You install and configure plugins separately for each space in your account. After setting up a plugin, you can use its features from anywhere in that space.

You can set up your plugins using one of two methods depending on whether you're installing a public Builder-provided plugin or a private plugin that you or a third party create.

Installing and configuring public plugins

You can install and configure Builder's public plugins from the Integrations page. Builder reviews these for security, maintains them, and distributes these plugins through the npm Registry.

Navigate to the page by selecting Integrations from the left side bar of the Builder dashboard.

Every item on the Integrations page that has an Enable button is a plugin that you can install in your space.

You can install a plugin by selecting Enable. The following example uses the Shopify e-commerce plugin.

If the plugin provides configuration options, you can configure the plugin by selecting the Settings button, which appears after installation.

The settings page allows you to configure your plugin. The exact settings listed depend on the plugin.

For official integrations, configuration typically involves adding API keys and tokens so that Builder can request data from an external data source, such as an e-commerce platform.

Installing and configuring private plugins

enterprise plans

If you're on an enterprise plan, you can install private plugins that you or a third party create through the Advanced configuration option on the Integrations page.

Navigate to the page by selecting Integrations from the left side bar in the Builder dashboard.

Scroll to the bottom of the page and select Advanced configuration.

Select the Add Plugin button from the Edit Plugins menu.

Enter the package name of your private plugin and select Save to install it. The package name corresponds to the value of the name field in the package's package.json file, and the package must be publicly available on the npm Registry.

Alternatively, you can provide a URL that points to a JS file for your plugin. You can use this method to install privately-published plugins.

If it provides configuration options, you can configure your plugin by selecting Edit plugin settings, which appears in the Edit Plugins menu after installing it.

Next steps

For more information on using plugins, check out the following 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?