https://github.com/socketdottech/plugin
Seamless bridging experience into a single fully customizable React Component
https://github.com/socketdottech/plugin
library reactjs storybook widget-library
Last synced: about 1 month ago
JSON representation
Seamless bridging experience into a single fully customizable React Component
- Host: GitHub
- URL: https://github.com/socketdottech/plugin
- Owner: SocketDotTech
- License: mit
- Created: 2022-06-24T12:36:14.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-24T11:59:31.000Z (over 1 year ago)
- Last Synced: 2025-10-11T11:11:40.562Z (8 months ago)
- Topics: library, reactjs, storybook, widget-library
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@socket.tech/plugin
- Size: 4.24 MB
- Stars: 41
- Watchers: 10
- Forks: 17
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: license
Awesome Lists containing this project
README
Socket Plugin
Seamless bridging experience into a single fully customizable React Component
Socket Plugin is a React component that can be easily imported in any React (JS/TS) project. The plugin supports most features from [Bungee.exchange](https://bungee.exchange/). It brings the seamless bridging UX from Bungee to any DApp!
The plugin requires `provider` from user’s connected wallet & Socket’s `API_KEY` as props to initialise. [Optional props](https://www.notion.so/Socket-Widget-Docs-b905871870e343c6833169ebbd356790) can be passed to customize the plugin’s color scheme, pre-select the chains/tokens & also customize token lists.
The full documentation for the plugin can be found [here](https://www.notion.so/Socket-Widget-Docs-b905871870e343c6833169ebbd356790)
## Installation
The plugin can be installed via NPM or Yarn.
**NPM :**
```bash
npm install @socket.tech/plugin
```
**Yarn :**
```bash
yarn add @socket.tech/plugin
```
**Note :** The plugin requires `react` (>=17.0.1) and `react-dom` (>=17.0.1) as peerDepencies.
## Initialization
Copy the snippet below to get started! Pass the `API_KEY` from a .env file and `Provider` from user’s connected wallet.
```tsx
import { Bridge } from "@socket.tech/plugin";
import { Provider } from "./providerComponent"
function SocketBridge() {
return (
)
}
export default SocketBridge;
```
That’s it! You’ve successfully plugged your DApp into Socket! 🔌 For further customising the plugin, check the plugin [docs](https://www.notion.so/Socket-Widget-Docs-b905871870e343c6833169ebbd356790).
## Documentation
- [Initialisation](https://www.notion.so/Socket-Widget-Docs-b905871870e343c6833169ebbd356790)
- [Customisation](https://www.notion.so/Socket-Widget-Docs-b905871870e343c6833169ebbd356790)
- [API reference](https://www.notion.so/Socket-Widget-Docs-b905871870e343c6833169ebbd356790)
## Example App
Work In Progress 🛠
## More themes... 😎
