Skip to content

EasyBrizy/Brizy

Repository files navigation

Brizy Web Builder

Brizy is embeddable and White Label ready, so it can be seamlessly integrated in your existing products, ensuring optimal user experience. Being installed on-premise, with complete client control, our solution ensures that all GDPR, ISO, data security requirements are 100% met. Perfect for SaaS businesses that need a web-content builder on their own infrastructure.

BH.mp4

See Brizy in action

Products

Integrations

Recipes

Deployments

Enterprise

How Brizy works

Builder seamlessly integrates with your existing site or app, enabling you to visually create and modify code using your current components or our intuitive drag-and-drop editor. You can then export the code or directly publish updates.

Read about how Brizy works

Documentation

The official Brizy documentation can be found on our documentation website

The release notes can be found here.

Quick Start

Install the package via npm:

npm install @brizy/builder

Available Components

1. Preview Component

The Preview component allows you to render content in preview mode without editor modules such as the toolbar or sidebar.

Example Usage

import type { EditorPage, EditorProject } from "@brizy/builder/preview";
import { Preview } from "@brizy/builder/preview";

// @import css
import "@brizy/builder/preview/styles.css";

const pageData: EditorPage = {}
const projectData: EditorProject = {};

const App: React.FC = () => {
  return (
    <div>
      <h1>Preview Mode</h1>
      <Preview pageData={pageData} projectData={projectData} />
    </div>
  );
};

export default App;

2. Editor Mode with Toolbar and Sidebar

The Editor component provides a fully interactive editor mode, equipped with both a toolbar and sidebar to enhance editing functionality. This component is essential for creating and managing content within a structured, user-friendly interface.

Example Usage

import React from "react";
import { Editor as BrizyEditor } from "@brizy/builder/editor";
import type { EditorConfig, EditorPage, EditorProject } from "@brizy/builder";

// @import css
import "@brizy/builder/editor/styles.css";

// @import icons
import brizyIcons from "@brizy/builder/editor/icons.svg";

const config: EditorConfig = {
  urls: {
    editorIcons: brizyIcons
  }
};

const pageData: EditorPage = {}
const projectData: EditorProject = {};

const Editor: React.FC = () => {
  return <BrizyEditor pageData={pageData} projectData={projectData} config={config} />;
};

export default Editor;

Note: The Config object contains settings for the editor. You can find more details about Config in the Brizy Builder Documentation.

Features

  • Preview Mode: Render content for viewing purposes without editing features.
  • Editor Mode: Fully interactive editor with a customizable toolbar and sidebar.

Recipes

Use some of the recipes

  • next: Next.js 13 app example, using App Router and static page generation
  • remix: Remix Run v2 app example, using dynamic routes at root-level

Bring your own React components

You can register your own arbitrary custom React components for use as building blocks within Brizy.

Learn more about code components.

Support

If you have problems or questions go to our forum, we will then try to help you asap:

https://support.Brizy.io

Development Setup

Have you found a bug 🐛 or perhaps you have a fantastic feature ✨ to contribute? The CONTRIBUTING guide will help you get your development environment up and running in minutes.

License

Proprietary licenses are available for enterprise customers. Get in touch

Additional information about the license model can be found in the docs.

About

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors