@kodiak-finance/orderly-sdk-docs 1.0.2

package/bundled/docs-md/components/component._kodiak-finance_orderly-ui-transfer.packages_ui-transfer_src_components_swap_swapDepositForm_swapDepositForm.ui.tsx.SwapDepositForm.md

@@ -0,0 +1,65 @@
+---
+kind: component-doc
+id: component._kodiak-finance_orderly-ui-transfer.packages_ui-transfer_src_components_swap_swapDepositForm_swapDepositForm.ui.tsx.SwapDepositForm
+packages: ["@kodiak-finance/orderly-ui-transfer"]
+---
+
+# SwapDepositForm
+
+**Package:** `@kodiak-finance/orderly-ui-transfer`  
+**Source:** `packages/ui-transfer/src/components/swap/swapDepositForm/swapDepositForm.ui.tsx`
+
+> Auto-generated stub from `components.json`. Add or override with a curated file under `apps/ai-docs/components/` using the same `id:` in frontmatter.
+
+## Description
+
+SwapDepositForm is exported from `@kodiak-finance/orderly-ui-transfer` and sourced at `packages/ui-transfer/src/components/swap/swapDepositForm/swapDepositForm.ui.tsx`.
+
+## Props
+
+| Prop | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| `token` | TokenInfo \| undefined | yes | — | — |
+| `tokens` | TokenInfo[] | yes | — | — |
+| `onTokenChange` | Dispatch<SetStateAction<TokenInfo \| undefined>> | yes | — | — |
+| `amount` | number | yes | — | — |
+| `quantity` | string | yes | — | — |
+| `maxQuantity` | string | yes | — | — |
+| `swapQuantity` | string | yes | — | — |
+| `onQuantityChange` | Dispatch<SetStateAction<string>> | yes | — | — |
+| `hintMessage` | any | yes | — | — |
+| `inputStatus` | any | yes | — | — |
+| `chains` | NetworkInfos[] | yes | — | — |
+| `currentChain` | CurrentChain \| null | yes | — | — |
+| `settingChain` | boolean | yes | — | — |
+| `onChainChange` | (chain: NetworkInfos) => Promise<void> | yes | — | — |
+| `actionType` | enum | yes | — | — |
+| `onDeposit` | () => Promise<void> | yes | — | — |
+| `onApprove` | () => Promise<void> | yes | — | — |
+| `fetchBalance` | (address: string, decimals?: number \| undefined) => Promise<string> | yes | — | — |
+| `dst` | DST | yes | — | — |
+| `wrongNetwork` | boolean | yes | — | — |
+| `balanceRevalidating` | boolean | yes | — | — |
+| `loading` | any | yes | — | — |
+| `disabled` | boolean | yes | — | — |
+| `networkId` | enum | yes | — | — |
+| `slippage` | any | yes | — | — |
+| `onSlippageChange` | (value: number) => void | yes | — | — |
+| `needSwap` | any | yes | — | — |
+| `needCrossSwap` | any | yes | — | — |
+| `swapPrice` | number | yes | — | — |
+| `swapRevalidating` | boolean | yes | — | — |
+| `warningMessage` | string | yes | — | — |
+| `fee` | { nativeSymbol: string \| undefined; feeAmount: string; feeQtys: FeeQty[]; feeDetails: { value: string \| number; title: string; description: string; dp: number; symbol: string \| undefined; }[]; } | yes | — | — |
+
+
+## Usage notes
+
+- Provide all required props first, then layer optional behavior-oriented props as needed.
+
+
+## Caveats
+
+- Some prop descriptions were not available from source comments.
+- Some default values could not be inferred statically from source.
+

package/bundled/docs-md/components/component._kodiak-finance_orderly-ui-transfer.packages_ui-transfer_src_components_swap_swapDepositForm_swapDepositForm.widget.tsx.SwapDepositFormWidget.md

@@ -0,0 +1,34 @@
+---
+kind: component-doc
+id: component._kodiak-finance_orderly-ui-transfer.packages_ui-transfer_src_components_swap_swapDepositForm_swapDepositForm.widget.tsx.SwapDepositFormWidget
+packages: ["@kodiak-finance/orderly-ui-transfer"]
+---
+
+# SwapDepositFormWidget
+
+**Package:** `@kodiak-finance/orderly-ui-transfer`  
+**Source:** `packages/ui-transfer/src/components/swap/swapDepositForm/swapDepositForm.widget.tsx`
+
+> Auto-generated stub from `components.json`. Add or override with a curated file under `apps/ai-docs/components/` using the same `id:` in frontmatter.
+
+## Description
+
+SwapDepositFormWidget is exported from `@kodiak-finance/orderly-ui-transfer` and sourced at `packages/ui-transfer/src/components/swap/swapDepositForm/swapDepositForm.widget.tsx`.
+
+## Props
+
+| Prop | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| `onClose` | (() => void) | no | — | — |
+
+
+## Usage notes
+
+- All extracted props are optional; start from defaults and opt into behavior incrementally.
+
+
+## Caveats
+
+- Some prop descriptions were not available from source comments.
+- Some default values could not be inferred statically from source.
+

package/bundled/docs-md/components/component._kodiak-finance_orderly-ui-transfer.packages_ui-transfer_src_components_transferForm_transferForm.script.tsx.useInputStatus.md

@@ -0,0 +1,36 @@
+---
+kind: component-doc
+id: component._kodiak-finance_orderly-ui-transfer.packages_ui-transfer_src_components_transferForm_transferForm.script.tsx.useInputStatus
+packages: ["@kodiak-finance/orderly-ui-transfer"]
+---
+
+# useInputStatus
+
+**Package:** `@kodiak-finance/orderly-ui-transfer`  
+**Source:** `packages/ui-transfer/src/components/transferForm/transferForm.script.tsx`
+
+> Auto-generated stub from `components.json`. Add or override with a curated file under `apps/ai-docs/components/` using the same `id:` in frontmatter.
+
+## Description
+
+useInputStatus is exported from `@kodiak-finance/orderly-ui-transfer` and sourced at `packages/ui-transfer/src/components/transferForm/transferForm.script.tsx`.
+
+## Props
+
+| Prop | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| `quantity` | string | yes | — | — |
+| `maxQuantity` | string \| number | yes | — | — |
+| `unsettledPnL` | number | no | — | — |
+
+
+## Usage notes
+
+- Provide all required props first, then layer optional behavior-oriented props as needed.
+
+
+## Caveats
+
+- Some prop descriptions were not available from source comments.
+- Some default values could not be inferred statically from source.
+

package/bundled/docs-md/components/component._kodiak-finance_orderly-ui-transfer.packages_ui-transfer_src_components_transferForm_transferForm.script.tsx.useTransferFormScript.md

@@ -0,0 +1,36 @@
+---
+kind: component-doc
+id: component._kodiak-finance_orderly-ui-transfer.packages_ui-transfer_src_components_transferForm_transferForm.script.tsx.useTransferFormScript
+packages: ["@kodiak-finance/orderly-ui-transfer"]
+---
+
+# useTransferFormScript
+
+**Package:** `@kodiak-finance/orderly-ui-transfer`  
+**Source:** `packages/ui-transfer/src/components/transferForm/transferForm.script.tsx`
+
+> Auto-generated stub from `components.json`. Add or override with a curated file under `apps/ai-docs/components/` using the same `id:` in frontmatter.
+
+## Description
+
+useTransferFormScript is exported from `@kodiak-finance/orderly-ui-transfer` and sourced at `packages/ui-transfer/src/components/transferForm/transferForm.script.tsx`.
+
+## Props
+
+| Prop | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| `toAccountId` | string | no | — | target sub account id |
+| `token` | string | no | — | — |
+| `close` | (() => void) | no | — | — |
+
+
+## Usage notes
+
+- All extracted props are optional; start from defaults and opt into behavior incrementally.
+
+
+## Caveats
+
+- Some prop descriptions were not available from source comments.
+- Some default values could not be inferred statically from source.
+

package/bundled/docs-md/components/component._kodiak-finance_orderly-ui-transfer.packages_ui-transfer_src_components_transferForm_transferForm.ui.tsx.TransferForm.md

@@ -0,0 +1,58 @@
+---
+kind: component-doc
+id: component._kodiak-finance_orderly-ui-transfer.packages_ui-transfer_src_components_transferForm_transferForm.ui.tsx.TransferForm
+packages: ["@kodiak-finance/orderly-ui-transfer"]
+---
+
+# TransferForm
+
+**Package:** `@kodiak-finance/orderly-ui-transfer`  
+**Source:** `packages/ui-transfer/src/components/transferForm/transferForm.ui.tsx`
+
+> Auto-generated stub from `components.json`. Add or override with a curated file under `apps/ai-docs/components/` using the same `id:` in frontmatter.
+
+## Description
+
+TransferForm is exported from `@kodiak-finance/orderly-ui-transfer` and sourced at `packages/ui-transfer/src/components/transferForm/transferForm.ui.tsx`.
+
+## Props
+
+| Prop | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| `networkId` | enum | yes | — | — |
+| `onTransfer` | () => void | yes | — | — |
+| `quantity` | string | yes | — | — |
+| `amount` | number | yes | — | — |
+| `onQuantityChange` | Dispatch<SetStateAction<string>> | yes | — | — |
+| `maxQuantity` | number | yes | — | — |
+| `tokens` | TokenInfo[] | yes | — | — |
+| `token` | TokenInfo | yes | — | — |
+| `onTokenChange` | Dispatch<SetStateAction<TokenInfo>> | yes | — | — |
+| `disabled` | boolean | yes | — | — |
+| `submitting` | boolean | yes | — | — |
+| `hintMessage` | string \| undefined | yes | — | — |
+| `inputStatus` | enum | yes | — | — |
+| `hasPositions` | boolean | yes | — | — |
+| `onSettlePnl` | () => Promise<any> | yes | — | — |
+| `unsettledPnL` | number \| undefined | yes | — | — |
+| `toAccountAsset` | number | yes | — | — |
+| `fromAccount` | SubAccount \| undefined | yes | — | — |
+| `toAccount` | SubAccount \| undefined | yes | — | — |
+| `fromAccounts` | SubAccount[] | yes | — | — |
+| `onFromAccountChange` | (account: SubAccount) => void | yes | — | — |
+| `toAccounts` | SubAccount[] \| undefined | yes | — | — |
+| `onToAccountChange` | (account: SubAccount) => void | yes | — | — |
+| `onExchange` | () => void | yes | — | — |
+| `isMainAccount` | boolean | yes | — | — |
+
+
+## Usage notes
+
+- Provide all required props first, then layer optional behavior-oriented props as needed.
+
+
+## Caveats
+
+- Some prop descriptions were not available from source comments.
+- Some default values could not be inferred statically from source.
+

package/bundled/docs-md/components/component._kodiak-finance_orderly-ui-transfer.packages_ui-transfer_src_components_transferForm_transferForm.widget.tsx.TransferFormWidget.md

@@ -0,0 +1,36 @@
+---
+kind: component-doc
+id: component._kodiak-finance_orderly-ui-transfer.packages_ui-transfer_src_components_transferForm_transferForm.widget.tsx.TransferFormWidget
+packages: ["@kodiak-finance/orderly-ui-transfer"]
+---
+
+# TransferFormWidget
+
+**Package:** `@kodiak-finance/orderly-ui-transfer`  
+**Source:** `packages/ui-transfer/src/components/transferForm/transferForm.widget.tsx`
+
+> Auto-generated stub from `components.json`. Add or override with a curated file under `apps/ai-docs/components/` using the same `id:` in frontmatter.
+
+## Description
+
+TransferFormWidget is exported from `@kodiak-finance/orderly-ui-transfer` and sourced at `packages/ui-transfer/src/components/transferForm/transferForm.widget.tsx`.
+
+## Props
+
+| Prop | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| `toAccountId` | string | no | — | target sub account id |
+| `token` | string | no | — | — |
+| `close` | (() => void) | no | — | — |
+
+
+## Usage notes
+
+- All extracted props are optional; start from defaults and opt into behavior incrementally.
+
+
+## Caveats
+
+- Some prop descriptions were not available from source comments.
+- Some default values could not be inferred statically from source.
+

package/bundled/docs-md/components/component._kodiak-finance_orderly-ui-transfer.packages_ui-transfer_src_components_transferForm_transferForm.widget.tsx.TransferWidget.md

@@ -0,0 +1,36 @@
+---
+kind: component-doc
+id: component._kodiak-finance_orderly-ui-transfer.packages_ui-transfer_src_components_transferForm_transferForm.widget.tsx.TransferWidget
+packages: ["@kodiak-finance/orderly-ui-transfer"]
+---
+
+# TransferWidget
+
+**Package:** `@kodiak-finance/orderly-ui-transfer`  
+**Source:** `packages/ui-transfer/src/components/transferForm/transferForm.widget.tsx`
+
+> Auto-generated stub from `components.json`. Add or override with a curated file under `apps/ai-docs/components/` using the same `id:` in frontmatter.
+
+## Description
+
+TransferWidget is exported from `@kodiak-finance/orderly-ui-transfer` and sourced at `packages/ui-transfer/src/components/transferForm/transferForm.widget.tsx`.
+
+## Props
+
+| Prop | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| `toAccountId` | string | no | — | target sub account id |
+| `token` | string | no | — | — |
+| `close` | (() => void) | no | — | — |
+
+
+## Usage notes
+
+- All extracted props are optional; start from defaults and opt into behavior incrementally.
+
+
+## Caveats
+
+- Some prop descriptions were not available from source comments.
+- Some default values could not be inferred statically from source.
+

package/bundled/docs-md/components/component._kodiak-finance_orderly-ui-transfer.packages_ui-transfer_src_components_unsettlePnlInfo_index.tsx.UnsettlePnlInfo.md

@@ -0,0 +1,38 @@
+---
+kind: component-doc
+id: component._kodiak-finance_orderly-ui-transfer.packages_ui-transfer_src_components_unsettlePnlInfo_index.tsx.UnsettlePnlInfo
+packages: ["@kodiak-finance/orderly-ui-transfer"]
+---
+
+# UnsettlePnlInfo
+
+**Package:** `@kodiak-finance/orderly-ui-transfer`  
+**Source:** `packages/ui-transfer/src/components/unsettlePnlInfo/index.tsx`
+
+> Auto-generated stub from `components.json`. Add or override with a curated file under `apps/ai-docs/components/` using the same `id:` in frontmatter.
+
+## Description
+
+UnsettlePnlInfo is exported from `@kodiak-finance/orderly-ui-transfer` and sourced at `packages/ui-transfer/src/components/unsettlePnlInfo/index.tsx`.
+
+## Props
+
+| Prop | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| `hasPositions` | boolean | yes | — | — |
+| `unsettledPnl` | number | no | — | — |
+| `onSettlePnl` | () => Promise<any> | yes | — | — |
+| `tooltipContent` | ReactNode | no | — | — |
+| `dialogContent` | ReactNode | no | — | — |
+
+
+## Usage notes
+
+- Provide all required props first, then layer optional behavior-oriented props as needed.
+
+
+## Caveats
+
+- Some prop descriptions were not available from source comments.
+- Some default values could not be inferred statically from source.
+

package/bundled/docs-md/components/component._kodiak-finance_orderly-ui-transfer.packages_ui-transfer_src_components_unsettlePnlInfo_useSettlePnl.tsx.useSettlePnl.md

@@ -0,0 +1,34 @@
+---
+kind: component-doc
+id: component._kodiak-finance_orderly-ui-transfer.packages_ui-transfer_src_components_unsettlePnlInfo_useSettlePnl.tsx.useSettlePnl
+packages: ["@kodiak-finance/orderly-ui-transfer"]
+---
+
+# useSettlePnl
+
+**Package:** `@kodiak-finance/orderly-ui-transfer`  
+**Source:** `packages/ui-transfer/src/components/unsettlePnlInfo/useSettlePnl.tsx`
+
+> Auto-generated stub from `components.json`. Add or override with a curated file under `apps/ai-docs/components/` using the same `id:` in frontmatter.
+
+## Description
+
+useSettlePnl is exported from `@kodiak-finance/orderly-ui-transfer` and sourced at `packages/ui-transfer/src/components/unsettlePnlInfo/useSettlePnl.tsx`.
+
+## Props
+
+| Prop | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| `accountId` | string | no | — | — |
+
+
+## Usage notes
+
+- All extracted props are optional; start from defaults and opt into behavior incrementally.
+
+
+## Caveats
+
+- Some prop descriptions were not available from source comments.
+- Some default values could not be inferred statically from source.
+

package/bundled/docs-md/components/component._kodiak-finance_orderly-ui-transfer.packages_ui-transfer_src_components_web3Wallet_index.tsx.Web3Wallet.md

@@ -0,0 +1,31 @@
+---
+kind: component-doc
+id: component._kodiak-finance_orderly-ui-transfer.packages_ui-transfer_src_components_web3Wallet_index.tsx.Web3Wallet
+packages: ["@kodiak-finance/orderly-ui-transfer"]
+---
+
+# Web3Wallet
+
+**Package:** `@kodiak-finance/orderly-ui-transfer`  
+**Source:** `packages/ui-transfer/src/components/web3Wallet/index.tsx`
+
+> Auto-generated stub from `components.json`. Add or override with a curated file under `apps/ai-docs/components/` using the same `id:` in frontmatter.
+
+## Description
+
+Web3Wallet is exported from `@kodiak-finance/orderly-ui-transfer` and sourced at `packages/ui-transfer/src/components/web3Wallet/index.tsx`.
+
+## Props
+
+_No props extracted._
+
+
+## Usage notes
+
+- This component currently exposes no extracted SDK props.
+
+
+## Caveats
+
+_No caveats detected from static extraction._
+

package/bundled/docs-md/components/component._kodiak-finance_orderly-ui-transfer.packages_ui-transfer_src_components_withdrawAction_SwitchChainButton.tsx.SwitchChainButton.md

@@ -0,0 +1,35 @@
+---
+kind: component-doc
+id: component._kodiak-finance_orderly-ui-transfer.packages_ui-transfer_src_components_withdrawAction_SwitchChainButton.tsx.SwitchChainButton
+packages: ["@kodiak-finance/orderly-ui-transfer"]
+---
+
+# SwitchChainButton
+
+**Package:** `@kodiak-finance/orderly-ui-transfer`  
+**Source:** `packages/ui-transfer/src/components/withdrawAction/SwitchChainButton.tsx`
+
+> Auto-generated stub from `components.json`. Add or override with a curated file under `apps/ai-docs/components/` using the same `id:` in frontmatter.
+
+## Description
+
+SwitchChainButton is exported from `@kodiak-finance/orderly-ui-transfer` and sourced at `packages/ui-transfer/src/components/withdrawAction/SwitchChainButton.tsx`.
+
+## Props
+
+| Prop | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| `networkId` | enum | no | — | — |
+| `size` | "md" \| "lg" \| "sm" \| "xl" \| "xs" \| { initial?: "md" \| "lg" \| "sm" \| "xl" \| "xs" \| undefined; md?: "md" \| "lg" \| "sm" \| "xl" \| "xs" \| undefined; lg?: "md" \| "lg" \| "sm" \| "xl" \| "xs" \| undefined; } \| undefined | yes | — | — |
+
+
+## Usage notes
+
+- Provide all required props first, then layer optional behavior-oriented props as needed.
+
+
+## Caveats
+
+- Some prop descriptions were not available from source comments.
+- Some default values could not be inferred statically from source.
+

package/bundled/docs-md/components/component._kodiak-finance_orderly-ui-transfer.packages_ui-transfer_src_components_withdrawAction_index.tsx.WithdrawAction.md

@@ -0,0 +1,45 @@
+---
+kind: component-doc
+id: component._kodiak-finance_orderly-ui-transfer.packages_ui-transfer_src_components_withdrawAction_index.tsx.WithdrawAction
+packages: ["@kodiak-finance/orderly-ui-transfer"]
+---
+
+# WithdrawAction
+
+**Package:** `@kodiak-finance/orderly-ui-transfer`  
+**Source:** `packages/ui-transfer/src/components/withdrawAction/index.tsx`
+
+> Auto-generated stub from `components.json`. Add or override with a curated file under `apps/ai-docs/components/` using the same `id:` in frontmatter.
+
+## Description
+
+WithdrawAction is exported from `@kodiak-finance/orderly-ui-transfer` and sourced at `packages/ui-transfer/src/components/withdrawAction/index.tsx`.
+
+## Props
+
+| Prop | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| `disabled` | boolean | no | — | — |
+| `loading` | boolean | no | — | — |
+| `onWithdraw` | () => Promise<void> | yes | — | — |
+| `networkId` | enum | no | — | — |
+| `crossChainWithdraw` | boolean | yes | — | — |
+| `address` | string | no | — | — |
+| `currentChain` | any | no | — | — |
+| `quantity` | string | yes | — | — |
+| `fee` | number | yes | — | — |
+| `checkIsBridgeless` | boolean | yes | — | — |
+| `withdrawTo` | enum | yes | — | — |
+| `onTransfer` | () => void | yes | — | — |
+
+
+## Usage notes
+
+- Provide all required props first, then layer optional behavior-oriented props as needed.
+
+
+## Caveats
+
+- Some prop descriptions were not available from source comments.
+- Some default values could not be inferred statically from source.
+

package/bundled/docs-md/components/component._kodiak-finance_orderly-ui-transfer.packages_ui-transfer_src_components_withdrawForm_addWalletDialog.tsx.AddWalletDialog.md

@@ -0,0 +1,37 @@
+---
+kind: component-doc
+id: component._kodiak-finance_orderly-ui-transfer.packages_ui-transfer_src_components_withdrawForm_addWalletDialog.tsx.AddWalletDialog
+packages: ["@kodiak-finance/orderly-ui-transfer"]
+---
+
+# AddWalletDialog
+
+**Package:** `@kodiak-finance/orderly-ui-transfer`  
+**Source:** `packages/ui-transfer/src/components/withdrawForm/addWalletDialog.tsx`
+
+> Auto-generated stub from `components.json`. Add or override with a curated file under `apps/ai-docs/components/` using the same `id:` in frontmatter.
+
+## Description
+
+AddWalletDialog is exported from `@kodiak-finance/orderly-ui-transfer` and sourced at `packages/ui-transfer/src/components/withdrawForm/addWalletDialog.tsx`.
+
+## Props
+
+| Prop | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| `open` | boolean | yes | — | — |
+| `onOpenChange` | (open: boolean) => void | yes | — | — |
+| `onConfirm` | (address: string, network?: "EVM" \| "SOL" \| undefined) => void | yes | — | — |
+| `chain` | CurrentChain \| null | yes | — | — |
+
+
+## Usage notes
+
+- Provide all required props first, then layer optional behavior-oriented props as needed.
+
+
+## Caveats
+
+- Some prop descriptions were not available from source comments.
+- Some default values could not be inferred statically from source.
+

package/bundled/docs-md/components/component._kodiak-finance_orderly-ui-transfer.packages_ui-transfer_src_components_withdrawForm_hooks_useVaultBalance.tsx.useVaultBalance.md

@@ -0,0 +1,38 @@
+---
+kind: component-doc
+id: component._kodiak-finance_orderly-ui-transfer.packages_ui-transfer_src_components_withdrawForm_hooks_useVaultBalance.tsx.useVaultBalance
+packages: ["@kodiak-finance/orderly-ui-transfer"]
+---
+
+# useVaultBalance
+
+**Package:** `@kodiak-finance/orderly-ui-transfer`  
+**Source:** `packages/ui-transfer/src/components/withdrawForm/hooks/useVaultBalance.tsx`
+
+> Auto-generated stub from `components.json`. Add or override with a curated file under `apps/ai-docs/components/` using the same `id:` in frontmatter.
+
+## Description
+
+useVaultBalance is exported from `@kodiak-finance/orderly-ui-transfer` and sourced at `packages/ui-transfer/src/components/withdrawForm/hooks/useVaultBalance.tsx`.
+
+## Props
+
+| Prop | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| `currentChain` | CurrentChain \| null | no | — | — |
+| `sourceToken` | TokenInfo | no | — | — |
+| `withdrawTo` | enum | yes | — | — |
+| `quantity` | string | yes | — | — |
+| `qtyGreaterThanMaxAmount` | boolean | yes | — | — |
+
+
+## Usage notes
+
+- Provide all required props first, then layer optional behavior-oriented props as needed.
+
+
+## Caveats
+
+- Some prop descriptions were not available from source comments.
+- Some default values could not be inferred statically from source.
+

package/bundled/docs-md/components/component._kodiak-finance_orderly-ui-transfer.packages_ui-transfer_src_components_withdrawForm_hooks_useWithdrawLTV.tsx.useWithdrawLTV.md

@@ -0,0 +1,35 @@
+---
+kind: component-doc
+id: component._kodiak-finance_orderly-ui-transfer.packages_ui-transfer_src_components_withdrawForm_hooks_useWithdrawLTV.tsx.useWithdrawLTV
+packages: ["@kodiak-finance/orderly-ui-transfer"]
+---
+
+# useWithdrawLTV
+
+**Package:** `@kodiak-finance/orderly-ui-transfer`  
+**Source:** `packages/ui-transfer/src/components/withdrawForm/hooks/useWithdrawLTV.tsx`
+
+> Auto-generated stub from `components.json`. Add or override with a curated file under `apps/ai-docs/components/` using the same `id:` in frontmatter.
+
+## Description
+
+useWithdrawLTV is exported from `@kodiak-finance/orderly-ui-transfer` and sourced at `packages/ui-transfer/src/components/withdrawForm/hooks/useWithdrawLTV.tsx`.
+
+## Props
+
+| Prop | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| `token` | string | yes | — | — |
+| `quantity` | string | yes | — | — |
+
+
+## Usage notes
+
+- Provide all required props first, then layer optional behavior-oriented props as needed.
+
+
+## Caveats
+
+- Some prop descriptions were not available from source comments.
+- Some default values could not be inferred statically from source.
+