@hanzo/ui

Forex Screener

import { ForexScreener } from '@hanzo/ui'

Default

The forex market, dark theme, with the toolbar shown.

export function Default() {
  return <ForexScreener />
}

Screen

Opens pre-filtered to the top-gainers preset screen.

export function Screen() {
  return <ForexScreener defaultScreen="top_gainers" />
}

Column

Opens on the performance columns instead of the overview.

export function Column() {
  return <ForexScreener defaultColumn="performance" />
}

Sized

A shorter, fixed-width frame with the toolbar hidden.

export function Sized() {
  return (
    <YStack width={360}>
      <ForexScreener width={360} height={400} showToolbar={false} colorTheme="light" />
    </YStack>
  )
}

Types

export type ForexScreenerMarket = 'forex' | (string & {})
export type ForexScreenerColumn =
  | 'overview'
  | 'performance'
  | 'oscillators'
  | 'moving_averages'
export type ForexScreenerScreen =
  | 'general'
  | 'top_gainers'
  | 'top_losers'
  | 'most_volatile'
  | (string & {})
export type ForexScreenerTheme = 'light' | 'dark'
export interface ForexScreenerProps extends Omit<YStackProps, 'width' | 'height' | 'theme'> {
  /** Which market the table screens. */
  market?: ForexScreenerMarket
  /** Which column set the table opens on. */
  defaultColumn?: ForexScreenerColumn
  /** Which preset screen the table opens filtered to. */
  defaultScreen?: ForexScreenerScreen
  /** Whether the toolbar (screen picker, column picker) is shown. */
  showToolbar?: boolean
  /** The table's own palette; independent of the surrounding gui theme. */
  colorTheme?: ForexScreenerTheme
  isTransparent?: boolean
  locale?: string
  width?: string | number
  height?: string | number
}

Exports

ForexScreenertype ForexScreenerColumntype ForexScreenerMarkettype ForexScreenerPropstype ForexScreenerScreentype ForexScreenerTheme