Orderly SDKs / Modules / @orderly.network/react

​

Module: @orderly.network/react

​

Table of contents

​

References

• Numeral

​

Namespaces

• Calendar
• DialogBody
• DialogFooter
• DialogHeader
• DropdownMenuShortcut
• SheetFooter
• SheetHeader
• TabPane
• Tooltip

​

Enumerations

• ExtensionPosition
• TradingFeatures

​

Interfaces

• AccountStatusProps
• DepositProps
• InputProps
• MarketsProps
• ModalHocProps
• OrderBookProps
• OrderEntryProps
• OrdersViewProps
• PositionsViewProps
• TabContextState
• TabPaneProps
• TradeHistoryProps
• TradingPageContextValue
• WithdrawProps

​

Type Aliases

• Button
• Collapse
• Column
• CombinedComponent
• CombinedText
• DateRange
• Deposit
• Layout
• ListTile
• OrderlyConfig
• OrderlyConfigCtx
• TradingPage

​

Variables

• AssetsContext
• OrderlyAppContext
• SymbolContext
• TabContext
• TradingPageContext
• modal
• version

​

Functions

• AccountStatusBar
• AlertDialog
• AssetAndMarginSheet
• AssetsProvider
• Button
• Calendar
• ChainDialog
• ChainListView
• ChainSelect
• ClosePositionPane
• Collapse
• Collapsible
• CollapsibleContent
• CollapsibleTrigger
• DataListView
• DatePicker
• Deposit
• DepositAndWithdrawWithDialog
• DepositAndWithdrawWithSheet
• Dialog
• DialogBody
• DialogContent
• DialogFooter
• DialogHeader
• DialogTitle
• DialogTrigger
• Divider
• DropdownMenu
• DropdownMenuCheckboxItem
• DropdownMenuContent
• DropdownMenuGroup
• DropdownMenuItem
• DropdownMenuLabel
• DropdownMenuPortal
• DropdownMenuRadioGroup
• DropdownMenuRadioItem
• DropdownMenuSeparator
• DropdownMenuShortcut
• DropdownMenuSub
• DropdownMenuSubContent
• DropdownMenuSubTrigger
• DropdownMenuTrigger
• EmptyView
• EndReachedBox
• Input
• Layout
• ListTile
• ListView
• Markets
• MarketsFull
• NoData
• OrderBook
• OrderEntry
• OrderlyAppProvider
• OrdersView
• Page
• Picker
• Portfolio
• PositionsView
• PositionsViewFull
• Progress
• Select
• Sheet
• SheetClose
• SheetContent
• SheetDescription
• SheetFooter
• SheetHeader
• SheetTitle
• SheetTrigger
• SimpleDialog
• Spinner
• Statistic
• Switch
• SymbolProvider
• SystemStatusBar
• TabList
• TabPane
• Table
• Tabs
• Text
• Tooltip
• TooltipContent
• TooltipProvider
• TooltipTrigger
• TradeHistory
• TradingPage
• TradingPageProvider
• WalletConnect
• Withdraw
• cn
• create
• installExtension
• parseNumber
• showAccountConnectorModal
• toast
• useCSSVariable
• useModal
• useTab

​

References

​

Numeral

Renames and re-exports CombinedComponent

​

Type Aliases

​

Button

Ƭ Button: typeof BaseButton & { Segmented: typeof SegmentedButton ; buttonVariants: typeof buttonVariants }

​

Defined in

packages/component/src/button/index.tsx:4

packages/component/src/button/index.tsx:12

---

​

Collapse

Ƭ Collapse: typeof CollapseRoot & { panel: typeof Panel }

​

Defined in

packages/component/src/collapsible/collapse/collapse.tsx:18

packages/component/src/collapsible/collapse/collapse.tsx:22

---

​

Column

Ƭ Column<RecordType>: Object

​

Type parameters

Name	Type
RecordType	extends unknown = any

​

Type declaration

Name	Type
align?	"left" | "center" | "right"
className?	string | (record: RecordType, index: number) => string
dataIndex	string
fixed?	ColumnFixed
formatter?	(value: any, record: RecordType, index: number) => any
getKey?	(record: RecordType, index: number) => string
hint?	ReactNode
hintClassName?	string
onSort?	boolean | (r1: RecordType, r2: RecordType, sortOrder: SortOrder) => number
render?	(value: any, record: RecordType, index: number) => React.ReactNode
title	string
width?	number

​

Defined in

packages/component/src/table/col.tsx:10

---

​

CombinedComponent

Ƭ CombinedComponent: typeof Numeral & { symbol: typeof NumeralWithSymbol ; total: typeof NumeralTotal ; withCtx: typeof NumeralWithCtx }

​

Defined in

packages/component/src/text/index.ts:8

---

​

CombinedText

Ƭ CombinedText: typeof Text & { tradingPair: typeof TradingPair }

​

Defined in

packages/component/src/text/index.ts:21

---

​

DateRange

Ƭ DateRange: Object

​

Type declaration

Name	Type
from?	Date
to?	Date

​

Defined in

packages/component/src/datePicker/datePiker.tsx:10

---

​

Deposit

Ƭ Deposit: typeof DepositRoot & { withDialog: typeof DepositWithDialog ; withSheet: typeof DepositWithSheet }

​

Defined in

packages/component/src/block/deposit/index.ts:5

packages/component/src/block/deposit/index.ts:10

---

​

Layout

Ƭ Layout: typeof BaseLayout & { Content: typeof Content ; Footer: typeof Footer ; Header: typeof Header ; PageHeader: typeof PageHeader ; Sider: typeof Sider ; Split: typeof Split }

​

Defined in

packages/component/src/layout/index.ts:12

packages/component/src/layout/index.ts:21

---

​

ListTile

Ƭ ListTile: typeof ListTile & { symbol: typeof ListTileForSymbol }

​

Defined in

packages/component/src/listView/index.tsx:22

packages/component/src/listView/index.tsx:26

---

​

OrderlyConfig

Ƭ OrderlyConfig: Object

​

Type declaration

Name	Type
app	{ appIcons: AppLogos ; brokerId: string ; brokerName: string }
app.appIcons	AppLogos
app.brokerId	string
app.brokerName	string
pages	{ trading?: { tradingView?: { library_path: string ; scriptSRC: string } } }
pages.trading?	{ tradingView?: { library_path: string ; scriptSRC: string } }
pages.trading.tradingView?	{ library_path: string ; scriptSRC: string }
pages.trading.tradingView.library_path	string
pages.trading.tradingView.scriptSRC	string
wallet	{ apiKey?: string ; options?: any }
wallet.apiKey?	string
wallet.options?	any

​

Defined in

packages/component/src/types/orderly.config.ts:3

---

​

OrderlyConfigCtx

Ƭ OrderlyConfigCtx: Object

​

Defined in

packages/component/src/types/orderly.config.ts:23

---

​

TradingPage

Ƭ TradingPage: typeof BaseTradingPage & { desktop: typeof DesktopTradingPage ; mobile: typeof MobileTradingPage }

​

Defined in

packages/component/src/page/trading/index.tsx:7

packages/component/src/page/trading/index.tsx:12

​

Variables

​

AssetsContext

• Const AssetsContext: Context<AssetsContextState>

​

Defined in

packages/component/src/provider/assetsProvider.tsx:28

---

​

OrderlyAppContext

• Const OrderlyAppContext: Context<OrderlyAppContextState>

​

Defined in

packages/component/src/provider/appProvider.tsx:94

---

​

SymbolContext

• Const SymbolContext: Context<SymbolContextState>

​

Defined in

packages/component/src/provider/symbolProvider.tsx:19

---

​

TabContext

• Const TabContext: Context<TabContextState>

​

Defined in

packages/component/src/tab/tabContext.tsx:20

---

​

TradingPageContext

• Const TradingPageContext: Context<TradingPageContextValue>

​

Defined in

packages/component/src/page/trading/context/tradingPageContext.tsx:14

---

​

modal

• Const modal: Object

​

Type declaration

Name	Type
actionSheet	(items: ActionSheetItem[]) => Promise<unknown>
alert	(props: AlertDialogProps) => Promise<unknown>
confirm	(props: ConfirmProps) => Promise<unknown>
dialog	(props: DialogProps) => Promise<unknown>
hide	<T>(modal: string | FC<any>) => Promise<T>
register	<T>(id: string, comp: T, props?: Partial<ModalArgs<T>>) => void
remove	(id: string) => void
setStates	(id: string, states: Record<string, unknown>) => void
sheet	(props: SheetProps) => Promise<unknown>
show	<T, C>(modal: FC<C>, args?: Omit<C, "id">) => Promise<T><T>(modal: string, args?: Record<string, unknown>) => Promise<T><T, P>(modal: string, args?: P) => Promise<T>
unregister	(id: string) => void

​

Defined in

packages/component/src/modal/index.tsx:20

---

​

version

• version: "1.5.7"

​

Defined in

packages/component/src/version.ts:14

​

Functions

​

AccountStatusBar

▸ AccountStatusBar(props, context?): ReactNode

​

Parameters

Name	Type
props	AccountStatusProps
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

AlertDialog

▸ AlertDialog(props, context?): ReactNode

​

Parameters

Name	Type
props	AlertDialogProps
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

AssetAndMarginSheet

▸ AssetAndMarginSheet(props, context?): ReactNode

​

Parameters

Name	Type
props	AssetAndMarginProps
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

AssetsProvider

▸ AssetsProvider(props, context?): ReactNode

​

Parameters

Name	Type
props	Object
props.children?	ReactNode
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

Button

▸ Button(props): ReactNode

NOTE: Exotic components are not callable.

​

Parameters

Name	Type
props	ButtonProps & RefAttributes<HTMLButtonElement>

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:395

---

​

Calendar

▸ Calendar(«destructured»): Element

​

Parameters

Name	Type
«destructured»	DayPickerDefaultProps | DayPickerSingleProps | DayPickerMultipleProps | DayPickerRangeProps

​

Returns

Element

​

Defined in

packages/component/src/datePicker/calendar.tsx:10

---

​

ChainDialog

▸ ChainDialog(props, context?): ReactNode

​

Parameters

Name	Type
props	ChainListViewProps & ModalHocProps
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

ChainListView

▸ ChainListView(props, context?): ReactNode

​

Parameters

Name	Type
props	ChainListViewProps
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

ChainSelect

▸ ChainSelect(props, context?): ReactNode

​

Parameters

Name	Type
props	ChainSelectProps
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

ClosePositionPane

▸ ClosePositionPane(props, context?): ReactNode

​

Parameters

Name	Type
props	ClosePositionPaneProps
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

Collapse

▸ Collapse(props, context?): ReactNode

​

Parameters

Name	Type
props	PropsWithChildren<{ activeKey?: string }>
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

Collapsible

▸ Collapsible(props): ReactNode

NOTE: Exotic components are not callable.

​

Parameters

Name	Type
props	CollapsibleProps & RefAttributes<HTMLDivElement>

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:395

---

​

CollapsibleContent

▸ CollapsibleContent(props, context?): ReactNode

​

Parameters

Name	Type
props	CollapsibleContentProps
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

CollapsibleTrigger

▸ CollapsibleTrigger(props): ReactNode

NOTE: Exotic components are not callable.

​

Parameters

Name	Type
props	CollapsibleTriggerProps & RefAttributes<HTMLButtonElement>

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:395

---

​

DataListView

▸ DataListView(props): ReactNode

NOTE: Exotic components are not callable.

​

Parameters

Name	Type
props	unknown

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:395

---

​

DatePicker

▸ DatePicker(props, context?): ReactNode

​

Parameters

Name	Type
props	Object
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

Deposit

▸ Deposit(props, context?): ReactNode

​

Parameters

Name	Type
props	DepositProps
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

DepositAndWithdrawWithDialog

▸ DepositAndWithdrawWithDialog(props, context?): ReactNode

​

Parameters

Name	Type
props	DepositAndWithdrawProps & ModalHocProps
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

DepositAndWithdrawWithSheet

▸ DepositAndWithdrawWithSheet(props, context?): ReactNode

​

Parameters

Name	Type
props	DepositAndWithdrawProps & ModalHocProps
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

Dialog

▸ Dialog(props, context?): ReactNode

​

Parameters

Name	Type
props	DialogProps
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

DialogBody

▸ DialogBody(props, context?): ReactNode

​

Parameters

Name	Type
props	PropsWithChildren<DialogBodyProps>
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

DialogContent

▸ DialogContent(props): ReactNode

NOTE: Exotic components are not callable.

​

Parameters

Name	Type
props	Omit<DialogContentProps & RefAttributes<HTMLDivElement>, "ref"> & VariantProps<(props?: Object) => string> & { closable?: boolean ; closeableSize?: number } & RefAttributes<HTMLDivElement>

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:395

---

​

DialogFooter

▸ DialogFooter(«destructured»): Element

​

Parameters

Name	Type
«destructured»	HTMLAttributes<HTMLDivElement>

​

Returns

Element

​

Defined in

packages/component/src/dialog/dialog.tsx:112

---

​

DialogHeader

▸ DialogHeader(«destructured»): Element

​

Parameters

Name	Type
«destructured»	HTMLAttributes<HTMLDivElement>

​

Returns

Element

​

Defined in

packages/component/src/dialog/dialog.tsx:97

---

​

DialogTitle

▸ DialogTitle(props): ReactNode

NOTE: Exotic components are not callable.

​

Parameters

Name	Type
props	Omit<DialogTitleProps & RefAttributes<HTMLHeadingElement>, "ref"> & RefAttributes<HTMLHeadingElement>

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:395

---

​

DialogTrigger

▸ DialogTrigger(props): ReactNode

NOTE: Exotic components are not callable.

​

Parameters

Name	Type
props	DialogTriggerProps & RefAttributes<HTMLButtonElement>

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:395

---

​

Divider

▸ Divider(props, context?): ReactNode

​

Parameters

Name	Type
props	PropsWithChildren<DividerProps>
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

DropdownMenu

▸ DropdownMenu(props, context?): ReactNode

​

Parameters

Name	Type
props	DropdownMenuProps
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

DropdownMenuCheckboxItem

▸ DropdownMenuCheckboxItem(props): ReactNode

NOTE: Exotic components are not callable.

​

Parameters

Name	Type
props	Omit<DropdownMenuCheckboxItemProps & RefAttributes<HTMLDivElement>, "ref"> & RefAttributes<HTMLDivElement>

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:395

---

​

DropdownMenuContent

▸ DropdownMenuContent(props): ReactNode

NOTE: Exotic components are not callable.

​

Parameters

Name	Type
props	Omit<DropdownMenuContentProps & RefAttributes<HTMLDivElement>, "ref"> & { container?: HTMLElement } & RefAttributes<HTMLDivElement>

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:395

---

​

DropdownMenuGroup

▸ DropdownMenuGroup(props): ReactNode

NOTE: Exotic components are not callable.

​

Parameters

Name	Type
props	DropdownMenuGroupProps & RefAttributes<HTMLDivElement>

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:395

---

​

DropdownMenuItem

▸ DropdownMenuItem(props): ReactNode

NOTE: Exotic components are not callable.

​

Parameters

Name	Type
props	Omit<DropdownMenuItemProps & RefAttributes<HTMLDivElement>, "ref"> & { inset?: boolean } & RefAttributes<HTMLDivElement>

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:395

---

​

DropdownMenuLabel

▸ DropdownMenuLabel(props): ReactNode

NOTE: Exotic components are not callable.

​

Parameters

Name	Type
props	Omit<DropdownMenuLabelProps & RefAttributes<HTMLDivElement>, "ref"> & { inset?: boolean } & RefAttributes<HTMLDivElement>

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:395

---

​

DropdownMenuPortal

▸ DropdownMenuPortal(props, context?): ReactNode

​

Parameters

Name	Type
props	DropdownMenuPortalProps
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

DropdownMenuRadioGroup

▸ DropdownMenuRadioGroup(props): ReactNode

NOTE: Exotic components are not callable.

​

Parameters

Name	Type
props	DropdownMenuRadioGroupProps & RefAttributes<HTMLDivElement>

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:395

---

​

DropdownMenuRadioItem

▸ DropdownMenuRadioItem(props): ReactNode

NOTE: Exotic components are not callable.

​

Parameters

Name	Type
props	Omit<DropdownMenuRadioItemProps & RefAttributes<HTMLDivElement>, "ref"> & RefAttributes<HTMLDivElement>

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:395

---

​

DropdownMenuSeparator

▸ DropdownMenuSeparator(props): ReactNode

NOTE: Exotic components are not callable.

​

Parameters

Name	Type
props	Omit<DropdownMenuSeparatorProps & RefAttributes<HTMLDivElement>, "ref"> & RefAttributes<HTMLDivElement>

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:395

---

​

DropdownMenuShortcut

▸ DropdownMenuShortcut(«destructured»): Element

​

Parameters

Name	Type
«destructured»	HTMLAttributes<HTMLSpanElement>

​

Returns

Element

​

Defined in

packages/component/src/dropdown/dropdown.tsx:177

---

​

DropdownMenuSub

▸ DropdownMenuSub(props, context?): ReactNode

​

Parameters

Name	Type
props	DropdownMenuSubProps
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

DropdownMenuSubContent

▸ DropdownMenuSubContent(props): ReactNode

NOTE: Exotic components are not callable.

​

Parameters

Name	Type
props	Omit<DropdownMenuSubContentProps & RefAttributes<HTMLDivElement>, "ref"> & RefAttributes<HTMLDivElement>

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:395

---

​

DropdownMenuSubTrigger

▸ DropdownMenuSubTrigger(props): ReactNode

NOTE: Exotic components are not callable.

​

Parameters

Name	Type
props	Omit<DropdownMenuSubTriggerProps & RefAttributes<HTMLDivElement>, "ref"> & { inset?: boolean } & RefAttributes<HTMLDivElement>

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:395

---

​

DropdownMenuTrigger

▸ DropdownMenuTrigger(props): ReactNode

NOTE: Exotic components are not callable.

​

Parameters

Name	Type
props	DropdownMenuTriggerProps & RefAttributes<HTMLButtonElement>

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:395

---

​

EmptyView

▸ EmptyView(props, context?): ReactNode

​

Parameters

Name	Type
props	EmptyViewProps
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

EndReachedBox

▸ EndReachedBox(props, context?): ReactNode

​

Parameters

Name	Type
props	PropsWithChildren<EndReachedBoxProps>
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

Input

▸ Input(props): ReactNode

NOTE: Exotic components are not callable.

​

Parameters

Name	Type
props	InputProps & RefAttributes<HTMLInputElement>

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:395

---

​

Layout

▸ Layout(props): ReactNode

NOTE: Exotic components are not callable.

​

Parameters

Name	Type
props	LayoutProps

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:395

---

​

ListTile

▸ ListTile(props, context?): ReactNode

​

Parameters

Name	Type
props	PropsWithChildren<ListTileProps>
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

ListView

▸ ListView<T, D>(props): Element

​

Type parameters

Name
T
D

​

Parameters

Name	Type
props	ListViewProps<T, D> & { ref?: ForwardedRef<{ scroll: (direction: { x: number ; y: number }) => void }> }

​

Returns

Element

​

Defined in

packages/component/src/listView/listView.tsx:104

---

​

Markets

▸ Markets(props, context?): ReactNode

​

Parameters

Name	Type
props	MarketsProps & { listHeight?: number }
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

MarketsFull

▸ MarketsFull(props, context?): ReactNode

​

Parameters

Name	Type
props	MarketsProps & Props
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

NoData

▸ NoData(props): Element

​

Parameters

Name	Type
props	IntrinsicAttributes & SVGProps<SVGSVGElement>

​

Returns

Element

​

Defined in

packages/component/src/illustration/noData.tsx:2

---

​

OrderBook

▸ OrderBook(props, context?): ReactNode

​

Parameters

Name	Type
props	OrderBookProps
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

OrderEntry

▸ OrderEntry(props): ReactNode

NOTE: Exotic components are not callable.

​

Parameters

Name	Type
props	OrderEntryProps & RefAttributes<OrderEntryRef>

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:395

---

​

OrderlyAppProvider

▸ OrderlyAppProvider(props, context?): ReactNode

​

Parameters

Name	Type
props	PropsWithChildren<CommonOrderlyAppState & { contracts?: IContract ; includeTestnet?: boolean ; referral?: ReferralProps ; toastLimitCount?: number } & ConfigProviderProps>
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

OrdersView

▸ OrdersView(props, context?): ReactNode

​

Parameters

Name	Type
props	OrdersViewProps
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

Page

▸ Page(props, context?): ReactNode

​

Parameters

Name	Type
props	PropsWithChildren<PageProps>
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

Picker

▸ Picker(props): ReactNode

NOTE: Exotic components are not callable.

​

Parameters

Name	Type
props	PickerProps & RefAttributes<PickerRef>

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:395

---

​

Portfolio

▸ Portfolio(props, context?): ReactNode

​

Parameters

Name	Type
props	Object
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

PositionsView

▸ PositionsView(props, context?): ReactNode

​

Parameters

Name	Type
props	PositionsViewProps
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

PositionsViewFull

▸ PositionsViewFull(props, context?): ReactNode

​

Parameters

Name	Type
props	Omit<PositionsViewProps, "onShowAllSymbolChange"> & { pnlNotionalDecimalPrecision: any ; setUnPnlPriceBasic: any ; unPnlPriceBasis: any }
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

Progress

▸ Progress(props): ReactNode

NOTE: Exotic components are not callable.

​

Parameters

Name	Type
props	Omit<ProgressProps & RefAttributes<HTMLDivElement>, "ref"> & ProgressProps & RefAttributes<HTMLDivElement>

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:395

---

​

Select

▸ Select(props, context?): ReactNode

​

Parameters

Name	Type
props	SelectProps
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

Sheet

▸ Sheet(props, context?): ReactNode

​

Parameters

Name	Type
props	DialogProps
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

SheetClose

▸ SheetClose(props): ReactNode

NOTE: Exotic components are not callable.

​

Parameters

Name	Type
props	DialogCloseProps & RefAttributes<HTMLButtonElement>

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:395

---

​

SheetContent

▸ SheetContent(props): ReactNode

NOTE: Exotic components are not callable.

​

Parameters

Name	Type
props	SheetContentProps & RefAttributes<HTMLDivElement>

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:395

---

​

SheetDescription

▸ SheetDescription(props): ReactNode

NOTE: Exotic components are not callable.

​

Parameters

Name	Type
props	Omit<DialogDescriptionProps & RefAttributes<HTMLParagraphElement>, "ref"> & RefAttributes<HTMLParagraphElement>

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:395

---

​

SheetFooter

▸ SheetFooter(«destructured»): Element

​

Parameters

Name	Type
«destructured»	HTMLAttributes<HTMLDivElement>

​

Returns

Element

​

Defined in

packages/component/src/sheet/sheet.tsx:116

---

​

SheetHeader

▸ SheetHeader(«destructured»): Element

​

Parameters

Name	Type
«destructured»	HTMLAttributes<HTMLDivElement> & { leading?: ReactNode }

​

Returns

Element

​

Defined in

packages/component/src/sheet/sheet.tsx:96

---

​

SheetTitle

▸ SheetTitle(props): ReactNode

NOTE: Exotic components are not callable.

​

Parameters

Name	Type
props	Omit<DialogTitleProps & RefAttributes<HTMLHeadingElement>, "ref"> & RefAttributes<HTMLHeadingElement>

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:395

---

​

SheetTrigger

▸ SheetTrigger(props): ReactNode

NOTE: Exotic components are not callable.

​

Parameters

Name	Type
props	DialogTriggerProps & RefAttributes<HTMLButtonElement>

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:395

---

​

SimpleDialog

▸ SimpleDialog(props, context?): ReactNode

​

Parameters

Name	Type
props	PropsWithChildren<BaseDialogProps>
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

Spinner

▸ Spinner(props, context?): ReactNode

​

Parameters

Name	Type
props	SpinnerProps
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

Statistic

▸ Statistic(props, context?): ReactNode

​

Parameters

Name	Type
props	StatisticProps
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

Switch

▸ Switch(props): ReactNode

NOTE: Exotic components are not callable.

​

Parameters

Name	Type
props	SwitchProps & RefAttributes<HTMLButtonElement>

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:395

---

​

SymbolProvider

▸ SymbolProvider(props, context?): ReactNode

​

Parameters

Name	Type
props	PropsWithChildren<FormatterProviderProps>
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

SystemStatusBar

▸ SystemStatusBar(props, context?): ReactNode

​

Parameters

Name	Type
props	FooterStatusBarProps
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

TabList

▸ TabList(props, context?): ReactNode

​

Parameters

Name	Type
props	TabListProps
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

TabPane

▸ TabPane(props, context?): ReactNode

​

Parameters

Name	Type
props	PropsWithChildren<TabPaneProps>
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

Table

▸ Table<RecordType>(props): Element

​

Type parameters

Name	Type
RecordType	extends unknown

​

Parameters

Name	Type
props	TableProps<RecordType>

​

Returns

Element

​

Defined in

packages/component/src/table/table.tsx:29

---

​

Tabs

▸ Tabs(props): ReactNode

NOTE: Exotic components are not callable.

​

Parameters

Name	Type
props	TabsProps & { children?: ReactNode } & RefAttributes<{ getContainer: () => HTMLDivElement }>

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:395

---

​

Text

▸ Text(props, context?): ReactNode

​

Parameters

Name	Type
props	PropsWithChildren<TextProps>
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

Tooltip

▸ Tooltip(props, context?): ReactNode

​

Parameters

Name	Type
props	TooltipProps & Omit<TooltipContentProps & RefAttributes<HTMLDivElement>, "ref">
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

TooltipContent

▸ TooltipContent(props): ReactNode

NOTE: Exotic components are not callable.

​

Parameters

Name	Type
props	Omit<TooltipContentProps & RefAttributes<HTMLDivElement>, "ref"> & RefAttributes<HTMLDivElement>

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:395

---

​

TooltipProvider

▸ TooltipProvider(props, context?): ReactNode

​

Parameters

Name	Type
props	TooltipProviderProps
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

TooltipTrigger

▸ TooltipTrigger(props): ReactNode

NOTE: Exotic components are not callable.

​

Parameters

Name	Type
props	TooltipTriggerProps & RefAttributes<HTMLButtonElement>

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:395

---

​

TradeHistory

▸ TradeHistory(props, context?): ReactNode

​

Parameters

Name	Type
props	TradeHistoryProps
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

TradingPage

▸ TradingPage(props, context?): ReactNode

​

Parameters

Name	Type
props	TradingPageProps
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

TradingPageProvider

▸ TradingPageProvider(props, context?): ReactNode

​

Parameters

Name	Type
props	PropsWithChildren<TradingPageProviderProps>
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

WalletConnect

▸ WalletConnect(props, context?): ReactNode

​

Parameters

Name	Type
props	WalletConnectProps
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

Withdraw

▸ Withdraw(props, context?): ReactNode

​

Parameters

Name	Type
props	WithdrawProps
context?	any

​

Returns

ReactNode

​

Defined in

node_modules/.pnpm/@types+react@18.2.38/node_modules/@types/react/index.d.ts:567

---

​

cn

▸ cn(...args): string

​

Parameters

Name	Type
...args	any[]

​

Returns

string

​

Defined in

packages/component/src/utils/css.ts:6

---

​

create

▸ create<P>(Comp): FC<P & ModalHocProps>

​

Type parameters

Name	Type
P	extends Object

​

Parameters

Name	Type
Comp	ComponentType<P>

​

Returns

FC<P & ModalHocProps>

​

Defined in

packages/component/src/modal/modalHelper.tsx:18

---

​

installExtension

▸ installExtension<Props>(options): (component: ExtensionRenderComponentType<Props>) => void

​

Type parameters

Name	Type
Props	extends unknown =

​

Parameters

Name	Type
options	ExtensionOptions

​

Returns

fn

▸ (component): void

Parameters

Name	Type
component	ExtensionRenderComponentType<Props>

Returns

void

​

Defined in

packages/component/src/plugin/install.tsx:35

---

​

parseNumber

▸ parseNumber(value, options?): string

​

Parameters

Name	Type
value	string | number
options	Object
options.abs?	boolean
options.padding?	boolean
options.precision?	number
options.rule?	"price" | "percentages" | "human"
options.tick?	number
options.truncate?	"round" | "ceil" | "floor"

​

Returns

string

​

Defined in

packages/component/src/utils/num.ts:8

---

​

showAccountConnectorModal

▸ showAccountConnectorModal(props): Promise<unknown>

​

Parameters

Name	Type
props	WalletConnectProps

​

Returns

Promise<unknown>

​

Defined in

packages/component/src/block/walletConnect/walletModal.tsx:136

---

​

toast

▸ toast(message, opts?): string

​

Parameters

Name	Type
message	Message
opts?	Partial<Pick<Toast, "style" | "position" | "className" | "id" | "icon" | "duration" | "ariaProps" | "iconTheme">>

​

Returns

string

​

Defined in

node_modules/.pnpm/react-hot-toast@2.4.1_csstype@3.1.3_react-dom@18.2.0_react@18.2.0/node_modules/react-hot-toast/dist/index.d.ts:51

---

​

useCSSVariable

▸ useCSSVariable(names?): Partial<{ [key: string]: string; }>

​

Parameters

Name	Type
names?	string[]

​

Returns

Partial<{ [key: string]: string; }>

​

Defined in

packages/component/src/hooks/useCSSVariable.ts:3

---

​

useModal

▸ useModal(): ModalHandler

​

Returns

ModalHandler

​

Defined in

packages/component/src/modal/useModal.tsx:13

▸ useModal(modal, args?): ModalHandler

​

Parameters

Name	Type
modal	string
args?	Record<string, unknown>

​

Returns

ModalHandler

​

Defined in

packages/component/src/modal/useModal.tsx:14

▸ useModal<T, ComponentProps, PreparedProps, RemainingProps, ResolveType>(modal, args?): Omit<ModalHandler, "show"> & { show: Partial<RemainingProps> extends RemainingProps ? (args?: RemainingProps) => Promise<ResolveType> : (args: RemainingProps) => Promise<ResolveType> }

​

Type parameters

Name	Type
T	extends FC<any>
ComponentProps	extends Omit<any, "id">
PreparedProps	extends Partial<ComponentProps> = | ComponentProps
RemainingProps	Omit<ComponentProps, keyof PreparedProps> & Partial<ComponentProps>
ResolveType	unknown

​

Parameters

Name	Type
modal	T
args?	PreparedProps

​

Returns

Omit<ModalHandler, "show"> & { show: Partial<RemainingProps> extends RemainingProps ? (args?: RemainingProps) => Promise<ResolveType> : (args: RemainingProps) => Promise<ResolveType> }

​

Defined in

packages/component/src/modal/useModal.tsx:18

---

​

useTab

▸ useTab(): TabHook

​

Returns

TabHook

​

Defined in

packages/component/src/tab/tabHook.tsx:9