This repository contains plugins built for MediaElementJS.
- Author(s): John Dyer http://j.hn/ and Rafael Miranda https://github.com/ron666
- Website: http://mediaelementjs.com/
- License: MIT
- Contributors: all contributors
Table of Contents
- Guidelines to Contribute
- Available plugins
* IMPORTANT CHANGES on
As part of the continuous improvements the player, we have decided to drop completely support for IE9 and IE10, since market share of those browsers together is 0.4%, according to http://caniuse.com/usage-table.
This change is for
MediaElement Plugins repositories.
Download the package from https://github.com/mediaelement/mediaelement-plugins, and reference any plugins you need from
dist folder and add any configuration related to the plugin.
Or you can use a CDN; check https://cdnjs.com/libraries/mediaelement-plugins.
For example, if you want to install
Speed plugin do the following:
<!-- Include any languages from `build/lang` folder --><!-- Translation file for plugin (includes ALL languages available on player)-->
Some of them will contain CSS styles so place them after the main player stylesheet:
Guidelines to Contribute
Download it at https://nodejs.org/ and follow the steps to install it, or install
Once installed, at the command prompt, type
npm install, which will download all the necessary tools.
- Tab size is 8 for indentation.
- ALWAYS make changes to the files in the
/src/directory, and NEVER in
/dist/directory. This is with the sole purpose of facilitating the merging (and further, the compiling) operation, and help people to see changes more easily.
- Use JSDoc conventions to document code. This facilitates the contributions of other developers and ensures more quality in the product.
- BEFORE PUSHING any changes, run
npm run eslintto ensure code quality.
- The file for the feature must be placed inside a folder matching its name, as well as any SVG/CSS elements needed (i.e,
package.jsonwith a command under the
scriptconfiguration to make sure it will be bundled and compiled properly. For more reference, review the file.
- Make sure you also create a
docs/FEATURE_NAME.mdfile describing its purpose, API, etc., and add the name with a link to its document in the
READMEfile to keep documentation up-to-date.
- DO NOT REINVENT THE WHEEL: Use the utilities that
MediaElementprovides for DOM manipulation/AJAX/etc. Check this link for more details.
- You can also include CSS inside the feature folder, matching the name of the feature JS file and adding CSS styles for "legacy" and BEM naming convention.
- If using an icon, its size MUST be 20x20px, so it matches all the rest of the icons' dimensions.
Template to create a Feature
'use strict';/*** [Name of feature]** [Description]*/// If plugin needs translations, put here English one in this format:// mejs.i18n.en["mejs.id1"] = "String 1";// mejs.i18n.en["mejs.id2"] = "String 2";// Feature configurationObject;Object;
Template for Translations
If translatable strings are part of the plugin, you will need to create a
[feature_name]-i18n.js file with this format:
'use strict';if mejsi18nca !== undefinedmejsi18nca"mejs.id1" = "";if mejsi18ncs !== undefinedmejsi18ncs"mejs.id1" = "";// And the rest of the languages
NOTE: The more languages are integrated on
MediaElementPlayer, the bigger this template will become.
Also, if you are adding a new language to
MediaElementPlayer, you will need to add it in all the existing
i18n files in the same way described in the template above.
A word on
ES6 for Features
All the features are written using
Ecmascript 2015 specifications.
src/ directory, and check how the files were written to ensure compatibility.
for...of loop could have been used, but in order to bundle them and reduce the size of the bundled files, it is strongly recommended to avoid its use.
- Context Menu
- Facebook Pixel
- Google Analytics
- Google Tag Manager
- Jump Forward
- Skip Back
- Source Chooser
Changes available at Change Log