https://github.com/s3rgiosan/littlefoot
Elegant, interactive popups for the Footnotes block.
https://github.com/s3rgiosan/littlefoot
block-editor gutenberg wordpress wordpress-plugin
Last synced: about 2 months ago
JSON representation
Elegant, interactive popups for the Footnotes block.
- Host: GitHub
- URL: https://github.com/s3rgiosan/littlefoot
- Owner: s3rgiosan
- License: mit
- Created: 2023-10-18T23:06:50.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-08T00:02:24.000Z (over 1 year ago)
- Last Synced: 2024-12-08T00:25:33.697Z (over 1 year ago)
- Topics: block-editor, gutenberg, wordpress, wordpress-plugin
- Language: JavaScript
- Homepage:
- Size: 2.04 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://github.com/goblindegook/littlefoot).
This WordPress plugin extends the functionality of the Footnotes block, seamlessly integrating the littlefoot JavaScript library to transform static footnotes into interactive popups.
## Installation
### Manual Installation:
1. Download the plugin ZIP file from the GitHub repository.
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:
```bash
composer require s3rgiosan/littlefoot
```
2. Run `composer install` to install the plugin.
3. Activate the plugin from your WordPress admin area or using WP-CLI.
## 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](https://github.com/goblindegook/littlefoot/blob/main/README.md#theming) section.
## Changelog
A complete listing of all notable changes to this project are documented in [CHANGELOG.md](https://github.com/s3rgiosan/littlefoot/blob/main/CHANGELOG.md).
## License and Attribution
This plugin is licensed under MIT.
This project incorporates [littlefoot.js](https://littlefoot.js.org/), which is licensed under the [MIT License](https://github.com/goblindegook/littlefoot/blob/main/LICENSE).