Install
This is the repository archive. It installs, but the folder name will carry the branch suffix and updates will not flow.
Install straight from GitHub with WP-CLI:
wp plugin install https://github.com/codebyamos/the-brandsmen-spa-configurator/archive/refs/heads/main.zipSpa Configurator WordPress Plugin
Interactive spa configurator with hotspots, image replacement, and Elementor integration. Allows users to visualize different cabinet and shell options with responsive hotspot tooltips.
Features
- Elementor Widget: Easily add configurator to any page using Elementor
- Hotspot Tooltips: Interactive hotspots with custom tooltips
- Image Replacement: Dynamic image swapping based on user selections
- Backward Compatibility: Supports both name-based and ID-based matching
- Responsive Design: Works on all device sizes
- Automatic Updates: Updates directly from GitHub
Installation
Manual Installation
- Download the latest release ZIP from GitHub Releases
- In WordPress admin, go to Plugins → Add New → Upload Plugin
- Upload the ZIP file and activate
Git Installation
- Clone this repository into your
wp-content/plugins/directory:cd wp-content/plugins git clone https://github.com/codebyamos/spa-configurator.git - Activate the plugin from WordPress admin
Usage
-
Elementor Integration: After activation, you'll find "Spa Configurator" widget in Elementor's widget panel under "Spa Configurator" category.
-
Widget Configuration:
- Add the widget to any page
- Configure shell options with images, names, and optional IDs
- Configure cabinet options with images, names, and optional IDs
- Set default selections and hotspot positions
-
Admin Tools: Access migration and backup tools under Tools → Spa Configurator in WordPress admin.
Automatic Updates
This plugin supports automatic updates from GitHub. When a new release is published on GitHub, WordPress will notify you of available updates in the Plugins page.
How It Works
- The plugin uses the Plugin Update Checker library
- Checks GitHub repository for new releases
- Supports both public and private repositories (token required for private)
Manual Update Check
If updates aren't appearing automatically, you can force a check by:
- Going to WordPress Dashboard → Updates
- Clicking "Check Again"
Development
Prerequisites
- PHP 7.4+
- WordPress 5.0+
- Elementor 3.0+
Building from Source
git clone https://github.com/codebyamos/spa-configurator.git
cd spa-configurator
File Structure
spa-configurator/
├── spa-configurator.php # Main plugin file
├── assets/ # CSS and JS assets
├── includes/ # PHP classes
│ └── elementor/ # Elementor widget
├── .github/workflows/ # CI/CD workflows
└── README.md # This file
Contributing
- Fork the repository
- Create a feature branch
- Make your changes
- Submit a pull request
GitHub Actions
This repository includes GitHub Actions workflows for:
- PHP Syntax Check: Validates PHP syntax on all
.phpfiles - WordPress Coding Standards: Ensures code follows WordPress coding standards
- Automatic Releases: Creates ZIP archives when tags are pushed
Versioning
We use Semantic Versioning. For the versions available, see the tags on this repository.
License
This plugin is licensed under the GPL v2 or later. See the LICENSE file for details.
Support
For support, feature requests, or bug reports, please open an issue on GitHub.
Credits
Developed by The Brandsmen.
Releases
1 release.
These releases are tags only. The author does not attach a packaged zip, so there are no download counts to report.