@devtools-ds/object-inspector/src/stories/Overview.stories.mdx

An emulation of the Chrome and Firefox object inspector, which allows you to view JavaScript objects in the console.

import {
  Meta,
  Description,
  Title,
  Canvas,
  Story,
} from "@storybook/addon-docs/blocks";
import { Version } from "@doc-blocks/version";
import { ShieldRow } from "@doc-blocks/shield-row";

import notes from "../../README.md";
import { version } from "../../package.json";

<Meta title="Components/Object Inspector/Overview" parameters={{ notes }} />

<Title>@devtools-ds/object-inspector</Title>

---

<ShieldRow>
  <Version
    current={version}
    url="https://github.com/intuit/devtools-ds/tree/master/components/ObjectInspector/CHANGELOG.md"
  />
</ShieldRow>

<Description />

<br />

## Usage

The `ObjectInspector` component displays JavaScript objects in an expandable tree view.

<Canvas>
  <Story id="components-object-inspector-features--basic-usage" />
</Canvas>

### Default Open

You can use the `expandLevel` prop to open the inspector to a specific level by default.

<Canvas>
  <Story id="components-object-inspector-features--default-open" />
</Canvas>

### Sorting Keys

By default, the inspector mirrors the browser behavior and sorts keys. You can disable this with the sortKeys prop.

<Canvas>
  <Story id="components-object-inspector-features--disable-sorting" />
</Canvas>

### Removing Prototypes

Similarly, you can disable object `prototypes` from being included.

<Canvas>
  <Story id="components-object-inspector-features--disable-prototypes" />
</Canvas>

### onSelect

You can use the `onSelect` prop to get the `@devtools-ds/object-parser` AST node for the currently selected part of the object.
This includes the `parent` of the node so everything should be traversable.

<Canvas>
  <Story id="components-object-inspector-features--on-select-callback" />
</Canvas>