nova-react-bridge

Nova Bridge for React

Usage no npm install needed!

<script type="module">
  import novaReactBridge from 'https://cdn.skypack.dev/nova-react-bridge';
</script>

README

Nova React Bridge

This package contains a React component named Nova that renders a placeholder also known as Nova Directive

Rendered placeholder:

<div data-hypernova-key="NavBar" data-hypernova-id="d0a0b082-dad0-4bf2-ae4f-08eff16575b4"></div>
<script type="application/json" data-hypernova-key="NavBar" data-hypernova-id="d0a0b082-dad0-4bf2-ae4f-08eff16575b4"><!--{"brand":"Ara Framework","links":[{"url":"https://github.com/ara-framework","text":"Github"}]}--></script>

On Client-Side Rendering the placeholder is where the component is going to be mounted or hydrated depending on the framework or library.

On Server-Side Rendering the placeholder is used by Nova Proxy or Nova Static to Server-Side Include the HTML rendered by Hypernova.

Install

npm install nova-react-bridge

Usage

The Nova component requires the props name and data

  • name is the registered view in Hypernova.
  • data is the data necessary to render the view.
import { Nova } from 'nova-react-bridge'

const Page = () => (
  <div>
    <Nova 
      name="NavBar"
      data={{ brand: 'Ara Framework', links: [{ url: 'https://github.com/ara-framework', text: "Github" }]}}
    />
  </div>
)

Mounting Hypernova Client Component

The Nova component emits a custom event called NovaMount on the document when the React component is mounted. The event needs to be listened by the Hypernova's client script in order to mount the view when the placeholder is ready.

import { renderClient } from 'hypernova-redom'

document.addEventListener('NovaMount', (event) => {
  const { detail: { name, id } } = event
  if (name === 'NavBar') {
    return renderClient(name, NavBar, id)
  }
})

The example above is using the method renderClient from hypernova-redom, this method should be available for the other supported bindings.