USER GUIDES
Creating Content
Learning the visual editor
Responsive design tricks
Saving layers as templates
Importing your site pages
Connecting custom data
Interactive pages with state and actions
Creating reusable components with Symbols
Targeting and scheduling content
Building custom forms
How To
Platforms
DEVELOPER GUIDES
Guides
Quick start
SEO optimizing Builder.io content
Creating custom models
Using custom fields
Enable on-site previewing and editing
Dynamic URLs and advanced data fetching
Adding Custom Code
Using 3rd party libraries
Import HTML
Extending Builder.io with plugins
REST API
React
Getting started
Using Next.js
Using Gatsby
Using your React components in Builder
Triggering custom actions
Angular
Ruby on rails
Webcomponents
Github
Getting Started with Builder with React
Using your own React components in Builder is one of our most powerful features! Learn how below.
Install the SDK
To begin, use npm or yarn to install @builder.io/react.
npm install --save @builder.io/reactInitialize with your API key
Grab your API key from the account page and
import { builder, BuilderComponent } from '@builder.io/react'
builder.init(YOUR_KEY)
Add the BuilderComponent
Anywhere in your app add <BuilderComponent model="page" /> to use the default page model, e.g. in your router:
<Route path="/something" render={() => <BuilderComponent model="page" />}>Edit away
Now create a new page, open it up to your local URL that has the Builder component, and edit away!
Using your components in the editor
See this guide for designing with your custom components!
Questions or comments?
Give us a chat, we respond quickly and are here to help!
CHAT US NOW