Skip to content

API ReferenceReact componentsInterface

LOCListViewProps

Beta

Props for the LOCListView component.

Properties

address

address: `0x${string}` | undefined;

The user’s wallet address.


balances?

optional balances?: CollateralTokenBalance[];

Array of collateral token balances.


balancesLoading?

optional balancesLoading?: boolean;

Flag indicating whether balance data is currently loading.


className?

optional className?: string;

Optional additional class names for styling purposes. LOCListViewProps


errorMessage?

optional errorMessage?: string;

Beta

Workflow failure message controlled by the host. Clear it to hide the banner.


loadErrorMessage?

optional loadErrorMessage?: string;

Beta

Ambient failure from the LOC-list reads.


locsLoading

locsLoading: boolean;

Flag indicating whether LOC data is currently loading.


onClearError?

optional onClearError?: () => void;

Beta

Requests that the host clear errorMessage; omitting it leaves the message visible.

Returns

void


onCreateLOC?

optional onCreateLOC?: () => void;

Called when the create-LOC action is used.

Returns

void


onRetryLoad?

optional onRetryLoad?: () => void;

Beta

Retries the reads that populate the LOC list.

Returns

void


onSelectLOC?

optional onSelectLOC?: (loc) => void;

Called with the LOC whose row was clicked.

Parameters

ParameterType
locOutstandingLetterOfCredit

Returns

void


onWorkflowPrepared?

optional onWorkflowPrepared?: (prepared) => void;

Called when the withdraw action has prepared a workflow for the host flow to execute.

Parameters

ParameterType
preparedPreparedWorkflowHandoff

Returns

void


outstandingLocs

outstandingLocs: OutstandingLetterOfCredit[];

List of outstanding Letters of Credit (LOCs).


showBalances?

optional showBalances?: boolean;

Optional flag to show or hide the balances section.


showCreateLOC?

optional showCreateLOC?: boolean;

Optional flag to show or hide the “Create LOC” button.


title?

optional title?: string;

Beta