@mantine-vue/code-highlight 3.4.0 → 3.6.0

package/lib/JsonViewer/JsonViewer.d.ts

@@ -0,0 +1,11 @@
+export declare const JsonViewer: import("@mantine-vue/core").MantineComponent<{
+    props: import("./JsonViewer.types").JsonViewerProps;
+    emits: import("./JsonViewer.types").JsonViewerEmits;
+    ref: HTMLDivElement;
+    element: "div";
+    stylesNames: import("./JsonViewer.types").JsonViewerStylesNames;
+    vars: import("./JsonViewer.types").JsonViewerCssVariables;
+}>;
+export type * from './JsonViewer.types';
+export { PATH_SEPARATOR, serializePath } from './json-viewer-utils';
+export { serializePath as serializeJsonViewerPath } from './json-viewer-utils';

package/lib/JsonViewer/JsonViewer.types.d.ts

@@ -0,0 +1,80 @@
+import type { BoxProps, Factory, MantineRadius, MantineSize, StylesApiProps } from '@mantine-vue/core';
+export type JsonViewerStylesNames = 'root' | 'node' | 'toggle' | 'key' | 'value' | 'bracket' | 'type' | 'size' | 'ellipsis' | 'copyButton' | 'content' | 'row' | 'scrollarea' | 'lineNumbers' | 'wrapper' | 'copyAllButton' | 'controls' | 'control';
+export type JsonViewerCssVariables = {
+    root: '--jv-radius' | '--jv-fz' | '--jv-indent';
+};
+export type JsonViewerHighlightType = 'added' | 'removed';
+export interface JsonViewerOwnProps {
+    classNames?: any;
+    styles?: any;
+    vars?: any;
+    unstyled?: boolean;
+    /** JSON data to display */
+    value: any;
+    /** Label displayed for the root node @default false */
+    rootName?: string | false;
+    /** Number of levels to expand by default. Applied only to the `value` present on mount; pass a `key` or use controlled `expandedPaths` to re-apply it after `value` changes. @default 1 */
+    defaultExpandDepth?: number;
+    /** Controlled expanded paths */
+    expandedPaths?: string[];
+    /** Max number of items to show before truncation @default 100 */
+    maxDisplayLength?: number;
+    /** Whether to show type badges next to values @default false */
+    withTypes?: boolean;
+    /** Whether to show item count for objects/arrays @default false */
+    withSize?: boolean;
+    /** Whether to show copy button on hover for individual nodes @default false */
+    withCopy?: boolean;
+    /** Whether to show a copy button to copy the entire JSON @default false */
+    withCopyButton?: boolean;
+    /** Whether to show quotes around string values @default true */
+    withQuotes?: boolean;
+    /** Whether to show quotes around keys @default false */
+    withKeyQuotes?: boolean;
+    /** Collapse strings longer than this value @default false */
+    collapseStringsAfterLength?: number | false;
+    /** Sort object keys @default false */
+    sortKeys?: boolean | ((a: string, b: string) => number);
+    /** Group arrays into chunks when array length exceeds this value @default false */
+    groupArraysAfterLength?: number | false;
+    /** Key of `theme.radius` or any valid CSS value to set border-radius @default 'sm' */
+    radius?: MantineRadius;
+    /** Font size @default '13px' */
+    fontSize?: MantineSize | (string & {}) | number;
+    /** Indent width in px @default 16 */
+    indentWidth?: number;
+    /** Adds border to the root element @default false */
+    withBorder?: boolean;
+    /** Label for copy button @default 'Copy' */
+    copyLabel?: string;
+    /** Label for copied state @default 'Copied' */
+    copiedLabel?: string;
+    /** Label for expand all button @default 'Expand all' */
+    expandAllLabel?: string;
+    /** Label for collapse all button @default 'Collapse all' */
+    collapseAllLabel?: string;
+    /** Whether to show expand all / collapse all controls @default false */
+    withControls?: boolean;
+    /** Map of JSON paths to highlight type ('added' or 'removed'), use serializeJsonViewerPath to build keys */
+    highlightItems?: Record<string, JsonViewerHighlightType>;
+    /** When true, all nodes are expanded and expand/collapse is disabled @default false */
+    allExpanded?: boolean;
+    /** Whether to show line numbers @default false */
+    withLineNumbers?: boolean;
+    /** Whether to show expand/collapse chevrons @default false */
+    withChevrons?: boolean;
+}
+export type JsonViewerProps = Omit<BoxProps, keyof JsonViewerOwnProps> & JsonViewerOwnProps & StylesApiProps<any>;
+export interface JsonViewerEmits {
+    'update:expandedPaths': [paths: string[]];
+    expandedPathsChange: [paths: string[]];
+    valueSelect: [path: string[], value: any];
+}
+export type JsonViewerFactory = Factory<{
+    props: JsonViewerProps;
+    emits: JsonViewerEmits;
+    ref: HTMLDivElement;
+    element: 'div';
+    stylesNames: JsonViewerStylesNames;
+    vars: JsonViewerCssVariables;
+}>;

package/lib/JsonViewer/JsonViewer.vue.d.ts

@@ -0,0 +1,14 @@
+import type { JsonViewerOwnProps } from './JsonViewer.types';
+declare const varsResolver: (theme: import("@mantine-vue/core").MantineTheme, props: any, ctx: Record<string, any>) => Record<string, Record<string, string | undefined>>;
+export { varsResolver };
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: import("vue").DefineComponent<JsonViewerOwnProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    "update:expandedPaths": (paths: string[]) => any;
+    expandedPathsChange: (paths: string[]) => any;
+    valueSelect: (path: string[], value: any) => any;
+}, string, import("vue").PublicProps, Readonly<JsonViewerOwnProps> & Readonly<{
+    "onUpdate:expandedPaths"?: ((paths: string[]) => any) | undefined;
+    onExpandedPathsChange?: ((paths: string[]) => any) | undefined;
+    onValueSelect?: ((path: string[], value: any) => any) | undefined;
+}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;

package/lib/JsonViewer/JsonViewerNode.vue.d.ts

@@ -0,0 +1,32 @@
+import { type JsonViewerArrayChunk } from './json-viewer-utils';
+type __VLS_Props = {
+    value: any;
+    path: string[];
+    nodeKey?: string;
+    level: number;
+    ancestors: object[];
+    expandedPaths: string[];
+    togglePath: (path: string) => void;
+    getStyles: any;
+    maxDisplayLength: number;
+    withTypes: boolean;
+    withSize: boolean;
+    withCopy: boolean;
+    withQuotes: boolean;
+    withKeyQuotes: boolean;
+    collapseStringsAfterLength: number | false;
+    sortKeys: boolean | ((a: string, b: string) => number);
+    groupArraysAfterLength: number | false;
+    copyLabel: string;
+    copiedLabel: string;
+    onValueSelect?: (path: string[], value: any) => void;
+    highlightItems?: Record<string, 'added' | 'removed'>;
+    allExpanded: boolean;
+    withChevrons: boolean;
+    isRoot?: boolean;
+    chunk?: JsonViewerArrayChunk;
+    chunkEntries?: [string, any][];
+};
+declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/lib/JsonViewer/index.d.ts

@@ -0,0 +1,2 @@
+export * from './JsonViewer';
+export { getExpandablePaths, safeStringify } from './json-viewer-utils';

package/lib/JsonViewer/json-viewer-utils.d.ts

@@ -0,0 +1,22 @@
+export declare const PATH_SEPARATOR = "\0";
+export declare const serializePath: (segments: string[]) => string;
+export interface JsonViewerArrayChunk {
+    start: number;
+    end: number;
+}
+export declare function getArrayChunks(length: number, groupArraysAfterLength: number | false): JsonViewerArrayChunk[] | null;
+export declare const getChunkSegment: (chunk: JsonViewerArrayChunk) => string;
+export declare function resolveDisplayValue(value: any): any;
+export declare const isExpandableValue: (value: any) => value is object;
+export declare const getEntries: (value: object) => [string, any][];
+export declare function getExpandablePaths(value: any, { depth, groupArraysAfterLength, }?: {
+    depth?: number;
+    groupArraysAfterLength?: number | false;
+}): string[];
+export declare function getValueType(value: any): "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function" | "null" | "array";
+export declare function getTypeLabel(value: any): "string" | "bigint" | "symbol" | "undefined" | "object" | "function" | "null" | "array" | "int" | "float" | "bool";
+export declare function formatValue(value: any, withQuotes: boolean, collapseStringsAfterLength: number | false): {
+    display: string;
+    collapsed: boolean;
+};
+export declare function safeStringify(value: any): string;

package/lib/index.d.mts

@@ -5,6 +5,7 @@ export { CodeHighlightControl } from './CodeHighlight/CodeHighlightControl/CodeH
 export { useCodeHighlightContext } from './CodeHighlight/CodeHighlight.context';
 export { CodeHighlightAdapterProvider, useHighlight, useIsLanguageLoaded, useLoadLanguage, } from './CodeHighlightProvider/CodeHighlightProvider';
 export { normalizeCode } from './normalize-code';
+export * from './JsonViewer';
 export type { NormalizeCodeOptions } from './normalize-code';
 export { createHighlightJsAdapter } from './CodeHighlightProvider/adapters/highlight-js-adapter';
 export { createShikiAdapter, stripShikiCodeBlocks, } from './CodeHighlightProvider/adapters/shiki-adapter';

package/lib/index.d.ts

@@ -5,6 +5,7 @@ export { CodeHighlightControl } from './CodeHighlight/CodeHighlightControl/CodeH
 export { useCodeHighlightContext } from './CodeHighlight/CodeHighlight.context';
 export { CodeHighlightAdapterProvider, useHighlight, useIsLanguageLoaded, useLoadLanguage, } from './CodeHighlightProvider/CodeHighlightProvider';
 export { normalizeCode } from './normalize-code';
+export * from './JsonViewer';
 export type { NormalizeCodeOptions } from './normalize-code';
 export { createHighlightJsAdapter } from './CodeHighlightProvider/adapters/highlight-js-adapter';
 export { createShikiAdapter, stripShikiCodeBlocks, } from './CodeHighlightProvider/adapters/shiki-adapter';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mantine-vue/code-highlight",
-  "version": "3.4.0",
+  "version": "3.6.0",
   "description": "Vue code highlight components equivalent to @mantine/code-highlight",
   "license": "MIT",
   "files": [
@@ -39,8 +39,8 @@
     "vue": "^3.5.0"
   },
   "peerDependencies": {
-    "@mantine-vue/core": "3.4.0",
-    "@mantine-vue/hooks": "3.4.0",
+    "@mantine-vue/core": "3.6.0",
+    "@mantine-vue/hooks": "3.6.0",
     "vue": "^3.5.0"
   }
 }