@mui/internal-docs-infra
Version:
MUI Infra - internal documentation creation tools.
37 lines • 1.07 kB
TypeScript
import * as React from 'react';
import type { VariantCode, VariantSource } from "../CodeHighlighter/types.js";
import type { TransformedFiles } from "./useCodeUtils.js";
interface UseFileNavigationProps {
selectedVariant: VariantCode | null;
transformedFiles: TransformedFiles | undefined;
mainSlug?: string;
selectedVariantKey?: string;
variantKeys?: string[];
shouldHighlight: boolean;
initialVariant?: string;
}
export interface UseFileNavigationResult {
selectedFileName: string | undefined;
selectedFile: VariantSource | null;
selectedFileComponent: React.ReactNode;
selectedFileLines: number;
files: Array<{
name: string;
slug?: string;
component: React.ReactNode;
}>;
selectFileName: (fileName: string) => void;
}
/**
* Hook for managing file selection and navigation within a code variant
*/
export declare function useFileNavigation({
selectedVariant,
transformedFiles,
mainSlug,
selectedVariantKey,
variantKeys,
initialVariant,
shouldHighlight
}: UseFileNavigationProps): UseFileNavigationResult;
export {};