Skip to main content



This section describes how to obtain HALO identity in react.

Logging in

The user's identity can be obtained by a react application with the useIdentity hook:

import React from 'react';
import { useIdentity } from '@dxos/react-client/halo';

export const MyComponent = () => {
  const identity = useIdentity();
  return <>{/* ... */}</>;

The object returned is of type Identity.

By default useIdentity will tell HALO to log the user in using the HALO vault. The vault shell may open to allow the user to create an identity.


When first creating an identity, the useIdentity hook will fire twice. Once with null, and then again with an identity when one has been established.

Once identity is established, a space must be created or joined in order to manipulate data.