@ape.swap/bonds-sdk 3.0.12 → 3.0.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +10 -9
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -80,15 +80,16 @@ export default MyBondsComponent
|
|
|
80
80
|
|
|
81
81
|
## Configuration
|
|
82
82
|
|
|
83
|
-
The core of the SDK lies in its
|
|
84
|
-
|
|
85
|
-
| Property | Type | Description
|
|
86
|
-
|
|
87
|
-
| `referenceId` | `string` | A unique identifier for the bonds, shall be provided by ApeBond team.
|
|
88
|
-
| `chains` | `Array` | An array of supported chain IDs (e.g., `56`, `1`, `137`, etc). It also determines the order of the chains on the bond list.
|
|
89
|
-
| `useRainbowKit` | `boolean` | Whether to enable RainbowKit for wallet connections. Might be replaced for an enum in the near future.
|
|
90
|
-
| `useHotBonds` | `boolean` | Whether to show the "hot bonds" component.
|
|
91
|
-
| `theme` | `Object (optional)` | This is how you can customize the styles of the SDK. Override styles like colors, typography, and layout settings to match your project's branding
|
|
83
|
+
The core of the SDK lies in its config object params, passed as a prop to its components. Below is a breakdown of key options:
|
|
84
|
+
|
|
85
|
+
| Property | Type | Description |
|
|
86
|
+
|-----------------|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
87
|
+
| `referenceId` | `string` | A unique identifier for the bonds, shall be provided by ApeBond team. |
|
|
88
|
+
| `chains` | `Array` | An array of supported chain IDs (e.g., `56`, `1`, `137`, etc). It also determines the order of the chains on the bond list. |
|
|
89
|
+
| `useRainbowKit` | `boolean` | Whether to enable RainbowKit for wallet connections. Might be replaced for an enum in the near future. |
|
|
90
|
+
| `useHotBonds` | `boolean` | Whether to show the "hot bonds" component. |
|
|
91
|
+
| `theme` | `Object (optional)` | This is how you can customize the styles of the SDK. Override styles like colors, typography, and layout settings to match your project's branding. |
|
|
92
|
+
| `tokenSymbol` | `string[]` | This parameter is specific to the `<SingleBond />` component. It defines the token(s) to display in the UI. Currently, only a single token (one element in the array) is supported.|
|
|
92
93
|
|
|
93
94
|
### Chain Support
|
|
94
95
|
|