Skip to content

@swapped/connect-sdk / react / UseExchangePayCurrencyResult

Type Alias: UseExchangePayCurrencyResult

UseExchangePayCurrencyResult = object

Defined in: src/react/exchange-pay/hooks/useExchangePayCurrency.ts:7

Result of useExchangePayCurrency.

Properties

clearCurrency

clearCurrency: () => void

Defined in: src/react/exchange-pay/hooks/useExchangePayCurrency.ts:18

Clear the selected currency.

Returns

void


isCurrencySelected

isCurrencySelected: (currency) => boolean

Defined in: src/react/exchange-pay/hooks/useExchangePayCurrency.ts:20

Whether the given currency is the current selection.

Parameters

currency

ExchangePaySupportedCurrency

Returns

boolean


selectCurrency

selectCurrency: (currency) => void

Defined in: src/react/exchange-pay/hooks/useExchangePayCurrency.ts:16

Select a receive currency from the supported list.

Parameters

currency

ExchangePaySupportedCurrency

Returns

void


selectedCurrency

selectedCurrency: ExchangePaySupportedCurrency | undefined

Defined in: src/react/exchange-pay/hooks/useExchangePayCurrency.ts:9

Currently selected receive currency, or undefined when none.


selectedCurrencyKey

selectedCurrencyKey: string | undefined

Defined in: src/react/exchange-pay/hooks/useExchangePayCurrency.ts:14

Stable string key for the selected currency (for <select> / list values). Prefer selectedCurrency for display and business logic.