Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/wecatch/ember-cli-simditor

Ember component wrapper for simditor editor
https://github.com/wecatch/ember-cli-simditor

ember simditor

Last synced: 2 months ago
JSON representation

Ember component wrapper for simditor editor

Awesome Lists containing this project

README

        

# Ember-cli-simditor

[![Build Status](https://github.com/wecatch/ember-cli-simditor/actions/workflows/ci.yml/badge.svg)](https://github.com/wecatch/ember-cli-simditor/actions)
[![Downloads](https://img.shields.io/npm/dt/ember-cli-simditor.svg)](https://www.npmjs.com/package/ember-cli-simditor)
[![Version](https://img.shields.io/npm/v/ember-cli-simditor.svg)](https://www.npmjs.com/package/ember-cli-simditor)

Ember component wrapper for [simditor](https://github.com/mycolorway/simditor).

# Changes

## 1.0.0

- Upgrade Ember to 3.85
- Use native class rewrite addon
- Lock simditor dependence
- Change ci to github action

## 0.0.7

Different from previous version, you must wrap content in object. See [issue 6](https://github.com/wecatch/ember-cli-simditor/issues/6) for why.

# Getting Started

## Installation

In your ember-cli project, install this addon from npm

```
ember install ember-cli-simditor
```

or install the latest version from github

```
ember install git+https://github.com/wecatch/ember-cli-simditor
```

## Usage

```

```

You must wrap content in one object, that means model object must have one property called `content` for component to render, visit [issue 6](https://github.com/wecatch/ember-cli-simditor/issues/6) for why.

By default the content property name is `content`, you can custome the property name with `name` argument

```

```

## Locale

English by default

```

```

Chinese

```

```

## API

- [Options](http://simditor.tower.im/docs/doc-config.html)
- [Methods](http://simditor.tower.im/docs/doc-method.html)
- [Events](http://simditor.tower.im/docs/doc-event.html)

In this addon , `on` prefix must be used for all events name. For sample, valuechanged => OnValuechanged.

- valuechanged => onValuechanged
- selectionchanged => onSelectionchanged
- decorate => onDecorate
- undecorate = > onUndecorate
- pasting => onPasting
- blur => onBlur
- destroy => onDestroy

## Running Tests

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