Skip to content

Latest commit

 

History

History
143 lines (99 loc) · 4.39 KB

README.md

File metadata and controls

143 lines (99 loc) · 4.39 KB
Raw

Gallery Modals for WordPress®

Gallery Modals is a WordPress plugin that adds modal popups to gallery images, providing a download button and a link to view image details. Enhance your website's user experience by allowing visitors to interact with gallery images in a more engaging and interactive way.

Table of Contents

Features

  • Modal Popups for Gallery Images: Automatically adds modal functionality to all gallery images.
  • Download Button: Allows users to download images directly from the modal.
  • View Image Details: Provides a link to the image's attachment page for more information.
  • Customizable Appearance: Fully customize colors and opacity for various modal elements.
  • Display Options: Control the visibility of modal elements like title, description, and buttons.
  • Responsive Design: Modals are mobile-friendly and adapt to different screen sizes.

Installation

From GitHub

  1. Clone or Download the Repository:

    git clone https://github.com/robertdevore/gallery-modals.git

  2. Upload to WordPress:

    • Upload the gallery-modals folder to your WordPress site's /wp-content/plugins/ directory.

  3. Activate the Plugin:

    • Log in to your WordPress admin dashboard.
    • Navigate to Plugins > Installed Plugins.
    • Find Gallery Modals in the list and click Activate.

From ZIP File

  1. Download the Latest Release:

    • Go to the GitHub Releases page.
    • Download the latest gallery-modals.zip file.

  2. Install via WordPress Admin:

    • In your WordPress admin dashboard, navigate to Plugins > Add New.
    • Click on Upload Plugin at the top.
    • Choose the downloaded gallery-modals.zip file and click Install Now.
    • After installation, click Activate Plugin.

Usage

Once activated, the plugin automatically enhances all WordPress gallery images with modal functionality.

Viewing Modals

  • Open Modal: Click on any gallery image to open it in a modal popup.
  • Download Image: Click the Download button within the modal to save the image.
  • View Details: Click the View Image Details button to navigate to the image's attachment page.
  • Close Modal: Click the Close icon (×) or click outside the modal to close it.

Settings

Customize the plugin to suit your needs through the settings page.

Accessing the Settings

  1. Log in to your WordPress admin dashboard.
  2. Navigate to Gallery Modals in the sidebar menu.

Color and Opacity Settings

Adjust colors and opacity for various modal elements:

  • Overlay Background
  • Modal Background
  • Title Text
  • Main Text
  • Button Background
  • Button Text
  • Close Button

Each element allows you to select a color and set the opacity level (from 0 to 1).

Display Settings

Control the visibility of certain elements within the modal:

  • Hide Modal Title
  • Hide Modal Description
  • Hide Download Button
  • Hide View Details Button

Check the boxes to hide the respective elements.

Real-Time Preview

The settings page includes a real-time preview of the modal. As you adjust settings, the preview updates instantly to reflect your changes.

Contributing

Contributions are welcome! To contribute:

  1. Fork the Repository:

    • Click the Fork button on the repository page.

  2. Clone Your Fork:

    git clone https://github.com/your-username/gallery-modals.git

  3. Create a Feature Branch:

    git checkout -b feature/YourFeatureName

  4. Make Your Changes.

  5. Commit Your Changes:

    git commit -am 'Add new feature'

  6. Push to Your Fork:

    git push origin feature/YourFeatureName

  7. Create a Pull Request:

    • Open a pull request from your feature branch to the main repository.

License

This plugin is licensed under the GNU General Public License v2.0.