React DOM

Rendering Responses

The createRouterComponent function is used to create the component at the root of a Curi + React application. You can call this component anything that you want, but here it will be referred to as the Router.

createRouterComponent is passed the application's Curi router to create a Router component. The Router will automatically add an observer to the Curi router when it mounts, so that it can re-render when there are new responses.

Along with setting up an observer to react to new responses, the Router sets up contexts for routing values. Theresponse and navigation can be read using the useResponse hook, while the router can be read using the useRouter hook.

import { createRouterComponent, useResponse } from '@curi/react-dom';

import router from "./router";
const Router = createRouterComponent(router);

function App() {
  const {
    response,
    navigation
  } = useResponse();
  const { body:Body } = response;
  return <Body />
}

// router.once() is used to delay rendering in case
// the initially matched route is asynchronous
router.once(() => {
  ReactDOM.render((
    <Router>
      <App />
    </Router>
  ), document.getElementById("root"));
});

What to render

The Router component sets up the application's routing, while its children render the application's content. The Curi router generates response objects from matched locations; those are core for figuring out what to render.

If you use route.respond to set React components as the body properties on your responses, you can create a React element for the body component.

The Body element (it is useful to rename the response's body to Body for JSX transformation) is a placeholder for the "real" component that you render for a route. This means that the "real" component will be different for every route.

While not a strict requirement, it is useful to pass the response object as a prop to the rendered Body component.

function App() {
  const { response } = useResponse();
  const { body:Body } = response;
  return <Body response={response} />
}

ReactDOM.render((
  <Router>
    <header>
      <NavLinks />
    </header>
    <main>
      <App />
    </main>
  </Router>
), document.getElementById("root"));

If your routes use an object to attach multiple components to a response, the children function also provides a good place to split these apart.

const routes = prepareRoutes([
  {
    name: "Home",
    path: "",
    respond() {
      return {
        body: {
          Main: HomeMain,
          Menu: HomeMenu
        }
      }
    }
  },
  // ...
]);

function App() {
  const { response } = useResponse();
  const { Main, Menu } = response.body;
  return (
    <React.Fragment>
      <header>
        <Menu />
      </header>
      <main>
        <Main response={response} />
      </main>
    </React.Fragment>
  );
}

Accessibility

Managing the application's focus when navigating is useful for users who use screen readers. The useNavigationFocus hookprovides a convenient way to focus a page's main content when it renders a new response.

You can read some more about accessibility in the accessibility guide.

import { useResponse, useNavigationFocus } from "@curi/react-dom";

function App()
  const { response } = useResponse();
  const ref = React.createRef(null);
  useNavigationFocus(ref);

  const { body:Body } = response;
  return (
    <React.Fragment>
      <header>
        <NavLinks />
      </header>
      <main ref={ref} tabIndex={-1}>
        <Body response={response} />
      </main>
    </React.Fragment>
  );
}

The Link component is used to navigate between routes within an application. When it renders in the DOM, it will render as an anchor (<a>) element.

The Link's name prop describes which route clicking the link should navigate to. If you pass an invalid route name, Curi will warn you.

If a route has any params (or if any of a route's ancestors have params for nested routes), the params prop is used to pass these to the Link.

import { Link } from "@curi/react-dom";

const NavLinks = () => (
  <nav>
    <ul>
      <li>
        <Link name="Home">Home</Link>
      </li>
      <li>
        <Link name="About">About</Link>
      </li>
      <li>
        <Link name="User" params={{ id: "red" }}>Red</Link>
      </li>
    </ul>
  </nav>
);

The Link also takes hash, query, and state props to attach their values to the location that will be navigated to.

<Link name="Home" hash="details">Home</Link>
// renders
<a href="/#details">Home</a>

Please check out the full @curi/react-dom API documentation to see every component that the package provides.

  1. Rendering Responses
    1. What to render
    2. Accessibility
  2. Navigating