ame

angular2-medium-editor

Angular 2 directive for Medium.com editor clone

Showing:

Popularity

Downloads/wk

5

GitHub Stars

24

Maintenance

Last Commit

3yrs ago

Contributors

19

Package

Dependencies

1

License

MIT

Type Definitions

Built-In

Tree-Shakeable

Yes?

Categories

Readme

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, and forked from progress made by Thijs on angular-medium-editor.

Currently updated to support Angular 7

Import the Module

Install with Npm:

$ npm install --save angular2-medium-editor

Medium editor is a required peer dependency, so you'll need to install it alongside this angular wrapper:

$ npm install --save medium-editor

The angular2-medium-editor package should import medium-editor from your node_modules.

Finally, import the module into your project:

import { MediumEditorModule } from 'angular2-medium-editor'
  @NgModule({
    ...
    bootstrap: [ AppComponent ],
    imports: [
      MediumEditorModule,
      ...

The module provides the directive to your app, and you're ready to use it in your templates.

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.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial