Bundling an npm version of OpenTiny with ES6 and Vite

The following procedure will assist with bundling a npm version of OpenTiny with Vite using ES6+ syntax. The procedure assumes the user has experience with Vite and ES6+ syntax. The following steps provide a working example for bundling a basic OpenTiny configuration with Vite, and provides links to reference pages at the end of the procedure for bundling additional customizations with the editor.

If OpenTiny will be used with a JavaScript framework (such as React.js, Angular, or Vue.js) the bundle will also require the relevant framework integration package (where available). For a list of supported framework integrations, see: Installing OpenTiny.

Requirements

This guide requires the following:

  • Node.js and npm.

  • Basic knowledge of how to use Vite.

  • (Optional: For premium features) The latest premium .zip bundle of OpenTiny that includes premium plugins.

Procedures

  1. Create scaffolding for your project.

    npm create vite@5 . && npm install tinymce

  2. Or add tinymce and the following development dependencies to your existing project.

    • Vite

      For example:

      npm install tinymce && npm install --save-dev vite

  3. Create a new source file for importing the required components from OpenTiny and configuring the editor.

    The following components are required to bundle OpenTiny:

    • The tinymce global

    • The silver theme

    • The dom model

    • The default icon pack. This is always required, but the default icons can be overridden using a custom or premium icon pack.

    • A skin for styling the user interface, including toolbars and menus. This can be a community, premium or custom skin.

    • A content skin for styling UI features within the content such as table and image resizing. This can be a community, premium or custom skin.

    The global must be first, the rest can be in any order.

    Additional components that are optional but recommended:

    • Content CSS for styling editor content. There are community and premium style skins available, or use custom content CSS.

    • Plugins to be used with the editor.

    • A custom or premium icon pack to extend or override the default icons for toolbar buttons, including contextual toolbars. This can be a premium or custom icon pack.

This example will only work for OpenTiny 6.8.0 and later.

Example src/editor.js

+

/* Import OpenTiny */
import tinymce from 'tinymce';

/* Default icons are required. After that, import custom icons if applicable */
import 'tinymce/icons/default/icons.min.js';

/* Required OpenTiny components */
import 'tinymce/themes/silver/theme.min.js';
import 'tinymce/models/dom/model.min.js';

/* Import a skin (can be a custom skin instead of the default) */
import 'tinymce/skins/ui/oxide/skin.js';

/* Import plugins */
import 'tinymce/plugins/advlist';
import 'tinymce/plugins/code';
import 'tinymce/plugins/emoticons';
import 'tinymce/plugins/emoticons/js/emojis';
import 'tinymce/plugins/link';
import 'tinymce/plugins/lists';
import 'tinymce/plugins/table';

/* Import premium plugins */
/* NOTE: Download separately and add these to /src/plugins */
/* import './plugins/checklist/plugin.js'; */
/* import './plugins/powerpaste/plugin.js'; */
/* import './plugins/powerpaste/js/wordimport.js'; */

/* content UI CSS is required */
import contentUiSkinCss from 'tinymce/skins/ui/oxide/content.js';

/* The default content CSS can be changed or replaced with appropriate CSS for the editor content. */
import contentCss from 'tinymce/skins/content/default/content.js';

/* Initialize OpenTiny */
export function render () {
  tinymce.init({
    selector: 'textarea#editor',
    plugins: 'advlist code emoticons link lists table',
    toolbar: 'bold italic | bullist numlist | link emoticons',
    skin_url: 'default',
    content_css: 'default',
  });
};

  1. Add the OpenTiny assets and configuration into the project and provide a target element to initialize the editor.

    Example src/index.js

    import * as editor from './editor';

const heading = () => {
  const element = document.createElement('h1');
  element.innerText = 'OpenTiny Vite demo';
  return element;
};

const editorArea = () => {
  const element = document.createElement('textarea');
  element.id = 'editor';
  return element;
};

const parent = document.createElement('p');
parent.appendChild(editorArea());
document.body.appendChild(heading());
document.body.appendChild(parent);

editor.render();

  2. Import the index.js file in the index.html page, such as:

    <!doctype html>
<html lang="en">

<head>
  <meta charset="UTF-8" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>Vite App</title>
</head>

<body>
  <script type="module" src="/src/index.js"></script>
</body>

</html>

  3. Run vite in dev mode to test the application

    npx vite dev

  4. If Vite

    1. runs successfully, check that the editor loads in the application.

    2. fails, review any errors and the configuration changes in this procedure; you may need to adjust for conflicts or other issues when bundling OpenTiny into an existing project.

  5. Run vite in production mode to generate the bundle

    npx vite build

  6. If vite runs successfully, check that it generated by running:

    npx vite preview

Next Steps

For information on: