@wordpress/block-editor/src/components/list-view/README.md

Generic block editor.

# List view

The ListView component provides an overview of the hierarchical structure of all blocks in the editor. The blocks are presented vertically one below the other.

By providing the `rootClientId` prop you can restrict the blocks that are shown to only children of the block with that client id.

Blocks that have child blocks (such as group or column blocks) are presented with the parent at the top and the nested children below.

In addition to presenting the structure of the blocks in the editor, the ListView component lets users navigate to each block by clicking on its line in the hierarchy tree. Multiple blocks at the same level of nesting can be selected by holding down the `SHIFT` key and clicking blocks within the list.

![List view](https://make.wordpress.org/core/files/2020/08/block-navigation.png)
![View of a group list view](https://make.wordpress.org/core/files/2020/08/view-of-group-block-navigation.png)

## Development guidelines

### Usage

Renders a list view with default styles.

```jsx
import { ListView } from '@wordpress/block-editor';

const MyNavigation = () => <ListView />;
```

## Related components

Block Editor components are components that can be used to compose the UI of your block editor. Thus, they can only be used under a [BlockEditorProvider](https://github.com/WordPress/gutenberg/blob/HEAD/packages/block-editor/src/components/provider/README.md) in the components tree.