Skip to content

Commit

Permalink
chore: add metadata option
Browse files Browse the repository at this point in the history
  • Loading branch information
enesozturk committed Oct 23, 2024
1 parent a3e6a22 commit 37b7cfc
Showing 1 changed file with 26 additions and 5 deletions.
31 changes: 26 additions & 5 deletions docs/appkit/shared/options.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,24 @@ createAppKit({

For custom networks, refer to this [doc page](/appkit/react/core/custom-networks).

## metadata

You can set the metadata for your AppKit. We are using `name`, `description`, `icons`, and `url` at certain places like the wallet connection, sign message, etc screens. If not provided, we will use the metadata of your website's document object.

```ts
createAppKit({
// ...
metadata: {
name: 'My App',
description: 'My App Description',
icons: ['https://myapp.com/icon.png'],
url: 'https://myapp.com'
}
})
```

For custom networks, refer to this [doc page](/appkit/react/core/custom-networks).

## defaultNetwork

You can set a desired network for the initial connection as default:
Expand Down Expand Up @@ -224,8 +242,11 @@ createAppKit({
privacyPolicyUrl: 'https://www.myprivacypolicy.com'
})
```

## features

This allows you to toggle (enable or disable) additional features provided by AppKit. Features such as analytics, email and social logins, On-ramp, swaps, etc., can be enabled using this parameter.

### analytics

Enable analytics to get more insights on your users activity within your [Reown Cloud's dashboard](https://cloud.reown.com)
Expand All @@ -234,10 +255,11 @@ Enable analytics to get more insights on your users activity within your [Reown
createAppKit({
//...
features: {
analytics: true,
analytics: true
}
})
```

<Button name="Learn More" url="/cloud/analytics" />

### swaps
Expand All @@ -248,7 +270,7 @@ Enable or disable the swap feature in your AppKit. [Swaps](/appkit/react/transac
createAppKit({
//...
features: {
swaps: true,
swaps: true
}
})
```
Expand All @@ -261,12 +283,11 @@ Enable or disable the onramp feature in your AppKit. [Onramp](/appkit/react/tran
createAppKit({
//...
features: {
onramp: true,
onramp: true
}
})
```


## customWallets

Add custom wallets to the modal. `CustomWallets` is an array of objects, where each object contains specific information of a custom wallet.
Expand Down Expand Up @@ -418,7 +439,7 @@ const adapter = new WagmiAdapter({
preference: 'smartWalletOnly'
/* highlight-add-end */
}),
projectId,
projectId,
networks
]
})
Expand Down

0 comments on commit 37b7cfc

Please sign in to comment.