@up42/up-components 5.5.3 → 5.6.0

package/dist/cjs/types/components/CodeSnippet/CodeSnippet.d.ts

@@ -1,5 +1,6 @@
 import React from 'react';
-import { SxProps, Theme } from '@mui/material';
+import { BoxProps, SxProps, Theme } from '@mui/material';
+import Prism from 'prismjs';
 import 'prismjs/plugins/line-numbers/prism-line-numbers';
 import 'prismjs/components/prism-json';
 import 'prismjs/components/prism-python';
@@ -7,26 +8,55 @@ import 'prismjs/components/prism-kotlin';
 import 'prismjs/components/prism-java';
 import 'prismjs/components/prism-julia';
 import 'prismjs/components/prism-bash';
-export type Languages = 'DFS' | 'atom' | 'bash' | 'clike' | 'css' | 'extend' | 'html' | 'insertBefore' | 'java' | 'javascript' | 'js' | 'json' | 'julia' | 'kotlin' | 'kt' | 'kts' | 'markup' | 'mathml' | 'plain' | 'plaintext' | 'py' | 'python' | 'rss' | 'sh' | 'shell' | 'ssml' | 'svg' | 'text' | 'txt' | 'webmanifest' | 'xml';
-export interface CodeSnippetItemProps {
+export interface CodeSnippetProps extends Omit<CodeBlockProps, 'code' | 'language'> {
+    snippets: CodeSnippetItemProps[];
+    onCopy?: (code: string) => void;
+    sx?: SxProps<Theme>;
+    /**
+     *  Set value to show specific snippet when component mounts
+     */
+    initialSnippetIndex?: number;
+}
+export interface CodeSnippetItemProps extends CodeBlockProps {
     label: string;
+}
+/**
+ * Documentation: https://up-components.up42.com/?path=/docs/data-display-CodeSnippet--docs
+ */
+export declare const CodeSnippet: ({ snippets, sx, onCopy, initialSnippetIndex, lineNumbers, maxLineLength, }: CodeSnippetProps) => React.JSX.Element;
+export type Languages = keyof typeof Prism.languages;
+export interface CodeBlockProps {
+    /**
+     * the code to display
+     */
     code: string;
+    /**
+     * the language of the code
+     */
     language: Languages;
     /**
      * limit the code height. defaults to 512px, **roughly** 22 lines
      */
     maxCodeHeight?: string;
-}
-export interface CodeSnippetProps {
-    snippets: CodeSnippetItemProps[];
-    onCopy?: (code: string) => void;
-    sx?: SxProps<Theme>;
     /**
-     *  Set value to show specific snippet when component mounts
+     * show line numbers. defaults to true
      */
-    initialSnippetIndex?: number;
+    lineNumbers?: boolean;
+    /**
+     * maximum characters per line before wrapping. defaults to no limit
+     */
+    maxLineLength?: number;
+    /**
+     * additional styles
+     */
+    sx?: BoxProps['sx'];
+    /**
+     * test id
+     */
+    testId?: string;
 }
 /**
- * Documentation: https://up-components.up42.com/?path=/docs/data-display-CodeSnippet--docs
+ * Not moved to a separate file to prevent the build from failing with "(!) Unused external imports" error.
+ * PrismJS generates unused imports, which causes the build to fail when importing this from a separate file.
  */
-export declare const CodeSnippet: ({ snippets, sx, onCopy, initialSnippetIndex }: CodeSnippetProps) => React.JSX.Element;
+export declare function CodeBlock({ code, language, maxCodeHeight, lineNumbers, maxLineLength, sx, testId, }: CodeBlockProps): React.JSX.Element;

package/dist/cjs/types/components/CodeSnippet/languagesMock.d.ts

@@ -0,0 +1,2 @@
+import { Languages } from './CodeSnippet';
+export declare const languagesMock: Record<Languages, string>;

package/dist/cjs/types/index.d.ts

@@ -55,7 +55,7 @@ export { EditTagsButton, type EditTagsButtonProps } from './components/EditTagsB
 export { FeatureFlagCheckbox, type FeatureFlagCheckboxProps, } from './components/FeatureFlagCheckbox/FeatureFlagCheckbox';
 export { DocumentationPopover, type DocumentationPopoverProps, } from './components/DocumentationPopover/DocumentationPopover';
 export { CodeInline, type CodeInlineProps } from './components/CodeInline/CodeInline';
-export { CodeSnippet, type CodeSnippetProps, type CodeSnippetItemProps } from './components/CodeSnippet/CodeSnippet';
+export { CodeSnippet, type CodeSnippetProps, type CodeSnippetItemProps, CodeBlock, type CodeBlockProps, } from './components/CodeSnippet/CodeSnippet';
 export { Table, TableBody, TableCell, TableHead, TableContainer, TableRow, TableFooter, TablePagination, TableSortLabel, type TableProps, type TableBodyProps, type TableCellProps, type TableHeadProps, type TableContainerProps, type TableRowProps, type TableFooterProps, type TablePaginationProps, type TableSortLabelProps, } from './components/Table/Table';
 export { DataGrid, GridRow, GridCell, GridEditInputCell, GridCellModes, GridFooter, GridLoadingOverlay, GridNoRowsOverlay, GridPagination, GridRowCount, GridSelectedRowCount, gridColumnDefinitionsSelector, gridColumnVisibilityModelSelector, gridDetailPanelExpandedRowIdsSelector, gridDetailPanelExpandedRowsContentCacheSelector, gridRowsLookupSelector, GRID_DETAIL_PANEL_TOGGLE_COL_DEF, GRID_DETAIL_PANEL_TOGGLE_FIELD, useGridApiContext, useGridApiRef, useGridSelector, } from './components/DataGrid/DataGrid';
 export type { GridColDef, GridRenderEditCellParams, GridCellModesModel, GridCellParams, GridRenderCellParams, GridRowId, GridRowParams, GridRowSelectionModel, GridRowsProp, GridSortModel, GridTreeNodeWithRender, GridColumnHeaderParams, GridEditCellProps, GridInitialState, GridPreProcessEditCellProps, } from './components/DataGrid/DataGrid';

package/dist/cjs/types/test-setup.d.ts

@@ -0,0 +1 @@
+export {};