@neo4j-ndl/react
Version:
React implementation of Neo4j Design System
44 lines • 1.88 kB
TypeScript
/**
*
* Copyright (c) "Neo4j"
* Neo4j Sweden AB [http://neo4j.com]
*
* This file is part of Neo4j.
*
* Neo4j is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
import { type CodeBlock } from '@neo4j-ndl/react';
import { type CommonProps } from '../../_common/types';
type CodePreviewProps = {
/** The code content to display */
code: string;
/** The language of the code (e.g., 'cypher', 'python', 'javascript') */
language: React.ComponentProps<typeof CodeBlock>['language'];
/** The current state of the code block */
label?: 'read' | 'write';
/** Whether the code block is loading */
isLoading?: boolean;
/** The actions to display in the header. Should be small CleanIconButton components. */
headerActions?: React.ReactNode;
/** The theme of the code block */
theme?: 'ndl-code-dark' | 'ndl-code-light';
};
/**
* The component is used to display code that is generated by an LLM.
*
* @alpha - Changes to this component may be breaking.
*/
export declare const CodePreview: ({ code, language, label, isLoading, headerActions, theme, ref, style, className, htmlAttributes, ...restProps }: CommonProps<"div", CodePreviewProps>) => import("react/jsx-runtime").JSX.Element;
export {};
//# sourceMappingURL=CodePreview.d.ts.map