Skip to content

Teradata/covalent-text-editor-nightly

Repository files navigation

TdTextEditorComponent: td-text-editor

<td-text-editor> element generates an easymde markdown editor.

API Summary

Inputs

Properties

  • isPreviewActive?: function()
    • is the Preview Active. Returns boolean
  • isSideBySideActive?: function()
    • is the Side By Side Active. Returns boolean
  • isFullscreenActive?: function()
    • is Full Screen Active. Returns boolean
  • clearAutosavedValue?: function()
    • clears Auto Saved Value. Returns void
  • toTextArea?: function()
    • reverts to the Initial textarea. Returns void
  • easyMDE?: function()
    • getter function for the underlying easyMDE Object. Returns EasyMDE

Installation

This component can be installed as npm package.

npm install @covalent/text-editor

Setup

Import the CovalentTextEditorModule in your NgModule:

import { CovalentTextEditorModule } from '@covalent/text-editor';
@NgModule({
  imports: [
    CovalentTextEditorModule,
    ...
  ],
  ...
})
export class MyModule {}

Usage

<td-text-editor [value]="Some Text" [options]="options"></td-text-editor>
class MyComponent {
  options: any = {
    lineWrapping: true,
    toolbar: false,
    ...
  };
}