Skip to content

feat: add replacer prop to convert data #196

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat: add replacer prop to convert data #196

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1df324c
feat: add replacer prop to convert data
m-shaka Sep 12, 2025
8616607
docs: add `replacer` to README
m-shaka Sep 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,25 @@ When `sortObjectKeys={true}` is provided, keys of objects are sorted in alphabet
: <ObjectLabel name={name} data={data} isNonenumerable={isNonenumerable} />;
```

**`replacer: PropTypes.func`:** Use a custom `replacer` to replace the object properties like `replacer` argument in `JSON.stringify` (optional)

```js
import { ObjectInspector } from 'react-inspector'

const replacer = ({ data }) => {
// replace the array data with the first 10 elements
if (Array.isArray(data)) {
return data.slice(0, 10);
}
return data;
}

const MyComponent = ({ data }) =>
<div>
<ObjectInspector data={data} replacer={replacer} />
</div>
```

### &lt;TableInspector />

Like `console.table`.
Expand Down
24 changes: 14 additions & 10 deletions src/object-inspector/ObjectInspector.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import { getPropertyValue } from '../utils/propertyUtils';

import { themeAcceptor } from '../styles';

const createIterator = (showNonenumerable: any, sortObjectKeys: any) => {
const createIterator = (showNonenumerable: any, sortObjectKeys: any, replacer?: (args: { name: any, data: any }) => any) => {
const objectIterator = function* (data: any) {
const shouldIterate = (typeof data === 'object' && data !== null) || typeof data === 'function';
if (!shouldIterate) return;
Expand All @@ -24,12 +24,13 @@ const createIterator = (showNonenumerable: any, sortObjectKeys: any) => {
const [k, v] = entry;
yield {
name: k,
data: v,
data: replacer?.({ name: k, data: v }) ?? v,
};
} else {
const name = i.toString();
yield {
name: i.toString(),
data: entry,
name: name,
data: replacer?.({ name, data: entry }) ?? entry,
};
}
i++;
Expand All @@ -46,9 +47,10 @@ const createIterator = (showNonenumerable: any, sortObjectKeys: any) => {
for (const propertyName of keys) {
if (propertyIsEnumerable.call(data, propertyName)) {
const propertyValue = getPropertyValue(data, propertyName);
const name = propertyName || `""`;
yield {
name: propertyName || `""`,
data: propertyValue,
name,
data: replacer?.({ name, data: propertyValue }) ?? propertyValue,
};
} else if (showNonenumerable) {
// To work around the error (happens some time when propertyName === 'caller' || propertyName === 'arguments')
Expand All @@ -65,7 +67,7 @@ const createIterator = (showNonenumerable: any, sortObjectKeys: any) => {
if (propertyValue !== undefined) {
yield {
name: propertyName,
data: propertyValue,
data: replacer?.({ name: propertyName, data: propertyValue }) ?? propertyValue,
isNonenumerable: true,
};
}
Expand All @@ -75,9 +77,11 @@ const createIterator = (showNonenumerable: any, sortObjectKeys: any) => {
// [[Prototype]] of the object: `Object.getPrototypeOf(data)`
// the property name is shown as "__proto__"
if (showNonenumerable && data !== Object.prototype /* already added */) {
const name = '__proto__';
const _data = Object.getPrototypeOf(data);
yield {
name: '__proto__',
data: Object.getPrototypeOf(data),
data: replacer?.({ name, data: _data }) ?? _data,
isNonenumerable: true,
};
}
Expand All @@ -97,8 +101,8 @@ const defaultNodeRenderer = ({ depth, name, data, isNonenumerable }: any) =>
/**
* Tree-view for objects
*/
const ObjectInspector: FC<any> = ({ showNonenumerable = false, sortObjectKeys, nodeRenderer, ...treeViewProps }) => {
const dataIterator = createIterator(showNonenumerable, sortObjectKeys);
const ObjectInspector: FC<any> = ({ showNonenumerable = false, sortObjectKeys, nodeRenderer, replacer, ...treeViewProps }) => {
const dataIterator = createIterator(showNonenumerable, sortObjectKeys, replacer);
const renderer = nodeRenderer ? nodeRenderer : defaultNodeRenderer;

return <TreeView nodeRenderer={renderer} dataIterator={dataIterator} {...treeViewProps} />;
Expand Down