Skip to content

Elegant, interactive popups for the Footnotes block.

License

Notifications You must be signed in to change notification settings

s3rgiosan/littlefoot

Repository files navigation

Littlefoot for Footnotes

Elegant, interactive popups for the Footnotes block.

Description

Elevate your website's user experience by incorporating lightweight and visually appealing footnotes using littlefoot. This WordPress plugin extends the functionality of the Footnotes block, seamlessly integrating the littlefoot JavaScript library to transform static footnotes into interactive popups.

Footnotes with littlefoot

Requirements

  • PHP 7.4+
  • WordPress 6.4

Installation

From the WordPress Plugin Directory:

  1. Navigate to Plugins > Add New in your WordPress admin area.
  2. Search for "Littlefoot for Footnotes".
  3. Click Install Now, then Activate.

Manual Installation:

  1. Download the plugin ZIP file from the GitHub repository or WordPress directory.
  2. Go to Plugins > Add New > Upload Plugin in your WordPress admin area.
  3. Upload the ZIP file and click Install Now.
  4. Activate the plugin.

Install with Composer:

To include this plugin as a dependency in your Composer-managed WordPress project:

  1. Add the plugin to your project using the following command:
composer require s3rgiosan/littlefoot
  1. Run composer install to install the plugin.
  2. Activate the plugin from your WordPress admin area or using WP-CLI.

Usage

This plugin requires no configuration.

Options

activateDelay

Sets a delay between the activation of the footnote button and the activation of the actual footnote content.

Default: 100

allowDuplicates

Determines whether or not a footnote can be used as the content for multiple footnote buttons.

Default: false

allowMultiple

Specifies whether or not multiple footnote popovers can be active simultaneously.

Default: false

dismissDelay

When the footnote content is being removed this option specifies how long after the active class is removed from the footnote before the element is actually removed from the DOM.

Default: 500

dismissOnUnhover

Determines whether footnotes that were presented when hovering on a footnote button are dismissed once the footnote button or footnote popover is un-hovered.

Default: false

hoverDelay

Specifies the amount of time (in milliseconds) that must pass after the footnote button/content is un-hovered before the footnote is dismissed.

Default: 250

Styling

See littlefoot.js theming section.

Changelog

A complete listing of all notable changes to this project are documented in CHANGELOG.md.