Quickstart for XMTP React components
This package provides React components for building React apps with XMTP.
These components are in Developer Preview status and ready for you to start building with.
However, we do not recommend using Developer Preview software in production apps. Software in this status may change based on feedback.
To keep up with the latest component developments, see the Issues tab in the
To learn more about XMTP and get answers to frequently asked questions, see FAQ about XMTP.
These ready-made components can help you quickly build a chat app with XMTP.
- Node 16.10+
- React 16.14+
npm install @xmtp/[email protected]
pnpm install @xmtp/[email protected]
yarn add @xmtp/[email protected]
To use any of the included components, you must also include their styles. To do so, import the styles from the package into your project.
The included styles contain normalizations of elements globally.
yarn dev to build the package and watch for changes, which will trigger a rebuild.
yarn build: Builds the package
yarn clean: Removes
yarn dev: Builds the package and watches for changes, which will trigger a rebuild
yarn format: Runs prettier format and write changes
yarn format:check: Runs prettier format check
yarn lint: Runs ESLint
yarn storybook: Launches Storybook for the React components
yarn test: Runs all unit tests
yarn typecheck: Runs
Because this package is in active development, you should expect breaking revisions that might require you to adopt the latest release to enable your app to continue working as expected.
XMTP communicates about breaking revisions in the XMTP Discord community, providing as much advance notice as possible. Additionally, breaking revisions in a release are described on the Releases page.
Older versions of this package will eventually be deprecated, which means bugs will not be fixed in deprecated versions.
The following table provides the deprecation schedule.
|There are no deprecations scheduled for this SDK at this time.|
Bug reports, feature requests, and PRs are welcome in accordance with these contribution guidelines.