<!-- TITLE: Newsletter Widget - Dokumentacja modułu Magento 2-->
<!-- SUBTITLE: Autor: Jakub Szczubełek -->
# Newsletter Widget - Dokumentacja modułu Magento 2
## Opis modułu
Moduł pozwala wyświetlić wyskakujące okienko, które pozwoli klientom zapisać się do Newslettera za pomocą adresu e-mail. W e-mailu potwierdzającym możesz wysłaćunikalny kod ze zniżką.
## Zgodność modułu
Ten moduł jest zgodny z następującymi wersjami Magento Community: **2.3**.
## Sposób działania
Po instalacji modułu przejdź do Panelu Admina w **Stores > Settings >Configuration > Aurora > Newsletter popup** jest możliwość konfiguracji modułu
![Newsletter Widget 1](/uploads/newsletter-widget/newsletter-widget-1.png "Newsletter Widget 1")
**Enable Newsletter Popup** - Włączenie / wyłączenie Newsletter Popup.
**Newsletter Popup Delay** - Czas w sekundach po jakim ma się wyświetlić Newsletter Popup.
**Default Coupon Rule** - Zawiera reguły ceny koszyka z automatycznie wygenerowanymikuponami (Cart price rule).
**Coupon Block** - Blok kuponu. Zawarty kod pozwala na umieszczenie promocyjnego kodu wwiadomości email (należy pamiętać o zastąpieniu ‘ruleId’ właściwym identyfikatorem reguły).
Aby utworzyć nową regułę cenową należy w **Marketing > Cart Price Rules** kliknąć w ‘**AddNew Rule**’
![Newsletter Widget 2](/uploads/newsletter-widget/newsletter-widget-2.png "Newsletter Widget 2")
Na stronie tworzenia reguł należy wypełnić wszystkie niezbędne informacje, należy pamiętaćo zaznaczeniu opcji: **Coupon** na **Specific Coupon** oraz checkboxa **Use Auto Generation**
![Newsletter Widget 3](/uploads/newsletter-widget/newsletter-widget-3.png "Newsletter Widget 3")
Jeżeli wszystko zostanie skonfigurowane poprawnie, na dole strony powinny wyświetlić sięwygenerowane kody promocyjne
![Newsletter Widget 4](/uploads/newsletter-widget/newsletter-widget-4.png "Newsletter Widget 4")
Aby kody były wysyłane dla subskrybentów w mailach należy do templatki odpowiedzialnejza potwierdzenie subskrypcji podać kod z **Coupon Block**
![Newsletter Widget 5](/uploads/newsletter-widget/newsletter-widget-5.png "Newsletter Widget 5")
Widok popup
![Newsletter Widget 6](/uploads/newsletter-widget/newsletter-widget-6.png "Newsletter Widget 6")
## Demo
demo1.magecreation.com
## Instalacja modułu
### Instalacja przez Composer
1. Dodaj repozytorium do pliku composer.json:
```text
"repositories": [
...
{
"type": "vcs",
"url": "git@git.auroracreation.com:magento2/newsletter-widget.git"
}
...
],
```
2. Zmodyfikuj plik composer.json:
```text
"require": {
...
"aurora/newsletter-widget": "*"
...
},
```
3. W folderze głównym Magento wykonaj następujące polecenia:
```text
composer aurora/newsletter-widget
php bin/magento module:enable Aurora_Newsletter
php bin/magento setup:upgrade
```
### Instalacja manualna
1. Rozpakuj archiwum
2. Przenieś pliki modułu na serwer do lokalizacji:
```text
{Magento root}
└── app/
└── code
```
3. W folderze głównym Magento wykonaj następujące polecenia:
```text
php bin/magento module:enable Aurora_Newsletter
php bin/magento setup:upgrade
```
### Dziękujemy za zainteresowanie naszymi modułami!
## Dziennik zmian
### v1.0
- Zaktualizowano plik Readme
### v1.1
- Włączono moduł na magento/module-newsletter ^100.2.0
- Usunięto ograniczenie wersji php
### v1.2
- Zaktualizowano wersję modułu
### v1.2.1
- Dodano prawa autorskie
### v1.2.2
- Zaktualizowano wersję modułu
### v1.2.3
- Dostosowano moduł do Magento 2.3
- Zaktualizowano prawa autorskie
### v1.3.0
- Dodano gitlabci
- Poprawiono PHPDocs
### v1.3.1
- Poprawiono plik Readme
### v1.3.2
- Poprawiono gitlabci
### v1.4.1
- Dodano testy jednostkowe
### v1.4.2
- Dodano style
- Poprawiono tytuł
- Usunięto przycisk "cancel" z js
### v1.4.3
- Poprawiono style
### v1.4.4
- Poprawiono style
### v1.4.5
- Poprawiono style
### v1.4.6
- Poprawiono style
- Dodano własną templatkę modala subskrypcji
### v1.4.7
- Dodano modal subskrypcji jako widżet
- Tytuł widżetu pochodzi z opisu kodu kuponu
### v1.4.8
- Poprawiono style
### v1.4.9
- Zaktualizowano wersję modułu
### v1.4.10
- Zaktualizowano prawa autorskie
- Dodano acl
- Dodano strict_types
- Dodano type hint
- Poprawiono PHPDocs
- Poprawiono PSR
### v1.4.11
- Naprawiono błąd - kod kuponu nie istnieje
### v1.4.12
- Poprawiono PSR
### v1.5.0
- Naprawa składni kodu wg standardów
- Dodanie testów jednostkowych
### v1.5.1
- Dodanie funkcjonalności - potwierdzenie subskrypcji bez przeładowania strony
- Dodanie testów do nowej funkcjonalności
- Dodanie tłumaczeń
- Poprawiono PSR i copyrights