react-design-system

Builder.io custom design system example with React

✨ Try it live here!

In this example we show how to integrate react components with Builder.io. This is useful when you want to add the ability for your team to utilize custom components on the pages you build using the Builder editor, or even want to make it so people on your team can only build and edit your site's pages using your custom components.

⚛️ For serve side rendered examples see our Next.js and Gatsby examples

The source code for the custom components used in this demo are here, and you can see how they are registered with Builder by looking at the files that end in *.builder.js (this is an example). The logic for adding components to the Builder editor menu can be found here

👉Tip: want to limit page building to only your components? Try components only mode

To run the example Locally

• Sign in or create an account
• Create a new page
• Clone and start the project:

Clone and install dependencies

using git

git clone https://github.com/BuilderIO/builder.git
cd examples/react-design-system
npm install

Generate your Builder.io space

Signup for Builder.io, then go to your organization settings page, create a private key and copy it, then create your space and give it a name

From the examples/react-design-system folder

builder create -k [private-key] -n [space-name] -d

This command when done it'll print your new space's public api key, copy it and add as the value for YOUR_KEY in builder-settings

YOUR_KEY=...

Run the dev server

npm run start

It'll start a dev server at http://localhost:3000

This will allow Builder to read in all your custom component logic and allow your team to edit and build using your components.

When you deploy this to a live or staging environment, you can change the preview URL for your model globally from builder.io/models (see more about models here and preview urls here)