<!-- TITLE: Contact Form - Magento 2 module documentation-->
<!-- SUBTITLE: Author: Marek Milewski -->
# Contact Form Module
## Module overview
Contact Form allows you to create your own, highly customizable contact forms in Magento 2. You do not need to have any coding skills. Simply create and configure a field and decide whether you want to include it in your form or just save it for later.
## Module compatibility
This module is compatibile with Magento Community versions: **2.2** and **2.3**.
## How it works
After installing the module, default **Contact Us** fields provided with Magento 2 will be erased. To add your custom form **fields**, head to Admin Panel go to **Content > Form Fields**. Click on **Add New Field** button to create your own field.
**Enable** – turns on or off visibility of the field
**Label** – set name for label
**Type** – pick input type:
* Text - short text inputs
* Textarea - longer text inputs
* Select - create your custom options from which user will pick one
* Email list - create list of emails for user to pick
* Reply to - lets user add email to which replay will be send to
* Subject - lets user write subject for email
**Required** – set if field is required to be filled
**Validation Type** - set validation type for your field input
**Sort Order** - fill with number to keep your fields in desired order
**Store View** – a store/store view that this fields should be visible in
Your newly created fields will be shown, where **Contact Us** form was before (in homepage/contact).
Module is fully compatible with Magento 2 native functions, so you can with no problem add captcha to your custom **Contact Us Form (Stores > Configuration > Customers > Customer Configuration > Captcha**.
To configure Sender and Recipient of Contact Form, go to Admin Panel **Stores > Configuration > General > Contacts > Email Options**.
**Send Emails To** - e-mail address to which Contact Form should be sent (Recipient)
**Email Sender** - e-mail address from which Contact Form should be sent (Sender)
## Demo
demo1.magecreation.com
## Installation
### Composer
1. Add repo to composer.json:
```text
"repositories": [
...
{
"type": "vcs",
"url": "git@git.auroracreation.com:aurora-modules/aurora-contact.git"
}
...
],
```
2. Add package to composer.json:
```text
"require": {
...
"aurora/contact-form": "*"
...
},
```
3. In Magento root folder run commands:
```text
composer update aurora/contact-form
php bin/magento module:enable Aurora_Contact
php bin/magento setup:upgrade
```
### Manual
1. Unzip archive.
2. Upload extension files on your server to:
```text
{Magento root}
└── app/
└── code
```
3. In Magento root folder run commands:
```text
php bin/magento module:enable Aurora_Contact
php bin/magento setup:upgrade
```
### Thank you for your interest in our products!
## ChangeLog
### v1.1.19
- Update gitlab ci
- Fix ReCaptcha validation
- Fix validation in js
- PSR improvement
### v1.1.18
- Improved controllers
- Added translated name of Add Field/Edit Field button
- PSR improvement
- Improved error information
- Improved the logic of sending a contact inquiry
- Improved validation of sent data
### v1.1.17
- Fix DataProvider
### v1.1.16
- Field creation/editing controller improved
- Fix DataProvider
### v1.1.15
- Improved contact form field list - removing uicomponent context
### v1.1.14
- Fixed a bug with displaying form fields
### v1.1.13
- Improved contact form field list - using uicomponent context
### v1.1.13
- Fix validation of non-required fields
### v1.1.12
- Downgrading Magento required version
### v1.1.11
- Fix validation of non-required fields
### v1.1.10
- Update enabling operation on Magento 2.4
- PSR improvement
- Added TypeHint
- Added strict_types
- Correction of copyrights
### v1.1.9
- Added option: contact page title and description configurable for each store view
### v1.1.8
- Correction of copyright
- Added option: Placing information about the privacy policy in the contact form
- Added option: Consent to data processing as select
- Added option: Content of information about consent to data processing
- Added information about required fields
- Added translations
### v1.1.7
- Correction of copyright in readme
### v1.1.6
- Fixed column types in db_schema
### v1.1.5
- Changing the way of creating a table in the database - using db_schema
### v1.1.4
- PSR improvement
### v1.1.3
- PSR improvement
- Improved the display of the contact form
- Added serializer interface
- Improved UnitTests
### v1.1.2
- Improved UnitTest
- PSR improvement
### v1.1.1
- Correction of copyright
### v1.0.5
- Update enabling operation on Magento 2.3
### v1.0.4
- Added display of error information
### v1.0.3
- Fields form refactoring