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

Shared UI components lib

import type { CodeWalkthroughStepAttr } from '@redocly/config';
type ActiveStep = string | null;
type CodeWalkthroughStep = CodeWalkthroughStepAttr & {
    compRef?: HTMLElement;
};
export type WalkthroughStepsState = {
    activeStep: ActiveStep;
    setActiveStep: (stepId: ActiveStep) => void;
    register: (element: HTMLElement) => void;
    unregister: (element: HTMLElement) => void;
    lockObserver?: React.RefObject<boolean>;
    filtersElementRef?: React.RefObject<HTMLDivElement | null>;
};
export declare function useCodeWalkthroughSteps(steps: CodeWalkthroughStep[], enableDeepLink: boolean): WalkthroughStepsState;
export {};