AltMode

A reveal.js 3.x / 4.x plugin to switch between multiple alternative configuartion presets by pressing a shortcut key.

If you are presenting your slide deck you are usually used to handling reveal.js. You want to keep your audience free of all unnecessary visual distraction to stay concentrated on what you are presenting.

On the other hand you may want to upload your slides later. Other viewers in front of their computers will then operate your presentation and may not be used to handling reveal.js. In this case you want to give them every available help to navigate thru your slide deck.

Instead of adjusting the configuration for every use case, you can store alternative configurations as ready to use presets and switch between them by pressing a shortcut key.

To change themes in presets the ThemeOverride plugin or similar may come in handy.

Installation

Copy this repository into the plugin folder of your reveal.js presentation, ie plugin/altmode.

Add the plugin to the initialization of your presentation, as below.

reveal 4.x

<script src="plugin/altmode/altmode.js"></script>
// .. 
Reveal.initialize({
    // ...
    plugins: [
        // ..
        AltMode,
    ]
});

reveal 3.x

Reveal.initialize({
    // ...
    dependencies: [
        // ...
        { src: 'plugin/altmode/altmode.js', async: true },
    ]
});

Usage

With no further configuration, the plugin will configure one alternative preset for distraction free presentation mode.

To use an alternative preset you can either:

toggle thru the presets by pressing the A shortcut on the keyboard. This is only available if you are not in PDF export mode.
set the altMode parameter as an URI parameter.
set the altMode parameter in the configuration options.

The URI parameter will have precedence over the configuration option. By default the default configuration is shown which is equivalent to altMode=0.

Configuration

You can define an unlimited amount of alternative presets in the altModeConfig array parameter of your configuration. You access them with the nummerical altMode parameter. 0 is the default configuration, all other numbers -1 refer to alternative configuration items defined in the altModeConfig array parameter.

Reveal.initialize({
    // ...
    // Define your alternative presets here. If this parameter is not
    // set, the plugin will install distraction free presentation mode
    // as your only alternative preset.
    // Once the array is defined (even if it is empty), distraction free
    // presentation mode needs to be set manually. You can add distraction
    // free presentation mode to any configuration preset by setting
    // altModePresenter=true - see below.
    altModeConfig: [
        {
            // distraction free presentation mode
            altModePresenter: true
        },{
            // change transitions in this preset
            backgroundTransition: 'zoom',
            transition: 'zoom',
        }
    ]
    // You access your configuration presets with a nummerical value.
    // 0   is the default configuration
    // n-1 is used as an index to access your alternative presets in
    // the altModeConfig array
    altMode: 0,
    // If set to true, the plugin will add distraction free presentation mode
    // to this configuration; by that you can apply distraction free
    // presentation mode to the default configuration as well as to any other
    // configuration of your alternative presets.
    altModePresenter: false,
    // Shortcut for toggling between default configuration and alternative presets
    altModeShortcut: 'A',
});

URI Parameter

http://example.com/demo.html?altMode=1

Distraction free presentation mode

This alternative preset removes all unnecessary UI elements from your slide. It is installed if you are not giving any own configuration of alternative presets. It corresponds to the following reveal.js configuration parameters:

Reveal.initialize({
    controls: false,
    controlsTutorial: false,
    helpButtonDisplay: 'none', // HelpButton plugin
    hideAddressBar: true,
    history: false,
    mouseWheel: false,
    previewLinks: false,
    progress: false,
    slideNumber: false,
});

API

Javascript

The plugin API is accessible from the global AltMode object.

// Change a config value at runtime
AltMode.configure({
    // Takes the same options as for configuration
    altMode: 1,
});
// Retrieves an object with the settings for
// distraction free presentation mode
AltMode.getPresenterConfig();

License

MIT licensed.