Skip to content

Latest commit

 

History

History
46 lines (29 loc) · 1.64 KB

README.md

File metadata and controls

46 lines (29 loc) · 1.64 KB

react-bifrost

A React library that bridges multiple frameworks/events inside the same app.

NPM JavaScript Style Guide

Logo

Install

yarn install --save dm-react-bifrost

Introduction

React Bifrost is a React library that acts as a bridge between two frameworks running inside the same web app. It was specially developed because I wanted to use React to develop the UI for my game, Epoch Rift.

React Bifrost uses the term 'realms' to refer to scenes which usually are composed of multiple React components. Each realm should can be opened or closed depending on what your needs.

Bifrost is built using Recoil for state management with an atomic model.

Usage

Initialize Bifrost in your React application by doing this on your entry point.

To setup Bifrost you simply need to render the Bifrost container in your React application.

import {BifrostContainer} from 'dm-react-bifrost';

const App = () => {
  return <BifrostContainer config={config} />;
};

Documentation

Head over to our Documentation Page to learn more about Bifrost.

Projects

Let me know if you want to feature your project in here

License

MIT © davidsmorais