Firefox user notice:

Please use another web browser to view this document.

Sorry for the inconvenience.

1. Backup your web directory and store database

2. Download the Popup Pro installation package

 3. Upload contents of the  Popup Pro installation package to your store root directory

cd path_to_the_store_root_folder

php -f bin/magento module:enable  Aheadworks_Popup

php -f bin/magento setup:upgrade

php -f bin/magento setup:static-content:deploy

5. Flush store cache; log out from the backend and log in again

Make sure the installation is done from the FTP administrator account. Otherwise, set 775 permissions to the store root directory after the extension is deployed.

1. Login to your ssh console and navigate to your store folder:

Run the following command:

After the command was executed successfully, you can use the composer to install the products.

composer require aheadworks/module-pop-up

composer require aheadworks/module-pop-up:<version>

Specify the version of the extension in <version>

When prompted, enter Public Key (Username) and Private Key (Password):
Image Removed

Both Public Key (Username) and Private Key (Password) can be found in My Projects and Licenses in your personal account on our site:

Image Removed

php -f bin/magento module:enable <Module_Name>

Add the product name in <Module_Name>

bin/magento setup:upgrade

bin/magento setup:di:compile

bin/magento module:status

bin/magento cache:clean

composer update aheadworks/module-pop-up

composer require aheadworks/module-pop-up:<version>

php bin/magento setup:upgrade --keep-generated
php bin/magento setup:static-content:deploy
php bin/magento cache:clean

Once installed the extension introduces its section under Content > Popup Pro by aheadWorks > Manage Popups

Image Removed

The Manage Popups screen is the management center of the extension. The popup grid offers an overview of all the popups created along with the Click Through Rate (CTR) statistics:

• Views - how many times the popup has been displayed to the customers;
• Clicks - how many times customers clicked the popup contents;
• CTR - views to clicks ratio.

The Manage Popups grid can be adjusted according to a particular task:

• Image Removed button allows enabling/disabling the grid columns that may be considered relevant or excessive for the current task;
• Image Removed button allows sorting popups created according to the relevant attributes (event, position, status, etc.);
• Image Removed button allows saving the current grid look for quick access.

Once the Manage Popups grid is configured, the store administrator may start managing popups.

To create a new popup, click Image Removed button.

General Information

In this section the store administrator is to suggest a name for the popup, a store view for popup display, as well as some other popup attributes.

Image Removed

The General Information section of the New Popup page comes with the following settings:

• Status - allows enabling/disabling the popup;
• Name - name of the popup for identification purposes (not visible by customers);
• Store View - allows defining which store view(s) are to display the popup;
• Customer Groups - allows defining customer groups the popup should be displayed to;
• Customer Segments (available when the Customer Segmentation module is pre-installed) - allows defining customer segments to see the popup;
• Event - allows selecting an event to display a popup:
  • Immediately after the page is loaded (not recommended);
  • X seconds after the page is loaded;
  • Once the page is scrolled by X%;
  • Once customer viewed X pages;
  • Once cursor is moved outside the page.
• X equals to - specifies the value for the X parameter of the event;
• Animation Effect - allows selecting an effect the popup will be displayed with:
  • Fade-zoom;
  • Fade-slide;
  • Newspaper;
  • Horizontal move;
  • Move from top;
  • 3d unfold;
  • Zoom-out.
• Cookie Lifetimes, minutes - Defines a value for iteration of popup display.

Where to display

This is the second popup configuration section. Here store administrator is suggested to decide on what pages the popup is to be displayed.

Image Removed

The section comes with the following settings:

• Display At - allows defining on what page the popup is to be displayed:
  • Home Page;
  • Product Pages;
  • Catalog Pages;
  • Shopping Cart;
  • Checkout.
• Position - allows defining the position of the popup on the page:
  • Top left/center/right;
  • Middle left/center/right;
  • Bottom left/center/right;
• Conditions - a set of native Magento conditions controlling the whereabouts of the popup at the store.

Popup content

The next section of the New Popup page is the content section.

Image Removed

Here the store administrator is presented with the WYSIWYG editor, as well as with some content blocks of the popup. The editor allows populating the popup with widgets, media (images, video), hyperlinks etc.

Popup design

The final section of the New Popup page. Here store administrator can submit custom CSS design to adjust the look and feel of the popup. If the field is empty the default design is used.

php bin/magento module:disable Aheadworks_Popup
php bin/magento setup:upgrade

app/code/Aheadworks/Popup

php bin/magento module:uninstall Aheadworks_Popup