# ember-ckeditor5

> CKEditor 5 (Balloon build) for Ember apps

Latest version **0.1.2** (published 2018-01-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install ember-ckeditor5
pnpm add ember-ckeditor5
yarn add ember-ckeditor5
bun add ember-ckeditor5
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2018-01-23 |
| First published | 2018-01-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | ^4.5 \|\| 6.* \|\| >= 7.* |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Author | Mike North |
| Maintainers | northm |
| Keywords | ember-addon |

## Links

- npm: https://www.npmjs.com/package/ember-ckeditor5
- Repository: https://github.com/mike-north/ember-ckeditor
- Homepage: https://github.com/mike-north/ember-ckeditor#readme
- Issues: https://github.com/mike-north/ember-ckeditor/issues
- npm.io page: https://npm.io/package/ember-ckeditor5

## Dependencies (3)

- [ember-cli-babel](https://npm.io/package/ember-cli-babel.md) ^6.6.0
- [ember-cli-htmlbars](https://npm.io/package/ember-cli-htmlbars.md) ^2.0.1
- [@ckeditor/ckeditor5-build-balloon](https://npm.io/package/@ckeditor/ckeditor5-build-balloon.md) ^1.0.0-alpha.2

## Recent versions

- 0.1.2 (latest) — 2018-01-23
- 0.1.3 — 2018-01-23
- 0.1.1 — 2018-01-23

## README

# Ember CKEditor [![Build Status](https://travis-ci.org/mike-north/ember-ckeditor5.svg?branch=master)](https://travis-ci.org/mike-north/ember-ckeditor5)

This library is a thin wrapper around the [CKEditor 5](https://docs.ckeditor.com/ckeditor5/latest/index.html) [balloon build](https://docs.ckeditor.com/ckeditor5/latest/builds/guides/overview.html#balloon-editor)

To install this addon, run 

```sh
ember install ember-ckeditor
```

and then use the `{{ck-editor}}` component in your app. You may also directly access the `Balloon Editor` module by importing it

```js
import { BalloonEditor } from 'ember-ckeditor'
```

The `{{ck-editor}}` component yields out an object that can be used on a case-by-case basis to provide some UI around the editor

```hbs
{{#ck-editor value=myHtmlStringValue as |api|}}
  {{!-- A "save" button --}}
  <button onClick={{api.actions.save}}>Save</button>
{{/ck-editor}}
```
and if you provide an `onChange` function, it will be called anytime the value is altered

```hbs
{{ck-editor
  value=myHtmlStringValue
  onChange=(action (mut myHtmlStringValue)) }}
```

# Addon Development

## Installation

* `git clone <repository-url>` this repository
* `cd ember-ckeditor`
* `npm install`

## Running

* `ember serve`
* Visit your app at [http://localhost:4200](http://localhost:4200).

## Running Tests

* `npm test` (Runs `ember try:each` to test your addon against multiple Ember versions)
* `ember test`
* `ember test --server`

## Building

* `ember build`

For more information on using ember-cli, visit [https://ember-cli.com/](https://ember-cli.com/).

---
_Source: https://npm.io/package/ember-ckeditor5 · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._