|
| 1 | +--- |
| 2 | +id: sygma-props |
| 3 | +slug: /sygma-widget/props |
| 4 | +title: Properties |
| 5 | +description: The following section provides details on utilizing widget properties |
| 6 | +sidebar_position: 5 |
| 7 | +--- |
| 8 | + |
| 9 | +# Widget Properties |
| 10 | + |
| 11 | +The behaviour of the Sygma Widget can be customized using configurable properties (props). A complete reference of the properties can be found under [packages/widget/src/widget.ts](https://github.com/sygmaprotocol/sygma-widget/blob/main/packages/widget/src/widget.ts). |
| 12 | + |
| 13 | +:::info |
| 14 | +Note that some properties require installing additional dependencies. |
| 15 | +::: |
| 16 | + |
| 17 | +The currently available properties are: |
| 18 | +- **environment** |
| 19 | + - Desc: Determines whether the widget operates on the live network (mainnet) or a testing environment (testnet). |
| 20 | + - Usage: |
| 21 | + 1. Install `@polkadot/types` dependency: `yarn add -D @polkadot/types` |
| 22 | + 2. Configure either MAINNET or TESTNET environment inside the SygmaProtocolReactWidget: `<SygmaProtocolReactWidget environment={Environment.MAINNET} />` |
| 23 | +- **whitelistedSourceNetworks** |
| 24 | + - Desc: Specifies which blockchain networks can be selected as the source for transactions. |
| 25 | + - Usage: `<SygmaProtocolReactWidget whitelistedSourceNetworks={["sepolia"]} />` |
| 26 | +- **whitelistedDestinationNetworks** |
| 27 | + - Desc: Specifies which blockchain networks can be selected as the destination for transactions. |
| 28 | + - Usage: `<SygmaProtocolReactWidget whitelistedDestinationNetworks={["cronos"]} />` |
| 29 | +- **whitelistedSourceResources** |
| 30 | + - Desc: Defines which assets or resources (e.g., tokens) can be selected for transaction. |
| 31 | + - Usage: `<SygmaProtocolReactWidget whitelistedSourceResources={["resourceID1", "resourceID2"]} />` |
| 32 | +- **substrateProviders** |
| 33 | + - Desc: Specifies the API endpoints or connection details for Substrate-based blockchain networks. |
| 34 | + - Usage: |
| 35 | + 1. Install `@polkadot/api` dependency: `yarn add @polkadot/api` |
| 36 | + 2. Add import statements to the top of the app: `import { ApiPromise, WsProvider } from '@polkadot/api';` |
| 37 | + 3. Setup a `setState` action: `const [substrateProviders, setSubstrateProviders] = useState<ApiPromise[]>([]);` |
| 38 | + 4. Initialize the Substrate provider: |
| 39 | + ```ts |
| 40 | + useEffect(() => { |
| 41 | + const provider = new WsProvider('[YOUR_SUBSTRATE_WSS_PROVIDER_HERE]'); |
| 42 | + const api = new ApiPromise({ provider }); |
| 43 | + api.isReady.then(() => { |
| 44 | + console.log('API is ready'); |
| 45 | + setSubstrateProviders([api]); |
| 46 | + }); |
| 47 | + }, []); |
| 48 | + ``` |
| 49 | + 5. Pass the provider into the component: |
| 50 | + ```ts |
| 51 | + <SygmaProtocolReactWidget |
| 52 | + substrateProviders={substrateProviders} |
| 53 | + /> |
| 54 | + ``` |
| 55 | + |
| 56 | +## Using Props In An Example |
| 57 | + |
| 58 | +Below you will find an example of props being passed to whitelist (i.e enable) the source and destination networks in the React component: |
| 59 | + |
| 60 | +```ts |
| 61 | +// App.tsx |
| 62 | +import React from "react"; |
| 63 | +import { SygmaProtocolReactWidget } from "@buildwithsygma/sygmaprotocol-react-widget"; |
| 64 | +import { Environment } from '@buildwithsygma/sygma-sdk-core'; |
| 65 | +
|
| 66 | +function MyDapp() { |
| 67 | + const [count, setCount] = useState(0); |
| 68 | +
|
| 69 | + return ( |
| 70 | + <SygmaProtocolReactWidget |
| 71 | + whitelistedSourceNetworks={["sepolia"]} |
| 72 | + whitelistedDestinationNetworks={["cronos"]} |
| 73 | + /> |
| 74 | + ); |
| 75 | +} |
| 76 | +``` |
0 commit comments