# dm-react-bifrost

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

Latest version **1.2.7** (published 2023-04-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install dm-react-bifrost
pnpm add dm-react-bifrost
yarn add dm-react-bifrost
bun add dm-react-bifrost
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.7 |
| Published | 2023-04-20 |
| First published | 2022-04-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=10 |
| Dependencies | 0 |
| Unpacked size | 7.3 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | davidsmorais |
| Maintainers | dsmorais |

## Links

- npm: https://www.npmjs.com/package/dm-react-bifrost
- Repository: https://github.com/Dark-Magic-Studios/react-bifrost
- Homepage: https://github.com/Dark-Magic-Studios/react-bifrost#readme
- Issues: https://github.com/Dark-Magic-Studios/react-bifrost/issues
- npm.io page: https://npm.io/package/dm-react-bifrost

## Recent versions

- 1.2.7 (latest) — 2023-04-20
- 1.2.6 — 2023-04-20
- 1.2.4 — 2023-04-20
- 1.2.3 — 2023-04-20
- 1.2.2 — 2023-04-20
- 1.2.1 — 2023-04-20
- 1.2.0 — 2023-04-20
- 1.1.9-alpha.2 — 2023-01-21
- 1.1.8-alpha.3 — 2023-01-21
- 1.1.8-alpha.2 — 2022-12-06
- 1.1.8-alpha.1 — 2022-12-06
- 1.1.10-alpha.1 — 2022-12-06
- 1.1.9 — 2022-12-06
- 1.1.8 — 2022-12-06
- 1.1.7 — 2022-08-17
- … 12 more at https://npm.io/package/dm-react-bifrost/versions

## README

# react-bifrost

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

[![NPM](https://img.shields.io/npm/v/dm-react-bifrost.svg)](https://www.npmjs.com/package/dm-react-bifrost) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

![Logo](docs/logo.png)


## Install

```bash
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]( https://epochrift.com/).

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](https://recoiljs.org/) 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.

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

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

## Documentation
Head over to our [Documentation Page](https://hyperdocs.netlify.app/react-bifrost) to learn more about Bifrost.
## Projects

- [Epoch Rift 🟢](https://epochrift.com)
- [Phaser Bifrost Template](https://github.com/Dark-Magic-Studios/phaser-bifrost-vite-template-ts)

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

MIT © [davidsmorais](https://github.com/davidsmorais)

---
_Source: https://npm.io/package/dm-react-bifrost · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
