Documentation: Cookie Notification for Joomla
System Requirements
System requirements differ for Joomla 3, Joomla 4, Joomla 5 and Joomla 6, so please refer to the section corresponding to your version.
Joomla 3
Joomla 4
Joomla 5 and Joomla 6
Extension Installation
The extension installation process is slightly different for Joomla 3 and Joomla 4/5/6, so please refer to the section corresponding to your version.
Installation for Joomla 3
- Download the extension package.
- Go to the Joomla 3 administration panel.
- Open "Extensions" -> "Extension Manager".
- Click on the "Upload Package" tab.
- Select the downloaded extension package and click "Upload and Install".
Installation for Joomla 4, Joomla 5, and Joomla 6
- Download the extension package.
- Go to the Joomla 4/5/6 administration panel.
- Open "System" -> "Extensions".
- Click on the "Upload Package" tab.
- Drag and drop the downloaded extension package into the upload area or click "Select Package".
- Click "Upload and Install".
Extension settings
Go to the site's module list in the Joomla administrator panel. In the module list, find "IWS.BY Cookie Notification". Click on the module name, and a page with available settings will open. Let's review each field below.
License key
Enter the license key received on the IWS.BY website when obtaining the module in this field. Without a key in this field, the module will not be able to access the update server and update automatically.
Cookie lifetime
This field specifies the number of days during which the notification window will not be shown after the site visitor clicks the "Accept" button.
Cookie ID
This field contains the system cookie identifier responsible for displaying the notification window. It is not visible to the site visitor but is necessary for the notification window to function. It is recommended to fill in the identifier without special characters, using only English letters and the underscore character.
Notification design
This option is responsible for the color design of the notification window. By default, the system has 9 ready-made designs and the ability to configure your own. This option controls this. By default, there are light, dark, blue, green, orange, red, pink, purple, and turquoise designs.
New designs are planned to be added regularly in future updates. You can find information on how to configure your own design in the right-hand menu, in the "Custom Design Settings" section.
Notification location
This option is responsible for the position of the notification window for the site visitor relative to the screen. Positioning at the bottom and top of the screen is available.
Layer level
This field specifies the numeric layer level on which the notification window will be located. This field is analogous to the CSS property: z-index.
Displayed buttons
This option controls the buttons that will be displayed on the notification window. You can keep both the "Close" and "Accept" buttons, or keep only one button.
Type of «Close» button
This option sets the type of the "Close" button. It can be a simple button or an icon.
Notification text setting
This block configures the notification text, its alignment, and text style.
Notice text
This field sets the text of the notification itself. You must specify only the text up to the sentence containing the link to the site rules. The sentence with the link to the site rules is filled in another settings block.
Notification text alignment
This option specifies how the notification text will be aligned within its block section. The notification can be aligned to the left, center, or right.
Notification text style
This option is responsible for styling the notification text. The style can be normal, italic, bold, or bold italic.
Notification text size
This field sets the size of the notification text. It is specified as a number in pixels.
Setting up a link to the rules
This block configures the link to the rules, its title, and style.
Show the link to the rules?
This option is responsible for displaying the sentence containing the link to the site rules.
Name of the rules reference
This field specifies the text title of the link to the site rules.
Link style rules
This option is responsible for styling the rules link text. The style can be normal, italic, bold, or bold italic.
The size of the link text rules
This field sets the size of the site rules link text. It is specified as a number in pixels.
Link to rules
This field specifies the link to the site rules. You must provide a direct, full link to the rules page. Example link: https://site.com/rules.html
Opening the rules link
This option controls how the site rules link opens when clicked by the site visitor. You can set the link to open in the visitor's current window or in a new tab.
Customizing the text before and after the rules link
This block is used to fill in the phrases before and after the rules link.
Text before the reference to the rules
This field is filled with the first part of the sentence containing the site rules link, which comes before the link itself.
Text after the rule reference
This field is filled with the second part of the sentence containing the site rules link, which comes after the link itself.
Setting the «Accept» button
This block configures the "Accept" button: its label, text style, and text size.
Text of the «Accept» button
This field specifies the text phrase that will be displayed on the button that accepts the site rules.
Style of the «Accept» button
This option is responsible for styling the text on the button that accepts the site rules. The style can be normal, italic, bold, or bold italic.
The size of the text of the «Accept» button
This field sets the text size on the button that accepts the site rules. It is specified as a number in pixels.
Setting the «Close» button
This block configures the "Close" button: its label, text style, and text size.
Close button text
This field specifies the text phrase that will be displayed on the button that closes the notification window.
Close button style
This option is responsible for styling the text on the button that closes the notification window. The style can be normal, italic, bold, or bold italic.
Close button text size
This field sets the text size on the button that closes the notification window. It is specified as a number in pixels.
Adjusting the «Close» icon
This block configures the "Close" icon: its text content, style, and text size.
The text of the «Close» icon
This field specifies the text of the "Close" icon that will close the notification window. You can use special characters or icon fonts as text.
Close icon style
This option is responsible for styling the text on the icon that closes the notification window. The style can be normal, italic, bold, or bold italic. The style is applied only if the special characters or icon fonts support styling.
The size of the text of the Close icon
This field sets the text size of the icon that closes the notification window. It is specified as a number in pixels.
Customizing Your Own Design
Custom design settings are located on a special tab in the module settings. At the top of the page, there is a "Custom Design" tab. Data from this tab is applied only if, in the "Module" tab, within the "Basic Settings" block, the "Notification Design" field has the "Custom Design" option value selected. The settings on the page are also divided into blocks for convenience. Let's review each field.
Basic settings
The settings in this block are responsible for the main notification window.
Background color
This option sets the background color of the main notification window block. The value is specified in RGBA format. The settings for this field define the color and opacity.
Include a border
This option activates the border around the main notification window block. Once activated, the border values will be applied from the fields below.
Width of the border
This field sets the border width as a number in pixels. Analogous to the CSS property: border-width.
Border style
This option sets the border style. There are several border styles available. Analogous to the CSS property: border-style.
Border color
This option sets the border color. The color is specified in HEX format. Analogous to the CSS property: border-color.
Location of the border
This option selects the side from which the border will be displayed on the main notification window. It can be on all sides, or on one or two specific sides.
Notification text setting
This block contains the design settings for the notification text itself.
Notification text colour
This option sets the color of the notification text. It is specified in HEX format.
Setting up a link to the rules
This block contains the settings for the site rules link.
Color of the rule reference
This option sets the color of the rules link text. It is specified in HEX format.
The color of the link to the rules when hovering
This option sets the color of the rules link in the notification window when hovered over with the mouse cursor. It is specified in HEX format.
Setting the «Accept» button
This block contains the custom design settings related to the "Accept" button.
The color of the Accept button text
This option sets the text color on the button that accepts the rules in the notification window. It is specified in HEX format.
The color of the text of the «Accept» button when hovering
This option sets the text color on the button that accepts the rules in the notification window when hovered over with the mouse cursor. It is specified in HEX format.
Background color of the Accept button
This option sets the background color of the button that accepts the rules in the notification window. It is specified in HEX format.
Background color of the «Accept» button when hovering
This option sets the background color of the button that accepts the rules in the notification window when hovered over with the mouse cursor. It is specified in HEX format.
Rounding radius of the Accept button
This field sets the border radius of the button that accepts the site rules. It is specified as a number in pixels. Analogous to the CSS property: border-radius.
Include an Accept button boundary?
This option enables the border for the button that accepts the site rules. If the "Yes" value is selected, the border will be formed with styles from the fields below.
The width of the border of the Accept button
This field sets the border width as a number in pixels for the button that accepts the site rules. Analogous to the CSS property: border-width.
The style of the border of the «Accept» button
This option sets the border style for the button that accepts the site rules. There are several border styles available. Analogous to the CSS property: border-style.
Location of the border of the «Accept» button
This option selects the side from which the border will be displayed on the button that accepts the site rules. It can be on all sides, or on one or two specific sides.
The color of the border of the «Accept» button
This option sets the border color for the button that accepts the site rules. The color is specified in HEX format. Analogous to the CSS property: border-color.
The color of the border of the «Accept» button when hovering
This option sets the border color for the button that accepts the site rules when hovered over with the mouse cursor. The color is specified in HEX format. Analogous to the CSS property: border-color.
Setting the «Close» button
This block contains the custom design settings related to the "Close" button.
The color of the Close button text
This option sets the text color on the button that closes the notification window. It is specified in HEX format.
The color of the text of the Close button when hovering
This option sets the text color on the button that closes the notification window when hovered over with the mouse cursor. It is specified in HEX format.
The background color of the Close button
This option sets the background color of the button that closes the notification window. It is specified in HEX format.
The background color of the Close button when hovering
This option sets the background color of the button that closes the notification window when hovered over with the mouse cursor. It is specified in HEX format.
Rounding radius of the Close button
This field sets the border radius of the button that closes the notification window. It is specified as a number in pixels. Analogous to the CSS property: border-radius.
Turn on the boundary of the close button?
This option enables the border for the button that closes the notification window. If the "Yes" value is selected, the border will be formed with styles from the fields below.
The width of the border of the Close button
This field sets the border width as a number in pixels for the button that closes the notification window. Analogous to the CSS property: border-width.
The style of the border of the «Close» button
This option sets the border style for the button that closes the notification window. There are several border styles available. Analogous to the CSS property: border-style.
Location of the «Close» button border
This option selects the side from which the border will be displayed on the button that closes the notification window. It can be on all sides, or on one or two specific sides.
The color of the border of the Close button
This option sets the border color for the button that closes the notification window. The color is specified in HEX format. Analogous to the CSS property: border-color.
The color of the border of the Close button when hovering
This option sets the border color for the button that closes the notification window when hovered over with the mouse cursor. The color is specified in HEX format. Analogous to the CSS property: border-color.
Adjusting the «Close» icon
This block contains the custom design settings related to the "Close" icon.
The color of the «Close» icon
This option sets the color of the icon that closes the notification window. It is specified in HEX format.
The color of the «Close» icon when hovering
This option sets the color of the "Close" icon that closes the notification window when hovered over with the mouse cursor. It is specified in HEX format.
Extension update error
If you encounter an error when updating an extension in the Joomla control panel, this section of the instructions is for you.
Error appears in several cases, all of which are related to the extension's license key.
1) You have not filled in the license key in the extension settings.
Go to the extension settings and check if the "License key" field is filled in. Without a license key, it is not possible to download updates. Sometimes, you may have added a license key, but the Joomla CMS did not save it correctly. In this case, in the extension settings, after entering the license key, click "Save" and then click "Save & Close".
2) Your license key has expired.
To check the expiration date of your license key, go to https://iws.by/en/my-account/view-license-keys. In the list of license keys, find the key for your extension and check its validity in the "Valid until" column. If the license key has expired, it is not possible to get updates. To resolve this issue, place a new order and obtain a 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 site that requested it. If you try to use the license key on multiple sites, updates will be available for only one site. If you need updates for multiple sites, purchase multiple license keys on our website. Sites without license keys will not be able to receive updates.
Attention! If you have changed your site's address and cannot download updates, write to us at support@iws.by with the new site address. 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.