Skip to content

Commit ed36de3

Browse files
committed
renamed widget to plugin
1 parent ffb99c1 commit ed36de3

File tree

5 files changed

+26
-26
lines changed

5 files changed

+26
-26
lines changed

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,54 @@
11
<p align="center" style="align: center">
2-
<h1 align="center">Socket Widget</h1>
2+
<h1 align="center">Socket Plugin</h1>
33
<p align="center">Seamless bridging experience into a single fully customizable React Component</p>
44
<p align="center" style="align: center;">
5-
<a href="https://www.npmjs.com/package/@socket.tech/widget">
6-
<img src="https://img.shields.io/npm/v/@socket.tech/widget" alt="npm version"/>
5+
<a href="https://www.npmjs.com/package/@socket.tech/plugin">
6+
<img src="https://img.shields.io/npm/v/@socket.tech/plugin" alt="npm version"/>
77
</a>
8-
<a href="https://npmtrends.com/@socket.tech/widget">
9-
<img src="https://img.shields.io/npm/dm/@socket.tech/widget" alt="Downloads" />
8+
<a href="https://npmtrends.com/@socket.tech/plugin">
9+
<img src="https://img.shields.io/npm/dm/@socket.tech/plugin" alt="Downloads" />
1010
</a>
11-
<a href="https://github.com/SocketDotTech/widget/stargazers">
12-
<img src="https://img.shields.io/github/stars/SocketDotTech/widget" alt="Github Stars" />
11+
<a href="https://github.com/SocketDotTech/plugin/stargazers">
12+
<img src="https://img.shields.io/github/stars/SocketDotTech/plugin" alt="Github Stars" />
1313
</a>
14-
<a href="https://github.com/SocketDotTech/widget/blob/main/license">
15-
<img src="https://img.shields.io/github/license/SocketDotTech/widget" alt="License">
14+
<a href="https://github.com/SocketDotTech/plugin/blob/main/license">
15+
<img src="https://img.shields.io/github/license/SocketDotTech/plugin" alt="License">
1616
</a>
1717
</p>
1818
</p>
1919

20-
Socket’s Widget is a React component that can be easily imported in any React (JS/TS) project. The widget supports most features from [Bungee.exchange](https://bungee.exchange/). It brings the seamless bridging UX from Bungee to any DApp!
20+
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!
2121

2222
![Themes](https://user-images.githubusercontent.com/20141508/180805890-208eacd4-e841-4294-9a7f-65aa8e249a0c.png)
2323

24-
The widget 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 widget’s color scheme, pre-select the chains/tokens & also customize token lists.
24+
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.
2525

26-
The full documentation for the widget can be found [here](https://www.notion.so/Socket-Widget-Docs-b905871870e343c6833169ebbd356790)
26+
The full documentation for the plugin can be found [here](https://www.notion.so/Socket-Widget-Docs-b905871870e343c6833169ebbd356790)
2727

2828
## Installation
2929

30-
The widget can be installed via NPM or Yarn.
30+
The plugin can be installed via NPM or Yarn.
3131

3232
**NPM :**
3333

3434
```bash
35-
npm install @socket.tech/widget
35+
npm install @socket.tech/plugin
3636
```
3737

3838
**Yarn :**
3939

4040
```bash
41-
yarn add @socket.tech/widget
41+
yarn add @socket.tech/plugin
4242
```
4343

44-
**Note :** The widget requires `react` (>=17.0.1) and `react-dom` (>=17.0.1) as peerDepencies.
44+
**Note :** The plugin requires `react` (>=17.0.1) and `react-dom` (>=17.0.1) as peerDepencies.
4545

4646
## Initialization
4747

4848
Copy the snippet below to get started! Pass the `API_KEY` from a .env file and `Provider` from user’s connected wallet.
4949

5050
```tsx
51-
import { Bridge } from "@socket.tech/widget";
51+
import { Bridge } from "@socket.tech/plugin";
5252
import { Provider } from "./providerComponent"
5353

5454
function SocketBridge() {
@@ -63,7 +63,7 @@ function SocketBridge() {
6363
export default SocketBridge;
6464
```
6565

66-
That’s it! You’ve successfully plugged your DApp into Socket! 🔌  For further customising the widget, check the widget [docs](https://www.notion.so/Socket-Widget-Docs-b905871870e343c6833169ebbd356790).
66+
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).
6767

6868
## Documentation
6969

package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
{
2-
"name": "@socket.tech/widget",
3-
"version": "0.2.4",
2+
"name": "@socket.tech/plugin",
3+
"version": "1.0.0",
44
"main": "dist/index.js",
55
"module": "dist/index.es.js",
66
"types": "dist/index.d.ts",
7-
"repository": "https://github.com/SocketDotTech/widget",
7+
"repository": "https://github.com/SocketDotTech/plugin",
88
"license": "MIT",
99
"keywords": [
1010
"library",

src/components/TxModal/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ export const TxModal = ({
162162
}
163163
}
164164

165-
// Function that lets the user continue the route from the previous transaction when he reopens the widget.
165+
// Function that lets the user continue the route from the previous transaction when he reopens the plugin.
166166
async function continueRoute(txHash?: string, _activeRouteId?: number) {
167167
setInitiating(true);
168168
// in normal flow, txType and activeRouteId will be passed.

src/hooks/useCustomSettings.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,8 @@ export const useCustomSettings = (props: WidgetProps) => {
4848
dispatch(setExludeBridges(excludeBridges));
4949
dispatch(setSingleTxOnly(singleTxOnly));
5050

51-
// if singleTxOnly is set to true in the widget config,
52-
// additionally set the in-widget singleTxOnly value to true
51+
// if singleTxOnly is set to true in the plugin config,
52+
// additionally set the in-plugin singleTxOnly value to true
5353
if (singleTxOnly) {
5454
dispatch(setSingleTxOnlyFromUser(singleTxOnly));
5555
localStorage.setItem("singleTxOnly", singleTxOnly ? "true" : "false");

src/types/index.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,10 +100,10 @@ export interface WidgetProps {
100100
}
101101

102102
export interface Customize {
103-
// Width of the widget
103+
// Width of the plugin
104104
width?: number;
105105

106-
// To make the widget responsive to the parent element.
106+
// To make the plugin responsive to the parent element.
107107
responsiveWidth?: boolean;
108108

109109
// Border radius [0-1]

0 commit comments

Comments
 (0)