@portal-hq/web v3.4.1

Portal Web SDK

Welcome to the @portal-hq/web SDK, the official TypeScript library for integrating Portal's features into your web applications. This package enables you to seamlessly incorporate embedded MPC wallets.

Features

• Portal Class Constructor: Initialize the Portal instance in your application.
• PortalContext Provider: Expose the Portal instance to your React component tree.
• usePortal Hook: Consume the Portal instance within your child components for easy access and interaction.
• Types and Enums: Utilize helper types and enums for efficient development with the Portal SDK.

Documentation

For a comprehensive guide and API reference, please visit our documentation portal.

Quick Start

Prerequisites

• Node.js and npm or yarn installed.
• Basic knowledge of TypeScript and React.
• Access to a Portal Account.

Installation

Install the SDK package using npm or yarn:

npm install @portal-hq/web
# or
yarn add @portal-hq/web

Support

For issues or questions please reach out to our support team at support@portalhq.io.