moodle/lib/editor/tiny/amd/src/defaults.js

// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/* eslint-disable max-len,  */

/**
 * TinyMCE Editor Upstream defaults.
 *
 * @module     editor_tiny/defaults
 * @copyright  2022 Andrew Lyons <andrew@nicols.co.uk>
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

/**
 * The upstream defaults for the TinyMCE Menu.
 *
 * This value is defined in the TinyMCE documentation, but not exported anywhere useful.
 * https://www.tiny.cloud/docs/tinymce/6/menus-configuration-options/#menu
 *
 * @returns {Object}
 */
export const getDefaultMenu = () => {
    return {
        file: {title: 'File', items: 'newdocument restoredraft | preview | export print | deleteallconversations'},
        edit: {title: 'Edit', items: 'undo redo | cut copy paste pastetext | selectall | searchreplace'},
        view: {title: 'View', items: 'code | visualaid visualchars visualblocks | spellchecker | preview fullscreen | showcomments'},
        insert: {title: 'Insert', items: 'image link media addcomment pageembed template codesample inserttable | charmap emoticons hr | pagebreak nonbreaking anchor tableofcontents | insertdatetime'},
        format: {title: 'Format', items: 'bold italic underline strikethrough superscript subscript codeformat | styles blocks fontfamily fontsize align lineheight | forecolor backcolor | language | removeformat'},
        tools: {title: 'Tools', items: 'spellchecker spellcheckerlanguage | a11ycheck code wordcount'},
        table: {title: 'Table', items: 'inserttable | cell row column | advtablesort | tableprops deletetable'},
        help: {title: 'Help', items: 'help'}
    };
};

/**
 * The default toolbar configuration to use.
 *
 * This is based upon the default value used if no toolbar is specified.
 *
 * https://www.tiny.cloud/docs/tinymce/6/menus-configuration-options/#menu
 *
 * @returns {Object}
 */
export const getDefaultToolbar = () => {
    return [
        {
            name: 'history',
            items: [
                'undo',
                'redo',
            ],
        },
        {
            name: 'formatting',
            items: [
                'bold',
                'italic',
            ],
        },
        {
            name: 'view',
            items: ['fullscreen'],
        },
        {
            name: 'alignment',
            items: [
                'alignleft',
                'aligncenter',
                'alignright',
                'alignjustify',
            ],
        },
        {
            name: 'indentation',
            items: [
                'outdent',
                'indent',
            ],
        },
        {
            name: 'lists',
            items: [
                'bullist',
                'numlist',
            ],
        },
        {
            name: 'comments',
            items: ['addcomment'],
        },
    ];
};

/**
 * The default quickbars_insert_toolbar configuration to use.
 *
 * This is based upon the default value used if no toolbar is specified.
 *
 * https://www.tiny.cloud/docs/tinymce/6/quickbars/#quickbars_selection_toolbar
 *
 * @returns {string}
 */
export const getDefaultQuickbarsSelectionToolbar = () => 'bold italic | quicklink h2 h3 blockquote';

/**
 * The default quickbars_insert_toolbar configuration to use.
 *
 * This is based upon the default value used if no toolbar is specified.
 *
 * https://www.tiny.cloud/docs/tinymce/6/quickbars/#quickbars_insert_toolbar
 *
 * @returns {string}
 */
export const getDefaultQuickbarsInsertToolbar = () => 'quickimage quicktable';

/**
 * The default quickbars_insert_toolbar configuration to use.
 *
 * This is based upon the default value used if no toolbar is specified.
 *
 * https://www.tiny.cloud/docs/tinymce/6/quickbars/#quickbars_image_toolbar
 *
 * @returns {string}
 */
export const getDefaultQuickbarsImageToolbar = () => 'alignleft aligncenter alignright';

/**
 * Get the default configuration provided by TinyMCE.
 *
 * @returns {object}
 */
export const getDefaultConfiguration = () => ({
    // Toolbar configuration.
    // https://www.tiny.cloud/docs/tinymce/6/toolbar-configuration-options/
    // TODO: Move this configuration to a passed-in option.
    // eslint-disable-next-line camelcase
    toolbar_mode: 'sliding',
    toolbar: getDefaultToolbar(),

    // Quickbars Selection Toolbar configuration.
    // https://www.tiny.cloud/docs/tinymce/6/quickbars/#quickbars_selection_toolbar
    // eslint-disable-next-line camelcase
    quickbars_selection_toolbar: getDefaultQuickbarsSelectionToolbar(),

    // Quickbars Select Toolbar configuration.
    // https://www.tiny.cloud/docs/tinymce/6/quickbars/#quickbars_insert_toolbar
    // eslint-disable-next-line camelcase
    quickbars_insert_toolbar: getDefaultQuickbarsInsertToolbar(),

    // Quickbars Image Toolbar configuration.
    // https://www.tiny.cloud/docs/tinymce/6/quickbars/#quickbars_image_toolbar
    // eslint-disable-next-line camelcase
    quickbars_image_toolbar: getDefaultQuickbarsImageToolbar(),


    // Menu configuration.
    // https://www.tiny.cloud/docs/tinymce/6/menus-configuration-options/
    // TODO: Move this configuration to a passed-in option.
    menu: getDefaultMenu(),

    // Mobile configuration.
    // At this time we will use the default TinyMCE mobile configuration.
    // https://www.tiny.cloud/docs/tinymce/6/tinymce-for-mobile/

    // Skins
    skin: 'oxide',
});