Documentation: MAX Button for WordPress from iws.by
System Requirements
Plugin Installation
- Log in to your CMS WordPress site control panel.
- On the left side of the administrative menu, click on "Plugins".
- On the page that opens, at the top click on "Add new".
- This will open a page with the addition of plugins to the site from the official WordPress catalog. You need to click on the "Upload Plugin" button.
- After clicking on the page, a block with the download of the plugin archive will appear. Click on the "Choose file" button, select the archive with the plugin obtained by purchasing from IWS.BY and click on the "Install Now" button.
- Once the plugin is installed, the page will refresh and you will be prompted to activate the plugin. Click the "Activate plugin" button.
- After successful activation, you will be shown a window notifying you that the plugin has been successfully activated.
Plugin settings
To access the plugin settings, go to the "MAX Button" item in the admin menu.
The settings are organized into tabs, so let's go through each one.
Basic Settings
| Parameter | Value | Default value |
|---|---|---|
| License Key | A unique activation key for accessing the update system, provided when you obtain the plugin from the IWS.BY website. | IWSBY-XXX-XXX-XXX-XXX |
| Enable Button | Enables the floating button on the front end of your website. | Yes |
| Button Type | Controls the button's operating mode. - Button — adds a simple floating button. - Manager — adds a floating button that opens a popup with information about the available manager when clicked. | Button |
| Profile Link | The direct URL used to start a conversation via the MAX messenger. | https://max.ru/u/.... |
| Link Target | Sets how the link opens when the button is clicked. - New tab — The MAX link will open in a new browser tab. - Current tab — The MAX link will open in the current browser tab where your site is displayed. | New tab |
| Button Size | Controls the button size. Enter a value in pixels. | 60 |
| Button Color | Sets the background color of the floating button. Enter a HEX color code. | #7a2fdf |
| Icon Color | Sets the icon color on the floating button. Enter a HEX color code. | #ffffff |
| Button Position | Sets the side of the screen where the floating button will be positioned. - Right — The floating button will appear in the bottom-right corner of the screen. - Left — The floating button will appear in the bottom-left corner of the screen. | Right |
| Right Margin | Sets the distance between the button and the right edge of the visitor's screen. Enter a value in pixels. Applies only when "Right" is selected in the "Button Position" option. | 50 |
| Left Margin | Sets the distance between the button and the left edge of the visitor's screen. Enter a value in pixels. Applies only when "Left" is selected in the "Button Position" option. | 50 |
| Bottom Margin | Sets the distance between the button and the bottom edge of the visitor's screen. Enter a value in pixels. | 50 |
| Layer Level | Controls the stacking order of the floating button. This property corresponds to the CSS z-index value. | 100 |
Border Settings
| Parameter | Value | Default value |
|---|---|---|
| Enable Border | If set to "Yes", a border will be added to the floating button. | No |
| Border Width | Controls the width of the border around the floating button. Enter a value in pixels. | 3 |
| Border Style | Controls the border style of the floating button. Options include solid, double, dotted, and dashed. | Solid |
| Border Color | Sets the border color around the floating button. Enter a HEX color code. | #6b2bc9 |
Animation Settings
| Parameter | Value | Default value |
|---|---|---|
| Enable Animation | If set to "Yes", an animated movement effect will be applied to the floating button. | No |
| Animation Type | Sets the animation type applied to the floating button. Available animations: pulse, bounce, move, and icon rotation. | Pulse |
| Animation Duration | Controls the duration of one animation cycle. Enter a value in seconds. | 2 |
| Pulse Duration | Sets the distance from the button to the outer edge of the pulse effect. Enter a value in pixels. | 15 |
| Jump Height | Sets the height (in pixels) that the button will bounce up or down from its initial position. | 9 |
| Movement Width | Sets the horizontal distance (in pixels) that the button will move left or right from its initial position. | 9 |
"Manager" Mode Settings
| Parameter | Value | Default value |
|---|---|---|
| Window Design | Controls the color scheme of the popup window. - Light — A preset design optimized for light-themed websites. - Dark — A preset design optimized for dark-themed websites. - Custom — Enables a customizable popup design. In this mode, you can configure all colors within the popup. | Light |
| Manager Name | Displays the manager's name at the top of the popup window. | John Doe |
| Manager Department | Displays the manager's department in the upper part of the window, below the manager's name. | Support Team |
| Manager Message | Displays a text greeting in the center of the popup window. | Hi, I'm John Doe! How can I help you today? |
| Button Label | Displays the text on the button that opens a chat with the MAX user specified in the settings. The button appears at the bottom of the popup window. | Start Chat |
| Manager Image | Sets the manager's image, which will appear in the upper part of the popup window, next to the name and department. It is recommended to use a square image with a 1:1 aspect ratio. | /plugins/iwsbymaxbutton/images/user.png |
Customizing the design in Manager mode
| Parameter | Value | Default value |
|---|---|---|
| Header Background Color | Sets the background color of the top section of the popup window. Enter a HEX color code. | #7a2fdf |
| Name Color | Sets the color of the manager's name in the top section of the popup window. Enter a HEX color code. | #ffffff |
| Department Color | Sets the color of the manager's department in the top section of the popup window. Enter a HEX color code. | #ffffff |
| Close Icon Color | Sets the color of the icon used to close the popup window. Enter a HEX color code. | #ffffff |
| Close Icon Hover Color | Sets the hover color of the popup close icon. Enter a HEX color code. | #dfdfdf |
| Content Background Color | Sets the background color of the central section of the popup window. Enter a HEX color code. | #e8e8e8 |
| Message Background Color | Sets the background color of the manager's message block in the popup window. Enter a HEX color code. | #e8e8e8 |
| Message Text Color | Sets the text color of the manager's message in the central section of the popup window. Enter a HEX color code. | #000000 |
| Footer Background Color | Sets the background color of the bottom section of the popup window. Enter a HEX color code. | #d2d2d2 |
| Button Background Color | Sets the background color of the button that opens the chat in the popup window. Enter a HEX color code. | #7a2fdf |
| Button Background Hover Color | Sets the background color of the chat button on hover. Enter a HEX color code. | #6b2bc9 |
| Button Text Color | Sets the text color of the button that opens the chat in the popup window. Enter a HEX color code. | #ffffff |
| Button Text Hover Color | Sets the text color of the chat button on hover. Enter a HEX color code. | #dfdfdf |
Analytics Settings
| Parameter | Value | Default value |
|---|---|---|
| Enable Analytics | If set to "Yes", the button will send events and goals to Google Analytics and Yandex Metrica tracking services. | No |
| Enable Google Analytics | If set to "Yes", the button will send events to Google Analytics. | No |
| Parameter | Sets the parameter name sent to Google Analytics in "Button" mode when the floating button is clicked. | event_name |
| Value | Sets the parameter value sent to Google Analytics in "Button" mode when the floating button is clicked. | max_button |
| Parameter (Step 1) | Sets the parameter name for the first step sent to Google Analytics in "Manager" mode when the floating button is clicked. | event_name1 |
| Value (Step 1) | Sets the parameter value for the first step sent to Google Analytics in "Manager" mode when the floating button is clicked. | max_button_step_1 |
| Parameter (Step 2) | Sets the parameter name for the second step sent to Google Analytics in "Manager" mode when the button in the popup window is clicked. | event_name2 |
| Value (Step 2) | Sets the parameter value for the second step sent to Google Analytics in "Manager" mode when the button in the popup window is clicked. | max_button_step_2 |
| Enable Yandex Metrica | If set to "Yes", the button will send goals to Yandex Metrica. | No |
| Yandex Metrica ID | Specifies the numeric Yandex Metrica counter ID assigned to your website. | 123123123 |
| Target ID | Sets the JavaScript goal identifier sent to Yandex Metrica in "Button" mode when the floating button is clicked. | max_button |
| Target ID (Step 1) | Sets the JavaScript goal identifier for the first step sent to Yandex.Metrica in "Manager" mode when the floating button is clicked. | max_button_step_1 |
| Target ID (Step 2) | Sets the JavaScript goal identifier for the second step sent to Yandex. Metrica in "Manager" mode when the button in the popup window is clicked. | max_button_step_2 |
Getting a Link for Your Website
- Open the MAX app on your smartphone.
- Go to the "Profile" section.
- In the top left corner, find the "QR code" section.
- Click the "Share" button.
- Select any messenger (e.g., SMS, Email, or even MAX itself) to send it.
- In the window that opens, you will see a text message with a hyperlink in the following format:
https://max.ru/u/... - Copy this link for the module settings. This is your official MAX profile link.
Plugin update error
If you have an error when updating a plugin in the WordPress control panel, then this section of the instructions is necessary for you. Usually the error when updating looks like this:
This error appears in several cases, they are all related to the plugin's license key.
1) You do not have the license key filled in in the plugin settings.
Go to the plugin settings and check if the field "License key" is filled in. Without a license key update is not possible to download. There are times when you add a license key, but CMS WordPress did not save it correctly, for this plugin settings after entering the license key, click "Save".
2) Your plugin version cannot be updated automatically.
There are versions of plugins that cannot update automatically. To do this, go to the IWS.BY website at the link https://iws.by/en/my-account/downloads/. In the list of available downloads, find your plugin and download by clicking on the button on the right. Go to the administrative part of your site, to the plugin section, and download the new version using the WordPress plugin installer. Due to security updates to the update server, some plugin versions need to be updated manually. To check the list of such plugins for your version of the plugin, go to the following link: List of versions of WordPress plugins that can be updated manually.
3) Your license key has expired.
To check the expiration date of your license key, follow this link https://iws.by/en/my-account/view-license-keys/. In the list of license keys, find your plug-in key and in the column "Valid until" check its relevance. If the license key has expired, it is not possible to get updates. To solve this issue: make a new order and get the current license key.
3) The license key is not valid on your current site.
Our update system is designed so that the first time you access the update server, the license key is assigned to the requesting site. If you try to use a license key on more than one site, updates will only be available for one site. If you need updates for multiple sites, make a purchase of multiple license keys on the site. Sites without license keys will not be able to receive updates.
Attention! If you have changed the address of the site and can not download updates, write to us at support@iws.by with the new address of the site, we will update the data on our update server and within 24 hours you will be able to receive updates.
Support
IWS.BY support service for questions regarding our products is available via email: support@iws.by.
All available support options are available on the Support page: Go to.