Revealjs-title-footer NPM

Reveal.js-Title-Footer

Footer showing title for Reveal.js HTML presentations

Description

What is Reveal.js-Title-Footer?

Reveal.js-Title-Footer is a plugin for the Reveal.js framework for HTML presentations (https://github.com/hakimel/reveal.js).

What does Reveal.js-Title-Footer do?

Reveal.js-Title-Footer includes a footer in all the slides of a Reveal.js presentation (with optional exclusion of some slides) that will show the title of the presentation.

Configurable options

The title to show on the footer is configurable.

The background color of the footer is also configurable.

Installation

NPM (Recommended)

npm install --save revealjs-title-footer

Then, include the plugin in the Reveal.js presentation:

<head>
  <link
    rel="stylesheet"
    href="node_modules/revealjs-title-footer/src/title-footer.css"
  />
  <script src="node_modules/revealjs-title-footer/src/title-footer.js"></script>
</head>

Note: Add the plugin initialization to the Reveal.js initialization, as shown below in Plugin initialization.

JSDelivr CDN (Easiest)

<head>
  <link
    rel="stylesheet"
    href="https://cdn.jsdelivr.net/npm/revealjs-title-footer@latest/src/title-footer.css"
  />
  <script src="https://cdn.jsdelivr.net/npm/revealjs-title-footer@latest/src/title-footer.js"></script>
</head>

Note: Add the plugin initialization to the Reveal.js initialization, as shown below in Plugin initialization.

Manual

Manual Clone the Reveal.js-Title-Footer repository to the `plugin` folder of the Reveal.js presentation:

mkdir plugin/Reveal.js-Title-Footer
cp -r Reveal.js-Title-Footer/src/* plugin/Reveal.js-Title-Footer/

Note: The plugin folder should be in the root of the Reveal.js presentation. Note: Add the plugin initialization to the Reveal.js initialization, as shown below in Plugin initialization.

Plugin initialization

Arguments:

Title to show in the footer; if null or '', it will take the h1, h2 and h3 elements of the first slide.
Background color of the footer.
Author of the presentation.
Show the current date in the footer.

Include Reveal.js-Title-Footer among the Reveal.js plugin initializations, like this:

Reveal.initialize({
		...
		plugins: [
          RevealTitleFooter,
        ],
		titleFooter: {
          title: 'My Presentation',
          background: 'rgba(169,169,169,0.1)',
          author: 'Sebastian Joerz',
          showDate: true,
        },
		...
});

Customization

The title_footer.initialize function can take two parameters:

title: the title to show in the footer; if null, it will take the h1, h2 and h3 elements of the first slide.
background: a string of the form 'rgba(0,255,0,0.1)', for the background colour of the footer.
author: the author of the presentation.
show_date: a boolean indicating whether to show the current date in the footer.

For further customization (like making the footer a header, for example), arrange the plugin/title-footer/title-footer.css file accordingly.

Use

Title

The Reveal.js-Title-Footer plugin takes the first h1, h2 and h3 tags from the first slide as the title, if another title is not explicitly passed as parameter in the initialization.

Exclusion from slides

The Reveal.js-Title-Footer footer will not be shown in a slide if the corresponding section has a data-state attribute with a value of no-title-footer.

Compatibility with Reveal.js-TOC-Progress

If the Reveal.js-TOC-Progress is also used, the Reveal.js-Title-Footer footer is shown just above it. For not showing any of them in a slide, include a data-state attribute with a value of no-toc-progress in the corresponding section.

License

GPL v3 (http://www.gnu.org/copyleft/gpl.html).

1.0.1

6 months ago

1.0.0

6 months ago

revealjs-title-footer v1.0.1