Skip to content
An example playground for TinyMCE 5 Plugins including Dialogs (and Tiny Dialog components), custom SVG icons, and the Tiny Autocomplete UI Component)
Branch: master
Clone or download
martyf Updated readme for new Flags plugin
Signed-off-by: Marty Friedel <1491079+martyf@users.noreply.github.com>
Latest commit 2ed989f Apr 9, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
plugins Added Flags Autocompleter plugin Apr 9, 2019
README.md Updated readme for new Flags plugin Apr 9, 2019
custom-icons.svg Initial init Jan 18, 2019
index.html Added Flags Autocompleter plugin Apr 9, 2019
package.json

README.md

TinyMCE 5 Example Plugin

Developed by Marty Friedel

Last updated April 2019

How to use

Open index.html in a web browser and you're good to go.

You will get an API Key warning given you'll be running it from Tiny's cloud code - just close that warning for now. If you are going to get serious with development, either register with Tiny for continued cloud use, or include TinyMCE in your project.

Alternatively, you can build your own TinyMCE 5 build from the TinyMCE 5.x branch, and host the files locally yourself.

A package.json file is included for you to quickly get TinyMCE running locally - use your favourite package manager (such as NPM, Yarn, etc) to get the build files, and update the JS file in the index.html file and you'll be good to go.

What is where

index.html includes the HTML needed to get up and running, including the TinyMCE init code.

custom-icons.svg has two SVG icons that we can reference in the "helloworld" plugin.

plugins contains the source code and minified code for the "helloworld" and "flags" plugins. The init code for TinyMCE is looking for the .min.js version of the plugin. If you start tinkering, don't forget to either minify your plugin.js file, or update the TinyMCE init to look for the un-minified file.

An introduction to Dialogs

Take a read of my article to show how the plugin got to this stage.

This is for the helloworld plugin.

This article breaks the process down to:

  1. A basic TinyMCE Plugin structure
  2. Extending the Plugin to display a Dialog using TinyMCE 5's UI components
  3. Updating the Dialog after instantiation
  4. Adding custom SVG icons to TinyMCE for the Plugin to use

An introduction to AutoCompleter

Take a read of this article to show how easy it is to get an AutoCompleter plugin up and running.

This is for the flags plugin.

This will help you:

  1. Understand the configuration of the AutoCompleter
  2. Consider where your data needs to come from
  3. Insert your data in to the editor

Don't forget to visit Tiny's website to read all of the documentation for TinyMCE. It will be incredibly useful for you when you start writing your own Plugins.

You can’t perform that action at this time.