videx-3d
Version:
React 3D component library designed for sub surface visualizations in the browser
36 lines (35 loc) • 936 B
TypeScript
import { ReactNode } from 'react';
/**
* Distance props
* @expand
*/
export type DistanceProps = {
min?: number;
max: number;
onDemand?: boolean;
children: ReactNode;
};
/**
* The Distance component can be used to conditionally render other components.
*
* @example
* <Wellbore id={wellboreId}>
* { // DistanceContext provider }
* <WellboreBounds id={wellboreId}>
* <BasicTrajectory />
* <Distance min={0} max={2000}>
* <TubeTrajectory />
* </Distance>
* </WellboreBounds>
* </Wellbore>
*
* @remarks
* This component depends on a `DistanceContext` being provided by a parent component.
*
* @see [Storybook](/videx-3d/?path=/docs/components-misc-distance--docs)
* @see {@link DistanceContext}
* @see {@link WellboreBounds}
*
* @group Components
*/
export declare const Distance: ({ min, max, onDemand, children }: DistanceProps) => import("react/jsx-runtime").JSX.Element;