Contact salesLog in
Try for free

Let's cook our first brick! 🍳

Explore the /bricks folder.

Under the react-bricks/bricks directory will live your bricks.

You can see that the index file imports the pre-made blocks by our react-bricks-ui library and adds a custom hero unit that you can find in the MyHeroUnit.tsx file.

The bricks exported by the index files are used by React Bricks (they are passed as config to the ReactBricks component with other configuration settings). The configuration settings are in the react-bricks/config.ts file (and _app.tsx adds dark-mode related configurations).

A new brick...

Under the bricks folder, create a new file called Thumbnail.tsx, with the following minimal content:

// Thumbnail.tsx
import React from 'react'
import { types } from 'react-bricks/frontend'
const Thumbnail: types.Brick = () => {
return <div className="p-6 text-center">Thumbnail</div>
}
Thumbnail.schema = {
name: 'thumbnail',
label: 'Thumbnail',
sideEditProps: [],
}
export default Thumbnail

You see that a brick is a normal React functional component with a schema static property. The schema describes the behavior of the brick.

In particular here you see the minimal required configuration, with:

  • name: unique name for this brick
  • label: pretty name for the users
  • sideEditProps: ad array of props which are modified using the sidebar controls
Docs reference
» What is a brick

...in the wall!

Let's add our new brick to React Bricks: open the index.ts file in the bricks folder and modify it in this way:

// index.ts
import { types } from 'react-bricks/frontend'
import website from 'react-bricks-ui/website'
import blog from 'react-bricks-ui/blog'
import HeroUnit from './MyHeroUnit'
import Thumbnail from './Thumbnail'
// React Bricks UI + Custom bricks
const bricks: types.Brick<any>[] = [...website, ...blog, HeroUnit, Thumbnail]
export default bricks

Let's test our brand new brick. Open the Admin interface and try to add a new block clicking on the "+" below a selected block.

In the right sidebar you should "Thumbnail" as the last block type. If you click on it, a new Thumbnail block will appear in the page.

New Thumbnail brick added

Nothing special so far. You see that you can't edit the text visually yet.

In the next step we'll add some magic! ✨

Time to get points

A brick is a component with a `schema` static property. The schema should contain at least:

Subscribe to our newsletter!

Be the first to discover our latest news. No spam, promise.