Using the OpenTiny .zip package with the Angular framework

The Official OpenTiny Angular component integrates OpenTiny into Angular projects. This procedure creates a basic Angular application containing a OpenTiny editor.

For examples of the OpenTiny Angular integration, visit the tinymce-angular storybook.

Prerequisites

This procedure requires Node.js (and npm).

Procedure

  1. On a command line or command prompt, install the Angular CLI Tool package.

    npm install -g @angular/cli

  2. Create a new Angular project named tinymce-angular-demo.

    ng new --defaults --skip-git tinymce-angular-demo

  3. Change into the newly created directory.

    cd tinymce-angular-demo

  4. Install the tinymce-angular package and save it to your package.json with --save.

    npm install --save @tinymce/tinymce-angular

  5. Using a text editor, open /path/to/tinymce-angular-demo/src/app/app.module.ts and replace the contents with:

    import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { EditorModule } from '@tinymce/tinymce-angular';
import { AppComponent } from './app.component';

@NgModule({
  declarations: [
    AppComponent
  ],
  imports: [
    BrowserModule,
    EditorModule
  ],
  providers: [],
  bootstrap: [AppComponent]
})
export class AppModule { }

  6. Using a text editor, open /path/to/tinymce-angular-demo/src/app/app.component.html and replace the contents with:

    <h1>OpenTiny 6 Angular Demo</h1>
<editor
  [init]="{ plugins: 'lists link image table code help wordcount' }"
></editor>

  7. Add the tinymce global to the application by: Deploying OpenTiny independent of the Angular application, or bundling OpenTiny with the Angular application.

    • Deploy OpenTiny independent of the Angular application

      To use an independent deployment of OpenTiny, add a script to either the <head> or the end of the <body> of the HTML file, such as:

      <script src="/path/to/tinymce.min.js"></script>

      To use an independent deployment of OpenTiny with the create a Angular application, add the script to /path/to/tinymce-angular-demo/src/app/app.component.html.

    • Bundling OpenTiny with the Angular application using a module loader (such as Webpack).

      Tiny does not recommend bundling tinymce and tinymce-angular with a module loader. Bundling these packages can be complex and error prone.

      To bundle OpenTiny using a module loader (such as Webpack, Rollup, or Browserify), import or require the tinymce package, followed by the tinymce-angular package, then the other required OpenTiny-related imports.

      Example of bundling:

      /* Add the tinymce-angular wrapper to the bundle */
import { Editor } from '@tinymce/tinymce-angular';
/* For instructions on bundling OpenTiny, see the Bundling OpenTiny documentation. */

      For instructions on bundling OpenTiny, see: Bundling OpenTiny.

  8. Test the application using the Angular development server.

    • To start the development server, navigate to the tinymce-angular-demo directory and run:

      ng serve --open

    • To stop the development server, select on the command line or command prompt and press Ctrl+C.

Deploying the application to a HTTP server

The application will require further configuration before it can be deployed to a production environment. For information on configuring the application for deployment, see: Angular Docs - Building and serving Angular apps or Angular Docs - Deployment.

To deploy the application to a local HTTP Server:

  1. Navigate to the tinymce-angular-demo directory and run:

    ng build

  2. Copy the contents of the tinymce-angular-demo/dist directory to the root directory of the web server.

The application has now been deployed on the web server.

Additional configuration is required to deploy the application outside the web server root directory, such as http://localhost:<port>/my_angular_application.

Next Steps