@dxos/react-client
Less than 1 minute
@dxos/react-client
React client API
Installation
pnpm i @dxos/react-client
Usage
The snippet below illustrates a self-contained DXOS application that uses providers to create the client and instantiate a user identity.
import React from 'react';
import { useClient, ClientProvider } from '@dxos/react-client';
import { createRoot } from 'react-dom/client';
const App = () => {
const client = useClient();
const space = useSpaces();
return (
<pre>{JSON.stringify(client.info())}</pre>
);
};
const Root = () => (
<ClientProvider>
<App />
</ClientProvider>
);
createRoot(document.getElementById('root')!)
.render(<Root/>);
Documentation
Storybooks
The HALO Invitation Story demonstrates multiple clients (devices) joining the same HALO. Demo video.
The Space Invitation Story demonstrates multiple clients creating and sharing spaces. Demo video.
DXOS Resources
- Website
- Developer Documentation
- Tag questions on Stack Overflow with
#dxos
- Tag us on twitter
@dxos_org
Contributions
Your ideas, issues, and code are most welcome. Please take a look at our community code of conduct, the issue guide, and the PR contribution guide. If you would like to contribute to the design and implementation of DXOS, please start with the contributor's guide.
License: MIT Copyright 2022 © DXOS