Skip to content

Commit 0762eac

Browse files
committed
fix JSDocs
1 parent 79ed243 commit 0762eac

File tree

3 files changed

+7
-21
lines changed

3 files changed

+7
-21
lines changed

packages/examples/packages/send-flow/src/components/SendFlow.tsx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ import type { Currency } from '../types';
1515
* The props for the {@link SendFlow} component.
1616
*
1717
* @property accounts - The available accounts.
18+
* @property asset - The selected asset to display.
1819
* @property total - The total cost of the transaction.
1920
* @property useFiat - Whether to use fiat currency.
2021
* @property fees - The fees for the transaction.

packages/examples/packages/send-flow/src/components/SendForm.tsx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,11 @@ import type { SendFormErrors } from '../types';
2121
/**
2222
* The props for the {@link SendForm} component.
2323
*
24-
* @property accounts - The available accounts.
24+
* @property account - The selected account.
25+
* @property asset - The selected asset to display.
26+
* @property useFiat - Whether to use fiat currency.
27+
* @property fiatCurrency - The fiat currency to use.
2528
* @property errors - The form errors.
26-
* @property selectedCurrency - The selected currency to display.
2729
* @property displayAvatar - Whether to display the avatar of the address.
2830
*/
2931
export type SendFormProps = {

packages/examples/packages/send-flow/src/types.ts

Lines changed: 2 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,12 @@ import type {
1010
* @property asset - The selected asset.
1111
* @property to - The receiving address.
1212
* @property amount - The amount to send.
13-
* @property accountSelector - The selected account.
1413
*/
1514
export type SendFormState = {
1615
account: AccountSelectorState;
1716
asset: AssetSelectorState;
1817
to: string;
1918
amount: string;
20-
accountSelector: string;
2119
};
2220

2321
/**
@@ -40,21 +38,6 @@ export type SendFormErrors = {
4038
amount?: string;
4139
};
4240

43-
/**
44-
* An Account of the send flow interface.
45-
*
46-
* @property name - The name of the account.
47-
* @property address - The address of the account.
48-
* @property balance - The balance of the account.
49-
* @property icon - The icon of the account.
50-
*/
51-
export type Account = {
52-
name: string;
53-
address: string;
54-
balance: Currency;
55-
icon: string;
56-
};
57-
5841
/**
5942
* A currency value.
6043
*
@@ -69,9 +52,9 @@ export type Currency = {
6952
/**
7053
* The context of the send flow interface.
7154
*
72-
* @property accounts - The available accounts.
73-
* @property selectedCurrency - The selected currency.
55+
* @property useFiat - Whether to use fiat currency.
7456
* @property fees - The fees for the transaction.
57+
* @property fiatCurrency - The fiat currency to use.
7558
*/
7659
export type SendFlowContext = {
7760
useFiat: boolean;

0 commit comments

Comments
 (0)