ckeditor/ckeditor5-enter

View on GitHub
docs/api/enter.md

Summary

Maintainability
Test Coverage
---
category: api-reference
---

# CKEditor 5 Enter feature

[![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-enter.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-enter)

This package implements the <kbd>Enter</kbd> and <kbd>Shift</kbd>+<kbd>Enter</kbd> key support for CKEditor 5.

## Documentation

See the {@link module:enter/enter~Enter} and {@link module:enter/shiftenter~ShiftEnter} plugin documentation.

The plugins are usually enabled by the {@link module:essentials/essentials~Essentials} plugin from the {@link api/essentials `@ckeditor/ckeditor5-essentials`} package (which also enables other fundamental editing features).

## Installation

```bash
npm install --save @ckeditor/ckeditor5-enter
```

## Contribute

The source code of this package is available on GitHub in https://github.com/ckeditor/ckeditor5/tree/master/packages/ckeditor5-enter.

## External links

* [`@ckeditor/ckeditor5-enter` on npm](https://www.npmjs.com/package/@ckeditor/ckeditor5-enter)
* [`ckeditor/ckeditor5-enter` on GitHub](https://github.com/ckeditor/ckeditor5/tree/master/packages/ckeditor5-enter)
* [Issue tracker](https://github.com/ckeditor/ckeditor5/issues)
* [Changelog](https://github.com/ckeditor/ckeditor5-enter/blob/master/CHANGELOG.md)