@atlaskit/onboarding
Version:
An onboarding spotlight introduces new features to users through focused messages or multi-step tours.
19 lines (18 loc) • 1.08 kB
TypeScript
import React, { type ReactElement } from 'react';
interface NodeResolverSpotlightInnerProps {
hasNodeResolver: boolean;
innerRef: (element: HTMLElement | null) => void;
children: ReactElement;
}
/**
* A wrapper component that conditionally applies a NodeResolver to its children.
*
* Note: NodeResolver should not be used in React 18 concurrent mode. This component
* is intended to be removed once the feature flag is removed.
* @param {boolean} props.hasNodeResolver - Determines whether to apply the NodeResolver.
* @param {ReactElement} props.children - The child elements to be wrapped.
* @param {(instance: HTMLDivElement) => void} props.innerRef - A ref callback to get the instance of the HTMLDivElement.
* @returns {ReactElement} The children wrapped with NodeResolver if hasNodeResolver is true, wrape the children in a div setting innerRef with ref to the div.
*/
declare const NodeResolverSpotlightInner: ({ hasNodeResolver, children, innerRef, }: NodeResolverSpotlightInnerProps) => React.JSX.Element;
export default NodeResolverSpotlightInner;