Skip to main content

@rise-tools/react

Rise Tools can be described with 3 core primitives:

The base <Rise /> components requires:

  • Component Library of UI that can be rendered
  • Model Source where your client will load+subscribe to data

Rise Component​

First, install @rise-tools/react

import { Rise } from '@rise-tools/react'

// then, render it in your app:

<Rise
  components={myComponents}
  modelSource={modelSource}
/>

Props​

The Template component accepts the following props:

components​

The component library object, with all the component that the data can request to be displayed.

components={{
  Button: {
    component: Button, // the react component that will be rendered
    validator: () => {} // validate props
  }
}}

modelSource​

The data client that will define the views for rendering. Usually this will be a connection to your server.

onEvent​

To handle events that come from your rendered components

actions​

The action library object, with all the actions that can be called by your server-defined components

actions={{
  makeNoise: {
    handler: () => {
      // make the noise
    },
    validate: () => {} // validate the action
  }
}}

path​

Specify the path within the model to render. Useful if you share one modelSource with several <Rise> components