Custom Labels

All user-facing text in the depositOS widget can be customized using the customLabels configuration property. This lets you tailor the widget's language to match your application's terminology, localize strings, or adjust descriptions for your audience.

Available Labels

| Property | Default | Description | |---|---|---| | headerTitle | "Get {token}" | Main header text. Use {token} as a placeholder for the destination token symbol. | | walletTitle | "Wallet" | Title on the wallet funding option card | | walletDescription | "Connect your wallet and use any token" | Description on the wallet funding option card | | privateTitle | "Private Deposit" | Title on the private deposit option card | | privateDescription | "Enhanced privacy • No wallet required" | Description on the private deposit option card | | footerBranding | "depositOS" | Branding text displayed in the widget footer | | depositButtonText | "Deposit Now" | Text on the main action button |

Example

const config: DepositOSConfig = {
  destChain: 42161,
  destToken: "0xaf88d065e77c8cC2239327C5EDb3A432268e5831",
  destAddress: "0xYourAddress",
  apiKey: "dos_live_…",
  customLabels: {
    headerTitle: "Fund Your Account",
    walletTitle: "Pay with Wallet",
    walletDescription: "Connect any EVM wallet and pay with your tokens",
    privateTitle: "Anonymous Deposit",
    privateDescription: "No wallet connection, enhanced privacy",
    footerBranding: "Powered by MyApp",
    depositButtonText: "Complete Payment",
  },
};

You only need to include the labels you want to override. Any omitted properties will use their default values.

Footer Customization

In addition to customLabels, several configuration properties control the footer area of the widget:

| Property | Type | Default | Description | |---|---|---|---| | hideFooter | boolean | false | Hide the entire footer section | | hideBranding | boolean | false | Hide the branding text (but keep other footer elements) | | hideTerms | boolean | false | Hide the terms of service link | | hideSupport | boolean | false | Hide the support link | | termsUrl | string | "#" | URL for the terms of service link | | supportUrl | string | "#" | URL for the support/help link |

Footer example

const config: DepositOSConfig = {
  // ...
  hideFooter: false,
  hideBranding: false,
  hideTerms: false,
  hideSupport: false,
  termsUrl: "https://yourapp.com/terms",
  supportUrl: "https://yourapp.com/support",
  customLabels: {
    footerBranding: "YourApp",
  },
};

Minimal footer

To show a clean widget with no footer at all:

const config: DepositOSConfig = {
  // ...
  hideFooter: true,
};