@redocly/theme/lib/core/hooks/code-walkthrough/use-code-walkthrough-steps.d.ts

Shared UI components lib

import type { CodeWalkthroughStepAttr } from '@redocly/config';
import type { WalkthroughStepsState } from '../../types/code-walkthrough';
type CodeWalkthroughStep = CodeWalkthroughStepAttr & {
    compRef?: HTMLElement;
    markerRef?: HTMLElement;
};
type Params = {
    steps: CodeWalkthroughStep[];
    enableDeepLink: boolean;
    root: React.RefObject<HTMLDivElement | null>;
};
export declare function useCodeWalkthroughSteps({ steps, enableDeepLink, root, }: Params): WalkthroughStepsState;
type StepsGroup = {
    freeSpace: number;
    usedSpace: number;
    offset: number;
    steps: {
        offset: number;
        height: number;
        ref?: HTMLElement;
    }[];
};
export declare function getGroupMarkers(group: StepsGroup): number[];
export {};