Skip to content

index.mdx

Latest commit

 

History

History
76 lines (52 loc) · 2.15 KB

index.mdx

File metadata and controls

76 lines (52 loc) · 2.15 KB
Raw
title Sui dApp Kit
description Build Sui apps with framework-agnostic core and React bindings.
keywords
dApp Kit
Sui SDK
React
wallet connection
TypeScript
blockchain
web components
**Migrating from @mysten/dapp-kit?** If you're currently using the legacy `@mysten/dapp-kit` package, check out our [Migration Guide](/sui/migrations/sui-2.0/dapp-kit) to upgrade to the new packages with gRPC and GraphQL support.

The Sui dApp Kit provides tools and components for building decentralized applications on the Sui network. The SDK consists of two packages that work together:

Packages

@mysten/dapp-kit-core

Framework-agnostic core that works with vanilla JS, React, Vue, or any framework:

  • Action-based API for direct wallet operations
  • Web Components for universal UI elements
  • Automatic state management with nanostores
  • Smaller bundle size and improved performance

@mysten/dapp-kit-react

React bindings for the core package:

  • React hooks for state and actions
  • React component wrappers for Web Components
  • Seamless integration with React applications

Install

Choose the installation method based on your framework:

For React applications

npm i @mysten/dapp-kit-react @mysten/sui

Vanilla JavaScript and other frameworks

npm i @mysten/dapp-kit-core @mysten/sui

Getting started

Check the framework-specific guides:

Legacy package

@mysten/dapp-kit (Legacy)

See the Legacy dApp Kit documentation.

The original React-focused version of the dApp Kit. This package provides:

  • React hooks for wallet connection and blockchain queries
  • Pre-built UI components with Radix UI
  • Integration with TanStack React Query
  • Comprehensive wallet state management
**Deprecated JSON RPC Only**: This legacy package only works with the deprecated JSON RPC API and will not be updated to support gRPC or GraphQL. All new projects should use `@mysten/dapp-kit-core` and `@mysten/dapp-kit-react`.