@uiw/react-json-view 1.2.0 → 1.4.0

package/README.md

@@ -4,6 +4,7 @@ react-json-view
 [![CI](https://github.com/uiwjs/react-json-view/actions/workflows/ci.yml/badge.svg)](https://github.com/uiwjs/react-json-view/actions/workflows/ci.yml)
 [![npm version](https://img.shields.io/npm/v/@uiw/react-json-view.svg)](https://www.npmjs.com/package/@uiw/react-json-view)
 [![react@^18](https://shields.io/badge/react-^18-green?style=flat&logo=react)](https://github.com/facebook/react/releases)
+[![Coverage Status](https://uiwjs.github.io/react-json-view/badges.svg)](https://uiwjs.github.io/react-json-view/lcov-report/)
 
 A React component for displaying and editing javascript arrays and JSON objects.
 
@@ -22,7 +23,8 @@ A React component for displaying and editing javascript arrays and JSON objects.
 📚 Use Typescript to write, better code hints.  
 🎨 Support theme customization & [`online editing`](https://uiwjs.github.io/react-json-view/#online-editing-theme) theme  
 🌒 Support dark/light mode  
-📦 Zero dependencies
+📦 Zero dependencies  
+♻️ Whether to highlight updates.
 
 ## Quick Start
 
@@ -111,6 +113,7 @@ const customTheme = {
   '--w-rjv-line-color': '#323232',
   '--w-rjv-arrow-color': 'var(--w-rjv-color)',
   '--w-rjv-info-color': '#656565',
+  '--w-rjv-update-color': '#ebcb8b',
   '--w-rjv-copied-color': '#9cdcfe',
   '--w-rjv-copied-success-color': '#28a745',
 
@@ -140,7 +143,7 @@ export default function Demo() {
 Online custom style example, please check in the [documentation website](https://uiwjs.github.io/react-json-view/)
 
 ```tsx mdx:preview:&title=Online Editing Theme
-import React, { useState, useRef } from 'react';
+import React, { useState, useEffect, useRef } from 'react';
 import Colorful from '@uiw/react-color-colorful';
 import JsonView from '@uiw/react-json-view';
 
@@ -172,6 +175,7 @@ const customTheme = {
   '--w-rjv-line-color': '#323232',
   '--w-rjv-arrow-color': '#9cdcfe',
   '--w-rjv-info-color': '#656565',
+  '--w-rjv-update-color': '#ebcb8b',
   '--w-rjv-copied-color': '#0184a6',
   '--w-rjv-copied-success-color': '#28a745',
 
@@ -197,10 +201,23 @@ export default function Demo() {
     setHex(hexa);
     setTheme({ ...theme, [cssvar]: hexa });
   };
+
+  const [src, setSrc] = useState({ ...object })
+  useEffect(() => {
+    const loop = () => {
+      setSrc(src => ({
+        ...src,
+        timer: src.timer + 1
+      }))
+    }
+    const id = setInterval(loop, 1000)
+    return () => clearInterval(id)
+  }, []);
+
   return (
     <React.Fragment>
       <div style={{ display: 'flex', gap: '1rem' }}>
-        <JsonView value={object} keyName="root" style={{ flex: 1, ...theme }} />
+        <JsonView value={src} keyName="root" style={{ flex: 1, ...theme }} />
         <div>
           <Colorful color={hex} onChange={onChange} />
           <div style={{ display: 'flex', gap: '0.4rem', flexWrap: 'wrap' }}>
@@ -305,6 +322,50 @@ export default function Demo() {
 }
 ```
 
+## Highlight Updates
+
+```tsx mdx:preview
+import React, { useState, useEffect } from 'react';
+import JsonView from '@uiw/react-json-view';
+import { TriangleArrow } from '@uiw/react-json-view/triangle-arrow';
+import { TriangleSolidArrow } from '@uiw/react-json-view/triangle-solid-arrow';
+
+const object = {
+  string: 'Lorem ipsum dolor sit amet',
+  integer: 42,
+  timer: 0,
+  object: { 'first-child': true, 'second-child': false, 'last-child': null },
+}
+export default function Demo() {
+  const [src, setSrc] = useState({ ...object })
+  useEffect(() => {
+    const loop = () => {
+      setSrc(src => ({
+        ...src,
+        timer: src.timer + 1
+      }))
+    }
+    const id = setInterval(loop, 1000)
+    return () => clearInterval(id)
+  }, []);
+
+  return (
+    <JsonView
+      value={src}
+      keyName="root"
+      style={{
+        '--w-rjv-background-color': '#ffffff',
+        '--w-rjv-border-left': '1px dashed #ebebeb',
+        // ✅ Change default update background color ✅
+        '--w-rjv-update-color': '#ff6ffd',
+      }}
+    />
+  )
+}
+```
+
+This feature can be disabled with `highlightUpdates={false}`, and the default color can be changed with `--w-rjv-update-color`.
+
 ## Modify Icon Style
 
 Use built-in default icons.
@@ -424,6 +485,10 @@ export interface JsonViewProps<T> extends React.DetailedHTMLProps<React.HTMLAttr
   keyName?: string | number;
   /** The user can copy objects and arrays to clipboard by clicking on the clipboard icon. @default true */
   enableClipboard?: boolean;
+  /** Whether to highlight updates. @default true */
+  highlightUpdates?: boolean;
+  /** Whether sort keys through `String.prototype.localeCompare()` @default false */
+  objectSortKeys?: boolean | ((a: string, b: string) => number);
   /** Display for quotes in object-key @default " */
   quotes?: "'" | '"' | '';
   /** When set to true, all nodes will be collapsed by default. Use an integer value to collapse at a particular depth. @default false */
@@ -435,6 +500,8 @@ export interface JsonViewProps<T> extends React.DetailedHTMLProps<React.HTMLAttr
     keyid: string;
     keyName?: string | number;
   }) => void;
+  /** Fires event when you copy */
+  onCopied?: CopiedProps<T>['onCopied'];
   /** Redefine interface elements to re-render. */
   components?: {
     braces?: MetaProps['render'];
@@ -442,6 +509,7 @@ export interface JsonViewProps<T> extends React.DetailedHTMLProps<React.HTMLAttr
     arrow?: JSX.Element;
     objectKey?: SemicolonProps['render'];
     value?: ValueViewProps<T>['renderValue'];
+    copied?: CopiedProps<T>['render'];
   };
 }
 declare const JsonView: React.ForwardRefExoticComponent<Omit<JsonViewProps<object>, "ref"> & React.RefAttributes<HTMLDivElement>>;

package/cjs/copied.d.ts

@@ -2,7 +2,7 @@
 export interface CopiedProps<T = object> extends React.SVGProps<SVGSVGElement> {
     show?: boolean;
     text?: T;
-    onCopied?: (text: string, obj: T) => void;
+    onCopied?: (text: string, obj: T | '') => void;
     render?: (props: Omit<CopiedProps<T>, 'render'>) => JSX.Element;
 }
 export declare function Copied<T>(props: CopiedProps<T>): JSX.Element | null;

package/cjs/copied.js

@@ -10,12 +10,13 @@ var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/sli
 var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
 var _react = require("react");
 var _jsxRuntime = require("react/jsx-runtime");
-var _excluded = ["children", "style", "text", "render", "show"];
+var _excluded = ["children", "style", "text", "onCopied", "render", "show"];
 function Copied(props) {
   var children = props.children,
     style = props.style,
     _props$text = props.text,
     text = _props$text === void 0 ? '' : _props$text,
+    onCopied = props.onCopied,
     render = props.render,
     show = props.show,
     reset = (0, _objectWithoutProperties2["default"])(props, _excluded);
@@ -26,7 +27,7 @@ function Copied(props) {
     setCopied = _useState2[1];
   var click = function click(event) {
     event.stopPropagation();
-    var copyText = JSON.stringify(text, function (key, value) {
+    var copyText = JSON.stringify(text || '', function (key, value) {
       if (typeof value === 'bigint') {
         return value.toString();
       }
@@ -34,6 +35,7 @@ function Copied(props) {
     }, 2);
     if (text === Infinity) copyText = Infinity;
     navigator.clipboard.writeText(copyText).then(function () {
+      onCopied && onCopied(copyText, text);
       setCopied(true);
       var timer = setTimeout(function () {
         setCopied(false);

package/cjs/index.d.ts

@@ -1,5 +1,6 @@
 import React from 'react';
-import { MetaProps, SemicolonProps, EllipsisProps } from './node';
+import { MetaProps, EllipsisProps } from './node';
+import { SemicolonProps } from './semicolon';
 import { ValueViewProps } from './value';
 import { CopiedProps } from './copied';
 export * from './node';
@@ -17,6 +18,10 @@ export interface JsonViewProps<T extends object> extends React.DetailedHTMLProps
     keyName?: string | number;
     /** The user can copy objects and arrays to clipboard by clicking on the clipboard icon. @default true */
     enableClipboard?: boolean;
+    /** Whether to highlight updates. @default true */
+    highlightUpdates?: boolean;
+    /** Whether sort keys through `String.prototype.localeCompare()` @default false */
+    objectSortKeys?: boolean | ((a: string, b: string) => number);
     /** Display for quotes in object-key @default " */
     quotes?: "'" | '"' | '';
     /** When set to true, all nodes will be collapsed by default. Use an integer value to collapse at a particular depth. @default false */

package/cjs/node.d.ts

@@ -11,13 +11,6 @@ export interface EllipsisProps extends React.HTMLAttributes<HTMLSpanElement> {
     render?: (props: EllipsisProps) => JSX.Element;
 }
 export declare const Ellipsis: FC<PropsWithChildren<EllipsisProps>>;
-export interface SemicolonProps extends LabelProps {
-    show?: boolean;
-    quotes?: JsonViewProps<object>['quotes'];
-    value?: object;
-    render?: (props: Omit<SemicolonProps, 'show'> & {}) => JSX.Element;
-}
-export declare const Semicolon: FC<PropsWithChildren<SemicolonProps>>;
 export declare const CountInfo: FC<PropsWithChildren<LabelProps>>;
 export interface RooNodeProps<T extends object> extends JsonViewProps<T> {
     keyName?: string | number;

package/cjs/node.js

@@ -7,7 +7,6 @@ Object.defineProperty(exports, "__esModule", {
 exports.Ellipsis = exports.CountInfo = void 0;
 exports.Meta = Meta;
 exports.RooNode = RooNode;
-exports.Semicolon = void 0;
 var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
@@ -17,11 +16,11 @@ var _value = require("./value");
 var _TriangleArrow = require("./arrow/TriangleArrow");
 var _store = require("./store");
 var _copied = require("./copied");
+var _semicolon = require("./semicolon");
 var _jsxRuntime = require("react/jsx-runtime");
 var _excluded = ["isArray", "start", "className", "render"],
   _excluded2 = ["style", "render"],
-  _excluded3 = ["children", "render", "color", "value", "className", "show", "quotes"],
-  _excluded4 = ["value", "keyName", "displayDataTypes", "components", "displayObjectSize", "enableClipboard", "indentWidth", "collapsed", "level", "keyid", "quotes", "onCopied", "onExpand"];
+  _excluded3 = ["value", "keyName", "className", "displayDataTypes", "components", "displayObjectSize", "enableClipboard", "highlightUpdates", "objectSortKeys", "indentWidth", "collapsed", "level", "keyid", "quotes", "onCopied", "onExpand"];
 function Meta(props) {
   var _props$isArray = props.isArray,
     isArray = _props$isArray === void 0 ? false : _props$isArray,
@@ -69,36 +68,8 @@ var Ellipsis = function Ellipsis(_ref) {
   }));
 };
 exports.Ellipsis = Ellipsis;
-var Semicolon = function Semicolon(_ref2) {
-  var children = _ref2.children,
-    render = _ref2.render,
-    color = _ref2.color,
-    value = _ref2.value,
-    _ref2$className = _ref2.className,
-    className = _ref2$className === void 0 ? 'w-rjv-object-key' : _ref2$className,
-    show = _ref2.show,
-    quotes = _ref2.quotes,
-    props = (0, _objectWithoutProperties2["default"])(_ref2, _excluded3);
-  var content = show ? "".concat(quotes).concat(children).concat(quotes) : children;
-  if (render) return render((0, _objectSpread2["default"])((0, _objectSpread2["default"])({
-    className: className
-  }, props), {}, {
-    value: value,
-    style: {
-      color: color
-    },
-    children: content
-  }));
-  return /*#__PURE__*/(0, _jsxRuntime.jsx)(_value.Label, (0, _objectSpread2["default"])((0, _objectSpread2["default"])({
-    className: className,
-    color: color
-  }, props), {}, {
-    children: content
-  }));
-};
-exports.Semicolon = Semicolon;
-var CountInfo = function CountInfo(_ref3) {
-  var children = _ref3.children;
+var CountInfo = function CountInfo(_ref2) {
+  var children = _ref2.children;
   return /*#__PURE__*/(0, _jsxRuntime.jsx)(_value.Label, {
     style: {
       paddingLeft: 4,
@@ -115,6 +86,7 @@ function RooNode(props) {
   var _props$value = props.value,
     value = _props$value === void 0 ? {} : _props$value,
     keyName = props.keyName,
+    className = props.className,
     _props$displayDataTyp = props.displayDataTypes,
     displayDataTypes = _props$displayDataTyp === void 0 ? true : _props$displayDataTyp,
     _props$components = props.components,
@@ -123,6 +95,10 @@ function RooNode(props) {
     displayObjectSize = _props$displayObjectS === void 0 ? true : _props$displayObjectS,
     _props$enableClipboar = props.enableClipboard,
     enableClipboard = _props$enableClipboar === void 0 ? true : _props$enableClipboar,
+    _props$highlightUpdat = props.highlightUpdates,
+    highlightUpdates = _props$highlightUpdat === void 0 ? true : _props$highlightUpdat,
+    _props$objectSortKeys = props.objectSortKeys,
+    objectSortKeys = _props$objectSortKeys === void 0 ? false : _props$objectSortKeys,
     _props$indentWidth = props.indentWidth,
     indentWidth = _props$indentWidth === void 0 ? 15 : _props$indentWidth,
     collapsed = props.collapsed,
@@ -134,11 +110,8 @@ function RooNode(props) {
     quotes = _props$quotes === void 0 ? '"' : _props$quotes,
     onCopied = props.onCopied,
     onExpand = props.onExpand,
-    reset = (0, _objectWithoutProperties2["default"])(props, _excluded4);
+    reset = (0, _objectWithoutProperties2["default"])(props, _excluded3);
   var isArray = Array.isArray(value);
-  var nameKeys = isArray ? Object.keys(value).map(function (m) {
-    return Number(m);
-  }) : Object.keys(value);
   var subkeyid = (0, _react.useId)();
   var expands = (0, _store.useExpandsStatus)();
   var expand = (_expands$keyid = expands[keyid]) !== null && _expands$keyid !== void 0 ? _expands$keyid : typeof collapsed === 'boolean' ? collapsed : typeof collapsed === 'number' ? level <= collapsed : true;
@@ -161,6 +134,7 @@ function RooNode(props) {
     displayDataTypes: displayDataTypes,
     displayObjectSize: displayObjectSize,
     enableClipboard: enableClipboard,
+    highlightUpdates: highlightUpdates,
     onCopied: onCopied,
     onExpand: onExpand,
     collapsed: collapsed,
@@ -205,8 +179,31 @@ function RooNode(props) {
       return setShowTools(false);
     };
   }
+  var nameKeys = isArray ? Object.keys(value).map(function (m) {
+    return Number(m);
+  }) : Object.keys(value);
+
+  // object
+  var entries = isArray ? Object.entries(value).map(function (m) {
+    return [Number(m[0]), m[1]];
+  }) : Object.entries(value);
+  if (objectSortKeys) {
+    entries = objectSortKeys === true ? entries.sort(function (_ref3, _ref4) {
+      var _ref5 = (0, _slicedToArray2["default"])(_ref3, 1),
+        a = _ref5[0];
+      var _ref6 = (0, _slicedToArray2["default"])(_ref4, 1),
+        b = _ref6[0];
+      return typeof a === 'string' && typeof b === 'string' ? a.localeCompare(b) : 0;
+    }) : entries.sort(function (_ref7, _ref8) {
+      var _ref9 = (0, _slicedToArray2["default"])(_ref7, 1),
+        a = _ref9[0];
+      var _ref10 = (0, _slicedToArray2["default"])(_ref8, 1),
+        b = _ref10[0];
+      return typeof a === 'string' && typeof b === 'string' ? objectSortKeys(a, b) : 0;
+    });
+  }
   return /*#__PURE__*/(0, _jsxRuntime.jsxs)("div", (0, _objectSpread2["default"])((0, _objectSpread2["default"])((0, _objectSpread2["default"])({}, reset), {}, {
-    className: "w-rjv-inner"
+    className: "".concat(className, " w-rjv-inner")
   }, eventProps), {}, {
     children: [/*#__PURE__*/(0, _jsxRuntime.jsxs)(_value.Line, {
       style: {
@@ -215,7 +212,7 @@ function RooNode(props) {
       },
       onClick: handle,
       children: [arrowView, (typeof keyName === 'string' || typeof keyName === 'number') && /*#__PURE__*/(0, _jsxRuntime.jsxs)(_react.Fragment, {
-        children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(Semicolon, {
+        children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(_semicolon.Semicolon, {
           value: value,
           quotes: quotes,
           render: components.objectKey,
@@ -241,11 +238,15 @@ function RooNode(props) {
         borderLeft: 'var(--w-rjv-border-left-width, 1px) solid var(--w-rjv-line-color, #ebebeb)',
         marginLeft: 6
       },
-      children: nameKeys.length > 0 && nameKeys.map(function (key, idx) {
-        var item = value[key];
-        var renderKey = /*#__PURE__*/(0, _jsxRuntime.jsx)(Semicolon, {
+      children: entries.length > 0 && entries.map(function (_ref11, idx) {
+        var _ref12 = (0, _slicedToArray2["default"])(_ref11, 2),
+          key = _ref12[0],
+          itemVal = _ref12[1];
+        var item = itemVal;
+        var renderKey = /*#__PURE__*/(0, _jsxRuntime.jsx)(_semicolon.Semicolon, {
           value: item,
           quotes: quotes,
+          highlightUpdates: highlightUpdates,
           render: components.objectKey,
           color: typeof key === 'number' ? _value.typeMap['number'].color : '',
           show: typeof key === 'string',
@@ -271,7 +272,7 @@ function RooNode(props) {
               value: item,
               keyName: key
             }, subNodeProps))
-          }, key + idx);
+          }, key + '' + idx);
         }
         if (typeof item === 'function') {
           return;

package/cjs/semicolon.d.ts

@@ -0,0 +1,12 @@
+import { FC, PropsWithChildren } from 'react';
+import { LabelProps } from './value';
+import { JsonViewProps } from './';
+export declare function usePrevious<T>(value: T): T | undefined;
+export interface SemicolonProps extends LabelProps {
+    show?: boolean;
+    highlightUpdates?: boolean;
+    quotes?: JsonViewProps<object>['quotes'];
+    value?: object;
+    render?: (props: Omit<SemicolonProps, 'show'> & {}) => JSX.Element;
+}
+export declare const Semicolon: FC<PropsWithChildren<SemicolonProps>>;

package/cjs/semicolon.js

@@ -0,0 +1,94 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault")["default"];
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Semicolon = void 0;
+exports.usePrevious = usePrevious;
+var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
+var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
+var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
+var _react = require("react");
+var _value = require("./value");
+var _jsxRuntime = require("react/jsx-runtime");
+var _excluded = ["children", "render", "color", "value", "className", "show", "highlightUpdates", "quotes", "style"];
+function usePrevious(value) {
+  var ref = (0, _react.useRef)();
+  (0, _react.useEffect)(function () {
+    ref.current = value;
+  });
+  return ref.current;
+}
+var Semicolon = function Semicolon(_ref) {
+  var children = _ref.children,
+    render = _ref.render,
+    color = _ref.color,
+    value = _ref.value,
+    _ref$className = _ref.className,
+    className = _ref$className === void 0 ? 'w-rjv-object-key' : _ref$className,
+    show = _ref.show,
+    highlightUpdates = _ref.highlightUpdates,
+    quotes = _ref.quotes,
+    style = _ref.style,
+    props = (0, _objectWithoutProperties2["default"])(_ref, _excluded);
+  var prevValue = usePrevious(value);
+  var highlightContainer = (0, _react.useRef)(null);
+  var isHighlight = (0, _react.useMemo)(function () {
+    if (!highlightUpdates || prevValue === undefined) return false;
+    // highlight if value type changed
+    if ((0, _typeof2["default"])(value) !== (0, _typeof2["default"])(prevValue)) {
+      return true;
+    }
+    if (typeof value === 'number') {
+      // notice: NaN !== NaN
+      if (isNaN(value) && isNaN(prevValue)) return false;
+      return value !== prevValue;
+    }
+    // highlight if isArray changed
+    if (Array.isArray(value) !== Array.isArray(prevValue)) {
+      return true;
+    }
+    // not highlight object/function
+    // deep compare they will be slow
+    if ((0, _typeof2["default"])(value) === 'object' || typeof value === 'function') {
+      return false;
+    }
+
+    // highlight if not equal
+    if (value !== prevValue) {
+      return true;
+    }
+    return false;
+  }, [highlightUpdates, value]);
+  (0, _react.useEffect)(function () {
+    if (highlightContainer.current && isHighlight && 'animate' in highlightContainer.current) {
+      highlightContainer.current.animate([{
+        backgroundColor: 'var(--w-rjv-update-color, #ebcb8b)'
+      }, {
+        backgroundColor: ''
+      }], {
+        duration: 1000,
+        easing: 'ease-in'
+      });
+    }
+  }, [isHighlight, value]);
+  var content = show ? "".concat(quotes).concat(children).concat(quotes) : children;
+  if (render) return render((0, _objectSpread2["default"])((0, _objectSpread2["default"])({
+    className: className
+  }, props), {}, {
+    value: value,
+    style: (0, _objectSpread2["default"])((0, _objectSpread2["default"])({}, style), {}, {
+      color: color
+    }),
+    children: content
+  }));
+  return /*#__PURE__*/(0, _jsxRuntime.jsx)(_value.Label, (0, _objectSpread2["default"])((0, _objectSpread2["default"])({
+    className: className,
+    color: color
+  }, props), {}, {
+    ref: highlightContainer,
+    children: content
+  }));
+};
+exports.Semicolon = Semicolon;

package/cjs/theme/dark.d.ts

@@ -5,6 +5,7 @@ export declare const darkTheme: {
     '--w-rjv-line-color': string;
     '--w-rjv-arrow-color': string;
     '--w-rjv-info-color': string;
+    '--w-rjv-update-color': string;
     '--w-rjv-copied-color': string;
     '--w-rjv-copied-success-color': string;
     '--w-rjv-curlybraces-color': string;

package/cjs/theme/dark.js

@@ -11,6 +11,7 @@ var darkTheme = {
   '--w-rjv-line-color': '#323232',
   '--w-rjv-arrow-color': 'var(--w-rjv-color)',
   '--w-rjv-info-color': '#656565',
+  '--w-rjv-update-color': '#ebcb8b',
   '--w-rjv-copied-color': '#0184a6',
   '--w-rjv-copied-success-color': '#28a745',
   '--w-rjv-curlybraces-color': '#1896b6',

package/cjs/theme/light.d.ts

@@ -5,6 +5,7 @@ export declare const lightTheme: {
     '--w-rjv-line-color': string;
     '--w-rjv-arrow-color': string;
     '--w-rjv-info-color': string;
+    '--w-rjv-update-color': string;
     '--w-rjv-copied-color': string;
     '--w-rjv-copied-success-color': string;
     '--w-rjv-curlybraces-color': string;

package/cjs/theme/light.js

@@ -11,6 +11,7 @@ var lightTheme = {
   '--w-rjv-line-color': '#ebebeb',
   '--w-rjv-arrow-color': 'var(--w-rjv-color)',
   '--w-rjv-info-color': '#0000004d',
+  '--w-rjv-update-color': '#ebcb8b',
   '--w-rjv-copied-color': '#002b36',
   '--w-rjv-copied-success-color': '#28a745',
   '--w-rjv-curlybraces-color': '#236a7c',

package/cjs/value.d.ts

@@ -41,7 +41,7 @@ export declare const typeMap: {
 };
 export declare const Colon: FC<PropsWithChildren<React.HTMLAttributes<HTMLSpanElement>>>;
 export interface ValueViewProps<T> extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLSpanElement>, HTMLSpanElement> {
-    keyName?: string;
+    keyName?: string | number;
     value?: T;
     displayDataTypes: boolean;
     displayObjectSize: boolean;
@@ -60,7 +60,7 @@ export interface LabelProps extends React.HTMLAttributes<HTMLSpanElement> {
     opacity?: number;
     paddingRight?: number;
 }
-export declare const Label: FC<PropsWithChildren<LabelProps>>;
+export declare const Label: import("react").ForwardRefExoticComponent<LabelProps & import("react").RefAttributes<HTMLSpanElement>>;
 export interface TypeProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLSpanElement>, HTMLSpanElement> {
     type: keyof typeof typeMap;
 }

package/cjs/value.js

@@ -174,6 +174,7 @@ function ValueView(props) {
     });
     return /*#__PURE__*/(0, _jsxRuntime.jsx)(Line, (0, _objectSpread2["default"])((0, _objectSpread2["default"])({}, eventProps), {}, {
       children: /*#__PURE__*/(0, _jsxRuntime.jsxs)(Label, (0, _objectSpread2["default"])((0, _objectSpread2["default"])({}, reset), {}, {
+        ref: null,
         children: [renderKey, /*#__PURE__*/(0, _jsxRuntime.jsx)(Colon, {}), typeView, valueView, tools]
       }))
     }));
@@ -193,11 +194,12 @@ function ValueView(props) {
   });
   return /*#__PURE__*/(0, _jsxRuntime.jsx)(Line, (0, _objectSpread2["default"])((0, _objectSpread2["default"])({}, eventProps), {}, {
     children: /*#__PURE__*/(0, _jsxRuntime.jsxs)(Label, (0, _objectSpread2["default"])((0, _objectSpread2["default"])({}, reset), {}, {
+      ref: null,
       children: [renderKey, /*#__PURE__*/(0, _jsxRuntime.jsx)(Colon, {}), typeView, empty, tools]
     }))
   }));
 }
-var Label = function Label(_ref2) {
+var Label = /*#__PURE__*/(0, _react.forwardRef)(function (_ref2, ref) {
   var children = _ref2.children,
     color = _ref2.color,
     fontSize = _ref2.fontSize,
@@ -213,9 +215,10 @@ var Label = function Label(_ref2) {
       paddingRight: paddingRight
     }, style)
   }, reset), {}, {
+    ref: ref,
     children: children
   }));
-};
+});
 exports.Label = Label;
 var Type = function Type(props) {
   var _typeMap$type2, _typeMap$type3;

package/esm/copied.d.ts

@@ -2,7 +2,7 @@
 export interface CopiedProps<T = object> extends React.SVGProps<SVGSVGElement> {
     show?: boolean;
     text?: T;
-    onCopied?: (text: string, obj: T) => void;
+    onCopied?: (text: string, obj: T | '') => void;
     render?: (props: Omit<CopiedProps<T>, 'render'>) => JSX.Element;
 }
 export declare function Copied<T>(props: CopiedProps<T>): JSX.Element | null;

package/esm/copied.js

@@ -1,12 +1,13 @@
 import _extends from "@babel/runtime/helpers/extends";
 import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/objectWithoutPropertiesLoose";
-var _excluded = ["children", "style", "text", "render", "show"];
+var _excluded = ["children", "style", "text", "onCopied", "render", "show"];
 import { useState } from 'react';
 import { jsx as _jsx } from "react/jsx-runtime";
 export function Copied(props) {
   var {
       style,
       text = '',
+      onCopied,
       render,
       show
     } = props,
@@ -15,7 +16,7 @@ export function Copied(props) {
   var [copied, setCopied] = useState(false);
   var click = event => {
     event.stopPropagation();
-    var copyText = JSON.stringify(text, (key, value) => {
+    var copyText = JSON.stringify(text || '', (key, value) => {
       if (typeof value === 'bigint') {
         return value.toString();
       }
@@ -23,6 +24,7 @@ export function Copied(props) {
     }, 2);
     if (text === Infinity) copyText = Infinity;
     navigator.clipboard.writeText(copyText).then(() => {
+      onCopied && onCopied(copyText, text);
       setCopied(true);
       var timer = setTimeout(() => {
         setCopied(false);

package/esm/index.d.ts

@@ -1,5 +1,6 @@
 import React from 'react';
-import { MetaProps, SemicolonProps, EllipsisProps } from './node';
+import { MetaProps, EllipsisProps } from './node';
+import { SemicolonProps } from './semicolon';
 import { ValueViewProps } from './value';
 import { CopiedProps } from './copied';
 export * from './node';
@@ -17,6 +18,10 @@ export interface JsonViewProps<T extends object> extends React.DetailedHTMLProps
     keyName?: string | number;
     /** The user can copy objects and arrays to clipboard by clicking on the clipboard icon. @default true */
     enableClipboard?: boolean;
+    /** Whether to highlight updates. @default true */
+    highlightUpdates?: boolean;
+    /** Whether sort keys through `String.prototype.localeCompare()` @default false */
+    objectSortKeys?: boolean | ((a: string, b: string) => number);
     /** Display for quotes in object-key @default " */
     quotes?: "'" | '"' | '';
     /** When set to true, all nodes will be collapsed by default. Use an integer value to collapse at a particular depth. @default false */

package/esm/node.d.ts

@@ -11,13 +11,6 @@ export interface EllipsisProps extends React.HTMLAttributes<HTMLSpanElement> {
     render?: (props: EllipsisProps) => JSX.Element;
 }
 export declare const Ellipsis: FC<PropsWithChildren<EllipsisProps>>;
-export interface SemicolonProps extends LabelProps {
-    show?: boolean;
-    quotes?: JsonViewProps<object>['quotes'];
-    value?: object;
-    render?: (props: Omit<SemicolonProps, 'show'> & {}) => JSX.Element;
-}
-export declare const Semicolon: FC<PropsWithChildren<SemicolonProps>>;
 export declare const CountInfo: FC<PropsWithChildren<LabelProps>>;
 export interface RooNodeProps<T extends object> extends JsonViewProps<T> {
     keyName?: string | number;

package/esm/node.js

@@ -2,13 +2,13 @@ import _extends from "@babel/runtime/helpers/extends";
 import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/objectWithoutPropertiesLoose";
 var _excluded = ["isArray", "start", "className", "render"],
   _excluded2 = ["style", "render"],
-  _excluded3 = ["children", "render", "color", "value", "className", "show", "quotes"],
-  _excluded4 = ["value", "keyName", "displayDataTypes", "components", "displayObjectSize", "enableClipboard", "indentWidth", "collapsed", "level", "keyid", "quotes", "onCopied", "onExpand"];
+  _excluded3 = ["value", "keyName", "className", "displayDataTypes", "components", "displayObjectSize", "enableClipboard", "highlightUpdates", "objectSortKeys", "indentWidth", "collapsed", "level", "keyid", "quotes", "onCopied", "onExpand"];
 import { Fragment, useId, cloneElement, useState } from 'react';
 import { ValueView, Colon, Label, Line, typeMap } from './value';
 import { TriangleArrow } from './arrow/TriangleArrow';
 import { useExpandsStatus, store } from './store';
 import { Copied } from './copied';
+import { Semicolon } from './semicolon';
 import { jsx as _jsx } from "react/jsx-runtime";
 import { jsxs as _jsxs } from "react/jsx-runtime";
 export function Meta(props) {
@@ -59,38 +59,10 @@ export var Ellipsis = _ref => {
     children: "..."
   }));
 };
-export var Semicolon = _ref2 => {
-  var {
-      children,
-      render,
-      color,
-      value,
-      className = 'w-rjv-object-key',
-      show,
-      quotes
-    } = _ref2,
-    props = _objectWithoutPropertiesLoose(_ref2, _excluded3);
-  var content = show ? "" + quotes + children + quotes : children;
-  if (render) return render(_extends({
-    className
-  }, props, {
-    value,
-    style: {
-      color
-    },
-    children: content
-  }));
-  return /*#__PURE__*/_jsx(Label, _extends({
-    className: className,
-    color: color
-  }, props, {
-    children: content
-  }));
-};
-export var CountInfo = _ref3 => {
+export var CountInfo = _ref2 => {
   var {
     children
-  } = _ref3;
+  } = _ref2;
   return /*#__PURE__*/_jsx(Label, {
     style: {
       paddingLeft: 4,
@@ -106,10 +78,13 @@ export function RooNode(props) {
   var {
       value = {},
       keyName,
+      className,
       displayDataTypes = true,
       components = {},
       displayObjectSize = true,
       enableClipboard = true,
+      highlightUpdates = true,
+      objectSortKeys = false,
       indentWidth = 15,
       collapsed,
       level = 1,
@@ -118,9 +93,8 @@ export function RooNode(props) {
       onCopied,
       onExpand
     } = props,
-    reset = _objectWithoutPropertiesLoose(props, _excluded4);
+    reset = _objectWithoutPropertiesLoose(props, _excluded3);
   var isArray = Array.isArray(value);
-  var nameKeys = isArray ? Object.keys(value).map(m => Number(m)) : Object.keys(value);
   var subkeyid = useId();
   var expands = useExpandsStatus();
   var expand = (_expands$keyid = expands[keyid]) != null ? _expands$keyid : typeof collapsed === 'boolean' ? collapsed : typeof collapsed === 'number' ? level <= collapsed : true;
@@ -143,6 +117,7 @@ export function RooNode(props) {
     displayDataTypes,
     displayObjectSize,
     enableClipboard,
+    highlightUpdates,
     onCopied,
     onExpand,
     collapsed,
@@ -180,8 +155,23 @@ export function RooNode(props) {
     eventProps.onMouseEnter = () => setShowTools(true);
     eventProps.onMouseLeave = () => setShowTools(false);
   }
+  var nameKeys = isArray ? Object.keys(value).map(m => Number(m)) : Object.keys(value);
+
+  // object
+  var entries = isArray ? Object.entries(value).map(m => [Number(m[0]), m[1]]) : Object.entries(value);
+  if (objectSortKeys) {
+    entries = objectSortKeys === true ? entries.sort((_ref3, _ref4) => {
+      var [a] = _ref3;
+      var [b] = _ref4;
+      return typeof a === 'string' && typeof b === 'string' ? a.localeCompare(b) : 0;
+    }) : entries.sort((_ref5, _ref6) => {
+      var [a] = _ref5;
+      var [b] = _ref6;
+      return typeof a === 'string' && typeof b === 'string' ? objectSortKeys(a, b) : 0;
+    });
+  }
   return /*#__PURE__*/_jsxs("div", _extends({}, reset, {
-    className: "w-rjv-inner"
+    className: className + " w-rjv-inner"
   }, eventProps, {
     children: [/*#__PURE__*/_jsxs(Line, {
       style: {
@@ -216,11 +206,13 @@ export function RooNode(props) {
         borderLeft: 'var(--w-rjv-border-left-width, 1px) solid var(--w-rjv-line-color, #ebebeb)',
         marginLeft: 6
       },
-      children: nameKeys.length > 0 && nameKeys.map((key, idx) => {
-        var item = value[key];
+      children: entries.length > 0 && entries.map((_ref7, idx) => {
+        var [key, itemVal] = _ref7;
+        var item = itemVal;
         var renderKey = /*#__PURE__*/_jsx(Semicolon, {
           value: item,
           quotes: quotes,
+          highlightUpdates: highlightUpdates,
           render: components.objectKey,
           color: typeof key === 'number' ? typeMap['number'].color : '',
           show: typeof key === 'string',
@@ -246,7 +238,7 @@ export function RooNode(props) {
               value: item,
               keyName: key
             }, subNodeProps))
-          }, key + idx);
+          }, key + '' + idx);
         }
         if (typeof item === 'function') {
           return;

package/esm/semicolon.d.ts

@@ -0,0 +1,12 @@
+import { FC, PropsWithChildren } from 'react';
+import { LabelProps } from './value';
+import { JsonViewProps } from './';
+export declare function usePrevious<T>(value: T): T | undefined;
+export interface SemicolonProps extends LabelProps {
+    show?: boolean;
+    highlightUpdates?: boolean;
+    quotes?: JsonViewProps<object>['quotes'];
+    value?: object;
+    render?: (props: Omit<SemicolonProps, 'show'> & {}) => JSX.Element;
+}
+export declare const Semicolon: FC<PropsWithChildren<SemicolonProps>>;

package/esm/semicolon.js

@@ -0,0 +1,85 @@
+import _extends from "@babel/runtime/helpers/extends";
+import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/objectWithoutPropertiesLoose";
+var _excluded = ["children", "render", "color", "value", "className", "show", "highlightUpdates", "quotes", "style"];
+import { useMemo, useRef, useEffect } from 'react';
+import { Label } from './value';
+import { jsx as _jsx } from "react/jsx-runtime";
+export function usePrevious(value) {
+  var ref = useRef();
+  useEffect(() => {
+    ref.current = value;
+  });
+  return ref.current;
+}
+export var Semicolon = _ref => {
+  var {
+      children,
+      render,
+      color,
+      value,
+      className = 'w-rjv-object-key',
+      show,
+      highlightUpdates,
+      quotes,
+      style
+    } = _ref,
+    props = _objectWithoutPropertiesLoose(_ref, _excluded);
+  var prevValue = usePrevious(value);
+  var highlightContainer = useRef(null);
+  var isHighlight = useMemo(() => {
+    if (!highlightUpdates || prevValue === undefined) return false;
+    // highlight if value type changed
+    if (typeof value !== typeof prevValue) {
+      return true;
+    }
+    if (typeof value === 'number') {
+      // notice: NaN !== NaN
+      if (isNaN(value) && isNaN(prevValue)) return false;
+      return value !== prevValue;
+    }
+    // highlight if isArray changed
+    if (Array.isArray(value) !== Array.isArray(prevValue)) {
+      return true;
+    }
+    // not highlight object/function
+    // deep compare they will be slow
+    if (typeof value === 'object' || typeof value === 'function') {
+      return false;
+    }
+
+    // highlight if not equal
+    if (value !== prevValue) {
+      return true;
+    }
+    return false;
+  }, [highlightUpdates, value]);
+  useEffect(() => {
+    if (highlightContainer.current && isHighlight && 'animate' in highlightContainer.current) {
+      highlightContainer.current.animate([{
+        backgroundColor: 'var(--w-rjv-update-color, #ebcb8b)'
+      }, {
+        backgroundColor: ''
+      }], {
+        duration: 1000,
+        easing: 'ease-in'
+      });
+    }
+  }, [isHighlight, value]);
+  var content = show ? "" + quotes + children + quotes : children;
+  if (render) return render(_extends({
+    className
+  }, props, {
+    value,
+    style: _extends({}, style, {
+      color
+    }),
+    children: content
+  }));
+  return /*#__PURE__*/_jsx(Label, _extends({
+    className: className,
+    color: color
+  }, props, {
+    ref: highlightContainer,
+    children: content
+  }));
+};

package/esm/theme/dark.d.ts

@@ -5,6 +5,7 @@ export declare const darkTheme: {
     '--w-rjv-line-color': string;
     '--w-rjv-arrow-color': string;
     '--w-rjv-info-color': string;
+    '--w-rjv-update-color': string;
     '--w-rjv-copied-color': string;
     '--w-rjv-copied-success-color': string;
     '--w-rjv-curlybraces-color': string;

package/esm/theme/dark.js

@@ -5,6 +5,7 @@ export var darkTheme = {
   '--w-rjv-line-color': '#323232',
   '--w-rjv-arrow-color': 'var(--w-rjv-color)',
   '--w-rjv-info-color': '#656565',
+  '--w-rjv-update-color': '#ebcb8b',
   '--w-rjv-copied-color': '#0184a6',
   '--w-rjv-copied-success-color': '#28a745',
   '--w-rjv-curlybraces-color': '#1896b6',

package/esm/theme/light.d.ts

@@ -5,6 +5,7 @@ export declare const lightTheme: {
     '--w-rjv-line-color': string;
     '--w-rjv-arrow-color': string;
     '--w-rjv-info-color': string;
+    '--w-rjv-update-color': string;
     '--w-rjv-copied-color': string;
     '--w-rjv-copied-success-color': string;
     '--w-rjv-curlybraces-color': string;

package/esm/theme/light.js

@@ -5,6 +5,7 @@ export var lightTheme = {
   '--w-rjv-line-color': '#ebebeb',
   '--w-rjv-arrow-color': 'var(--w-rjv-color)',
   '--w-rjv-info-color': '#0000004d',
+  '--w-rjv-update-color': '#ebcb8b',
   '--w-rjv-copied-color': '#002b36',
   '--w-rjv-copied-success-color': '#28a745',
   '--w-rjv-curlybraces-color': '#236a7c',

package/esm/value.d.ts

@@ -41,7 +41,7 @@ export declare const typeMap: {
 };
 export declare const Colon: FC<PropsWithChildren<React.HTMLAttributes<HTMLSpanElement>>>;
 export interface ValueViewProps<T> extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLSpanElement>, HTMLSpanElement> {
-    keyName?: string;
+    keyName?: string | number;
     value?: T;
     displayDataTypes: boolean;
     displayObjectSize: boolean;
@@ -60,7 +60,7 @@ export interface LabelProps extends React.HTMLAttributes<HTMLSpanElement> {
     opacity?: number;
     paddingRight?: number;
 }
-export declare const Label: FC<PropsWithChildren<LabelProps>>;
+export declare const Label: import("react").ForwardRefExoticComponent<LabelProps & import("react").RefAttributes<HTMLSpanElement>>;
 export interface TypeProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLSpanElement>, HTMLSpanElement> {
     type: keyof typeof typeMap;
 }

package/esm/value.js

@@ -3,7 +3,7 @@ import _extends from "@babel/runtime/helpers/extends";
 var _excluded = ["children", "style"],
   _excluded2 = ["value", "keyName", "indentWidth", "renderKey", "renderValue", "renderBraces", "enableClipboard", "displayObjectSize", "displayDataTypes"],
   _excluded3 = ["children", "color", "fontSize", "opacity", "paddingRight", "style"];
-import { Fragment, useState } from 'react';
+import { Fragment, forwardRef, useState } from 'react';
 import { Meta, CountInfo } from './node';
 import { Copied } from './copied';
 import { jsx as _jsx } from "react/jsx-runtime";
@@ -152,6 +152,7 @@ export function ValueView(props) {
     });
     return /*#__PURE__*/_jsx(Line, _extends({}, eventProps, {
       children: /*#__PURE__*/_jsxs(Label, _extends({}, reset, {
+        ref: null,
         children: [renderKey, /*#__PURE__*/_jsx(Colon, {}), typeView, valueView, tools]
       }))
     }));
@@ -171,11 +172,12 @@ export function ValueView(props) {
   });
   return /*#__PURE__*/_jsx(Line, _extends({}, eventProps, {
     children: /*#__PURE__*/_jsxs(Label, _extends({}, reset, {
+      ref: null,
       children: [renderKey, /*#__PURE__*/_jsx(Colon, {}), typeView, empty, tools]
     }))
   }));
 }
-export var Label = _ref2 => {
+export var Label = /*#__PURE__*/forwardRef((_ref2, ref) => {
   var {
       children,
       color,
@@ -193,9 +195,10 @@ export var Label = _ref2 => {
       paddingRight
     }, style)
   }, reset, {
+    ref: ref,
     children: children
   }));
-};
+});
 export var Type = props => {
   var _typeMap$type2, _typeMap$type3;
   var {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uiw/react-json-view",
-  "version": "1.2.0",
+  "version": "1.4.0",
   "description": "JSON viewer for react.",
   "main": "cjs/index.js",
   "module": "esm/index.js",
@@ -74,7 +74,10 @@
     "treeview"
   ],
   "devDependencies": {
+    "@testing-library/react": "^14.0.0",
+    "@types/react-test-renderer": "^18.0.0",
     "react": "^18.2.0",
-    "react-dom": "^18.2.0"
+    "react-dom": "^18.2.0",
+    "react-test-renderer": "^18.2.0"
   }
 }