# ListKit

Bundles BulletList, OrderedList, ListItem and ListKeymap. These children are already included in StarterKit.

Bundles BulletList, OrderedList, ListItem and ListKeymap. These children are already included in StarterKit.

`@quirekit/extension-list` · **MIT**

## Editor compatibility
Layer：**Shared document capability**
| Editor | Status | Assembly and boundaries |
| --- | --- | --- |
| Classic | Supported | [classicEditorPreset](/en/plugins/reference/classic-editor-preset) — Use the product-neutral classicEditorPreset without duplicating installed capabilities. The Word preset replaces paragraphs, headings and container lists; do not stack generic structures onto that model. |
| Block | Supported | [createBlockEditorPreset](/en/plugins/reference/create-block-editor-preset) — The default createBlockEditor preset installs this capability. Configure the corresponding preset child; graphic editing uses the preset's workspace ports, while persistence and assets remain host-owned. Avoid duplicate extensions. |

“Supported” means the product assembly above exists; interaction, host services and file formats retain their own conditions. See [status and integration rules](/en/plugins/compatibility). Licensing is shown separately.

## Installation

```sh
pnpm add @quirekit/extension-list@alpha
```

Install in Editor extensions. The host supplies a view, container and persistence; see [Quick start](/en/guide/quick-start).

```ts
import { ListKit } from '@quirekit/extension-list'

const lists = ListKit.configure({ orderedList: false })
```

Use compatible versions available from your distribution source. This site uses the Alpha workspace. License labels come from package metadata; see [support and licensing](/en/support).

## Integration by editor

These snippets use an existing host element named element. The host owns container sizing and persistence; call instance.destroy() on teardown. Avoid duplicating preset capabilities and supply required host ports before installation.

### Classic

Use the product-neutral classicEditorPreset without duplicating installed capabilities. The Word preset replaces paragraphs, headings and container lists; do not stack generic structures onto that model.

[classicEditorPreset](/en/plugins/reference/classic-editor-preset)

```ts
import { createClassicEditor } from '@quirekit/classic-editor'
import '@quirekit/classic-editor/styles.css'

const instance = createClassicEditor({ element })
```

### Block

The default createBlockEditor preset installs this capability. Configure the corresponding preset child; graphic editing uses the preset's workspace ports, while persistence and assets remain host-owned. Avoid duplicate extensions.

[createBlockEditorPreset](/en/plugins/reference/create-block-editor-preset)

```ts
import { createBlockEditor } from '@quirekit/block-editor'
import '@quirekit/block-editor/styles.css'

const instance = createBlockEditor({
  element,
  content: { type: 'doc', content: [{ type: 'paragraph' }] },
})
```

## Configuration

These are extension-level defaults. Presets can override them; they are distinct from current document attributes. See [configuration](/en/plugins/configuration).

### bulletList

Bullet list options, or false to omit the extension.

Type：`false | Partial<BulletListOptions>`

Default：`{}`

See [BulletList](/en/plugins/reference/bullet-list) for child settings. Only pass false when this field's type permits it.

### listItem

List item options, or false to omit the extension.

Type：`false | Partial<ListItemOptions>`

Default：`{}`

See [ListItem](/en/plugins/reference/list-item) for child settings. Only pass false when this field's type permits it.

### listKeymap

List keymap options, or false to omit the extension.

Type：`false | Partial<ListKeymapOptions>`

Default：`{}`

See [ListKeymap](/en/plugins/reference/list-keymap) for child settings. Only pass false when this field's type permits it.

### orderedList

Ordered list options, or false to omit the extension.

Type：`false | Partial<OrderedListOptions>`

Default：`{}`

See [OrderedList](/en/plugins/reference/ordered-list) for child settings. Only pass false when this field's type permits it.

## Commands and runtime

This entry declares no directly enumerable commands. Children supply bundle commands; product plugins use contributions or document services.

## Next steps

Return to [all plugins](/en/plugins), or read [configuration](/en/plugins/configuration) to distinguish options, attributes and commands.

See [extension development](/en/build/extension) for custom capabilities and [Build a product](/en/build) for complete hosting.