/**
* @fileoverview Scroll-following vertical beam for long-form content.
* @author Saasflareâ„¢
* A vertical line that fills as the user scrolls through the content.
* Ideal for blog posts, documentation, and changelog pages.
* @module packages/ui/components/ui/tracing-beam
* @package ui
*
* @component
* @example
* import { TracingBeam } from '@saasflare/ui';
*
*
*
Getting Started
*
Long form content here...
*
*
*/
import * as React from "react";
import { type ReactNode } from "react";
import { type SaasflareComponentProps } from "../../providers";
/** Props for the TracingBeam component. */
export interface TracingBeamProps extends Omit, keyof SaasflareComponentProps>, SaasflareComponentProps {
/** Content alongside the beam. */
children: ReactNode;
/** Beam color. Default: `"var(--primary)"` */
color?: string;
/** Track (background line) color. Default: `"var(--border)"` */
trackColor?: string;
/** Additional class names. */
className?: string;
}
/**
* Vertical scroll-progress beam alongside content.
*
* - Fills from top to bottom as the user scrolls
* - Renders on the left side with content offset
* - Includes a dot indicator at the current scroll position
* - Falls back to a simple left border when motion is disabled
* (`animated={false}` or reduced-motion preference)
*
* @component
* @package ui
*/
export declare function TracingBeam({ children, color, trackColor, className, surface, radius, animated, iconWeight, ...props }: TracingBeamProps): import("react/jsx-runtime").JSX.Element;