angular2-medium-editor

This is an Angular 2 directive for the Medium.com inline editor clone by Davi Ferreira, derived from the AngularJS medium editor directive.

Installing the Directive

Install with Npm:

$ npm install --save angular2-medium-editor

It is required to include the Medium editor in your Angular 2 project as well.

$ npm install --save medium-editor

If all goes well, the angular2-medium-editor package should import medium-editor from your node_modules.

Finally, import the directive into your project:

  import { MediumEditorDirective } from 'angular2-medium-editor/medium-editor.directive.ts';

And add the directive to your Declarations:

  @NgModule({
    ...
    bootstrap: [ AppComponent ],
    declarations: [
      MediumEditorDirective,
      ...

Usage

Use as an element:

  <medium-editor [(editorModel)]="textVar"
      [editorOptions]="{'toolbar': {'buttons': ['bold', 'italic', 'underline', 'h1', 'h2', 'h3']}}" 
      [editorPlaceholder]="placeholderVar"></medium-editor>

You can optionally pass a placeholder value:

  <medium-editor [(editorModel)]="textVar"
      [editorOptions]="{'toolbar': {'buttons': ['bold', 'italic', 'underline', 'h1', 'h2', 'h3']}}" 
      [editorPlaceholder]="placeholderVar"></medium-editor>

For more information on which options you can pass with [editorOptions], check MediumEditor's options documentation for details.

License

The MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.