Resources

×

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

Forum

Blog

Github

Signup

Made in Builder

Using your react components in Builder

Icon for Next.js

Check out our step by step guide on this topic

For the easiest getting started path with using your React components, try our tutorial with step by step instructions on how to get started with this feature in Builder!

When you integrate your custom React components with Builder, anyone creating content within your organization can use your custom built components with the drag and drop editor.

👉 Don't use React? You can register custom web components with any framework or stack. Learn more here

Install the SDK

In your project, use npm or yarn to install @builder.io/react.

Configure the SDK with your API key

The JavaScript SDK needs your API key to fetch your content hosted on Builder.io.

The examples below are written as if you had configured the SDK to use the same API key for all keys.

You should configure the SDK at the start of your application, typically a file like src/index.js. Near the top of this file, before any other calls to the Builder.io SDK add a call to builder.init() as in the following example. Replace YOUR_KEY with the API key found in your organization settings.

Builder-Enabling a Component

Below is the actual source for a component we use heavily within our docs. It takes two props, code and language , and uses react-syntax-highlighter to syntax highlight the code.

This is a normal React component that can be used alone, but we can expose it to the Builder visual editor by registering it with the SDK.

Registering a component with Builder.registerComponent(...) does two things:

  1. Makes the component appear in the visual editor so you can build pages with it
  2. Tells the SDK's <BuilderComponent /> to use it for content that was created in the visual editor

The options you provide to registerComponent(component, options) tell the visual editor how your component should appear in the visual editor's library. You can use this to control what icon is displayed and what its displayed name is. For a list of other options, see Input types.

Make sure that your prop has a matching input for each prop it expects. Listing the inputs allows you to pass data back from the visual editor.

Including the Component

👉Tip: To limit visual editing to only your custom components, use components only mode.

To use our new CodeBlockComponent with any of our Builder content, we have to import the file to make sure that it's registered before the code makes any calls to BuilderComponent.

The example below assumes that we have a model named docs-page that uses our code block. Feel free to create your own model and replace it.

Time to test it out! Visit any page in your web browser that renders this component. If you're using something like React router, you could add a new route to the docs page file above.

Input types

Here is a more lengthy example demonstrating more input types.

The schema of inputs is as follows:

NameRequiredDescription

name

Yes

A unique name for this input that should match the equivalent prop name on your react component

type

Yes

Types correlate to what editing UI should be used to edit this field. Common types include

View detailed info on input types

You can also add custom types here via plugins

helperText

No

Provide text to help the end user with how to fill in this input. Displays below the input to describe or instruct what to enter

defaultValue

No

An optional default value for this prop. This is useful for showing an example value in the input form when creating a new instance of this component, to better help people using it understand it's purpose

subFields

No

If the input type is "list" you need to include the "subFields" property that is a list of inputs (with this same schema) for each list item

allowedFileTypes

No

For the "file" input type you typically want to specify what types of files can be uploaded. This is an array that takes content-type files such as:

enum

No

For any text-based field type, can set a specific set of options that can be used

regex

No

For any input that results in a string value you can provide a regex to validate user input.

onChange

No

Provide a function that is called whenever the value of the input is updated. Useful for more complex validation than what regex provides or running any sort of custom logic when an input value updates.

friendlyName

No

The name you would like displayed in the editor for the input

showIf

No

Show and hide the input dynamically. options is an object with the current options (values from inputs) that are set on the component. parent is the component definition, and parentElements is an array of all the parent elements of where the component is placed. For example, to only show the input if the component is inside of a Columns component and has the input myInputOption set to true, you could write a function like this:

Using the state of other inputs via options is a useful way to hide or show inputs that depend one one another. For example, you could show an input that opens a link in a new tab only when a link is entered, instead of always showing all inputs and potentially confusing someone using the component.

hideFromInsertMenu

No

Hide your component from the insert menu within Builder. This can be useful if you are gradually deprecating a component and do not want new content to use it, but still need the component to be registered within Builder so that older content that uses the component will continue to function properly. More info on versioning here

noWrap

No

By default Builder wraps your components in a dom element (by default a div but the type of element can be changed) with a few needed attributes and classes for the editor to work as expected.

You can opt out of this wrapping by using the noWrap option. You can see a full code example of this with our built-in form input component here

For sake of example here, if you say wanted to use a Material UI TextField in Builder.io with noWrap

Default Styles

If you would like your components to have some default CSS styles applied, that can be edited in the style tab, you can set default styles as follows:

Using your components in the editor

To use your components in the editor, make sure you first follow this guide to allow editing and previewing directly on your site.

Then, when editing a page in Builder that imports components with the withBuilder() function, they will display in your Insert tab in a Code Components section.

Developing and testing locally

When developing locally, update the preview URL in the top right corner of the preview from your production URL to your local development URL.

Note that when developing locally you are mostly likely developing on a non-ssl http:// url within Builder, which is an https:// site. Browsers don't allow https:// sites to make insecure http:// requests unless you explicitly allow it.

To allow access to your local http URL in Chrome, click the shield icon on the right side of your URL bar, and then choose "load unsafe scripts". The page will reload and you may have to enter your local URL a second time, but this time Chrome will allow its content to load.

Server side rendering (SSR) and static site rendering (SSG)

Builder supports SSR and SSG out-of-the-box for all components.

If you have custom components that depend on external data sources and need that data server side, such as a products API, use Builder's getAsyncProps utility to fetch any data needed server-side before render.

The following is a usage example with Next.js:

For more information on server-side data, see the getAsyncProps README.

Children in custom components

You can also have children within your Buider.io components. These children are limited to specific child options or any type of child. Note the use of withChildren() in the following example–this configuration allows this component to have children.

If you want to allow only certain types of children, you can configure childRequirements as in the following example:

Advanced child sub-component use cases

For use cases that need to render multiple sets of children, such as making your own custom tabs components, see Builder's built-in tabs component source code.

Some examples of component source code with multiple children include:

▶ Expand code example

👉Tip: You can see a detailed answer to advanced React children use cases with code examples over in our forum!

Versioning and Deprecating Custom Components

When you make changes to custom components that are already in use, we recommend that any changes made to your components be backwards compatible with existing content. This way any content using the old version of the component continues to function properly.

Although the content was originally created with the old version of the component, Builder uses the current version of the custom component when rendering your content since that is the version that exists on your site.

For example, if the new version of the custom component has an additional input, make sure to handle the case where that input is undefined, since old content does not have a value for that input.

Note: If a defaultValue is passed to an input, Builder only applies that value to new content that uses the new component–it is not retroactive.

If the changes you need to make cannot be backwards compatible, the best approach is to create an entirely new component registered with a new name.

You still need to register the old version of the component with Builder so that existing content on your site using the component will continue function properly. However, hide the old component from the Builder editor so your team doesn't use the old version with newer content.

To do hide a component, use the hideFromInsertMenu option when registering the component.

👉Note: Content model backing the component will not update automatically

Input type examples:

string: any text, usually shorter in length and unformatted

alias: text

number: an input field expected to take a number such as an amount

boolean: an input field taking true or false

longText: same as string type but with a multiline text field editor. (if formatted, use richText)

richText: Displays a rich text editor and provides the value as html

alias: html

file: Uploads a file and provides the value as a url string. See allowedFileTypes for additional details.

color: provides a color value (hex or rgb) to a component

date: any format that the date constructor for Javascript takes

email: create an email value for a component

object: a set of specific names and values

*note: you will get errors if no defaultValue is set for objects 

list: list of items

alias: array

*note: you will get errors if no defaultValue is set for lists

Components-only mode

To limit page building to only your custom code components try out components-only mode.

Don't use React?

Even if you use any other framework, you can get the same level of functionality using symbols or register custom web components

Was this article helpful?