polen/build/lib/graphql-document/components/GraphQLDocument.d.ts

A framework for delightful GraphQL developer portals

import type { React } from '#dep/react/index';
import type { GraphQLSchema } from 'graphql';
/**
 * Options for the GraphQL document component
 */
export interface GraphQLDocumentOptions {
    /** Whether to show debug overlays */
    debug?: boolean;
    /** Whether to disable interactive features */
    plain?: boolean;
    /** Custom navigation handler */
    onNavigate?: (url: string) => void;
    /** Whether to validate against schema */
    validate?: boolean;
    /** Custom class name for the container */
    className?: string;
    /** Custom render function for the code block */
    renderCode?: () => React.ReactNode;
}
/**
 * Props for the GraphQL document component
 */
export interface GraphQLDocumentProps {
    /** The GraphQL document source code */
    children: string;
    /** GraphQL schema for validation and linking */
    schema?: GraphQLSchema;
    /** Component options */
    options?: GraphQLDocumentOptions;
}
/**
 * Interactive GraphQL document component
 *
 * Transforms static GraphQL code blocks into interactive documentation
 * with hyperlinks, tooltips, and schema validation.
 */
export declare const GraphQLDocument: React.FC<GraphQLDocumentProps>;
//# sourceMappingURL=GraphQLDocument.d.ts.map