@xmtp/react-sdk
Advanced tools
This package provides the XMTP client SDK for React.
To keep up with the latest SDK developments, see the Issues tab in this repo.
To learn more about XMTP and get answers to frequently asked questions, see the XMTP documentation.
These hooks are mostly bindings to the xmtp-js SDK that expose the underlying data in a React way.
The XMTP React SDK requires React, the XMTP JS SDK, and several content types.
NPM
npm install react @xmtp/react-sdk @xmtp/xmtp-js @xmtp/content-type-reaction @xmtp/content-type-remote-attachment @xmtp/content-type-reply
PNPM
pnpm install react @xmtp/react-sdk @xmtp/xmtp-js @xmtp/content-type-reaction @xmtp/content-type-remote-attachment @xmtp/content-type-reply
Yarn
yarn add react @xmtp/react-sdk @xmtp/xmtp-js @xmtp/content-type-reaction @xmtp/content-type-remote-attachment @xmtp/content-type-reply
If you run into issues with Buffer and polyfills, see this solution.
If you see a lot of warnings related to source maps, see this issue to learn more.
Access the XMTP React SDK reference documentation.
This client SDK uses a local-first architecture to help you build a production-grade and performant app. To learn more about how we use a local-first architecture, see our official documentation.
Check out our official documentation to get started developing with XMTP and React.
XMTP provides production, dev, and local network environments to support the development phases of your project. To learn more about these environments, see our official documentation.
Important
When you create a client, it connects to the XMTPdevenvironment by default. To learn how to use theenvparameter to set your client's network environment, see Configure the client.
Because this SDK is in active development, you should expect breaking revisions that might require you to adopt the latest SDK 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 the SDK will eventually be deprecated, which means:
The following table provides the deprecation schedule.
| Announced | Effective | Minimum Version | Rationale |
|---|---|---|---|
| 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.
Run yarn dev to build the SDK and watch for changes, which will trigger a rebuild.
yarn build: Builds the SDKyarn clean: Removes node_modules, lib, and .turbo foldersyarn dev: Builds the SDK and watches for changes, which will trigger a rebuildyarn format: Runs prettier format and write changesyarn format:check: Runs prettier format checkyarn lint: Runs ESLintyarn test: Runs all unit testsyarn typecheck: Runs tscFAQs
XMTP client SDK for React apps written in TypeScript
The npm package @xmtp/react-sdk receives a total of 528 weekly downloads. As such, @xmtp/react-sdk popularity was classified as not popular.
We found that @xmtp/react-sdk demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Vite releases Rolldown-Vite, a Rust-based bundler preview offering faster builds and lower memory usage as a drop-in replacement for Vite.
Research
Security News
A malicious npm typosquat uses remote commands to silently delete entire project directories after a single mistyped install.
Research
Security News
Malicious PyPI package semantic-types steals Solana private keys via transitive dependency installs using monkey patching and blockchain exfiltration.