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

Shared UI components lib

import type { CodeWalkthroughFile, CodeWalkthroughStepAttr, CodeWalkthroughAttr } from '@redocly/config';
import type { WalkthroughStepsState } from '../../types/code-walkthrough';
import { type WalkthroughControlsState } from './use-code-walkthrough-controls';
export type WalkthroughState = {
    stepsState: WalkthroughStepsState;
    controlsState: WalkthroughControlsState;
    downloadAssociatedFiles: CodeWalkthroughFile[];
    files: CodeWalkthroughFile[];
};
type Params = {
    steps: CodeWalkthroughStepAttr[];
    attributes: Omit<CodeWalkthroughAttr, 'steps' | 'preview'>;
    root: React.RefObject<HTMLDivElement | null>;
};
export declare function useCodeWalkthrough({ steps, attributes, root }: Params): WalkthroughState;
export {};