Skip to content

useCrosshair

Tracks the OHLCV data of the bar currently under the crosshair. Returns null when the cursor is off-chart. Updates are throttled with requestAnimationFrame, making it suitable for driving a live data panel / legend that follows the cursor.

import { useCrosshair } from "react-klinecharts-ui";
const { barData } = useCrosshair();
if (barData) {
console.log(barData.close, barData.changePercent);
}
PropertyTypeDescription
barDataCrosshairBarData | nullOHLCV of the hovered bar, or null off-chart
interface CrosshairBarData {
open: number;
high: number;
low: number;
close: number;
volume: number;
timestamp: number; // ms
change: number; // close - open, rounded to price precision
changePercent: number; // percent change vs open, 2 decimals
}