remirror/remirror

View on GitHub
docs/extensions/list-extension.mdx

Summary

Maintainability
Test Coverage
---
hide_title: true
title: 'ListExtension'
---

import Basic from '../../website/extension-examples/extension-list/basic';
import Collapsible from '../../website/extension-examples/extension-list/collapsible';
import Toggleable from '../../website/extension-examples/extension-list/toggleable';

# `ListExtension`

## Summary

Adds ordered lists, unordered lists, and checklists to the editor.

## Usage

### Installation

This extension is installed for you when you install the main `remirror` package.

You can use the imports in the following way:

```ts
import { ListExtension } from 'remirror/extensions';
```

The extension is provided by the `@remirror/extension-list` package.

### Examples

<Basic />

<Collapsible />

<Toggleable />

## API

- [ListExtension](../api/extension-list)